Unofficial Pixi-API-Documentation

by koempf24.de

pixiDeleteItemSupplier

Pixi-Docs
Old Pixi-Docs

API call deletes an item property record connected to a specific supplier.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: Removing of such a record is only possible when there are no open supplier orders for this item. To identify the item itself one of paramters @ItemKey, @ItemNrInt needs to be provided.

Items Stock

Request

POST https://apigateway.descartes.com/tms/pixi/pixiDeleteItemSupplier

Request body

Name Type Required Description
EAN string false

Filter: Item barcode.

Type: varchar(13)

Default value: NULL

Example: 0123456789abc

Available from: AVA 17.07 (8.4.31.30601)
ItemKey integer false

Filter: pixi* item ID.

Type: int

Default value: NULL

Example: 1234

Available from: LOU Official (6.3.0.4452)
SupplNr string true

Filter: Supplier number.

Type: varchar(4)

Default value:

Example: SNum

Available from: LOU Official (6.3.0.4452)
ItemNrInt string false

Filter: Shop item number.

Type: varchar(50)

Default value: NULL

Example: abc123

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiDeleteItemSupplier>
      <ItemKey>0</ItemKey>
      <ItemNrInt>string</ItemNrInt>
      <SupplNr>string</SupplNr>
      <EAN>string</EAN>
    </pixiDeleteItemSupplier>
  </Body>
</Envelope>

Response

1. Success response.

Name Type Description
Status string

Status of the success response. (normaly: "Success")

Type: varchar

Available from: 25.06 (25.6.0.58802)
Message string

Details of the deleted record.

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiDeleteItemSupplierPost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiDeleteItemSupplierPost200TextXmlResponse>

2. Error response.

Name Type Description
Status string

Status of the error response. (normaly: "Error")

Type: varchar

Available from: 25.06 (25.6.0.58802)
Message string

Error description.

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiDeleteItemSupplierPost400TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiDeleteItemSupplierPost400TextXmlResponse>

HTTP Example

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:pixiDeleteItemSupplier>
            <EAN xsi:type="xsd:string">0123456789abc</EAN>
            <ItemKey xsi:type="xsd:integer">1234</ItemKey>
            <SupplNr xsi:type="xsd:string">SNum</SupplNr> <!-- required -->
            <ItemNrInt xsi:type="xsd:string">abc123</ItemNrInt>
        </ns1:pixiDeleteItemSupplier>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiDeleteItemSupplier', [
    'EAN' => '0123456789abc', // string
    'ItemKey' => '1234', // integer
    'SupplNr' => 'SNum', // string (required)
    'ItemNrInt' => 'abc123', // string
]);

function getPixiSoapClientResponse(string $method, array $arguments = [])
{
    $soapArguments = [];
    foreach ($arguments as $key => $value) {
        $soapArguments[] = new SoapVar($value, null, '', '', $key);
    }

    $soapClient = new SoapClient(null, [
        'login' => '...',
        'password' => '...',
        'uri' => 'https://apigateway.descartes.com/tms/pixi/',
        'location' => 'https://apigateway.descartes.com/tms/pixi/',
    ]);

    return $soapClient->__call($method, $soapArguments);
}