Unofficial Pixi-API-Documentation

by koempf24.de

pixiSupplierOrderDelete

Pixi-Docs
Old Pixi-Docs

Recommended

Delete one or more Supplier Orders.

Since pixi version: AVA Official - Update 7 (8.4.7.23158) Additional notes:

Suppliers

Request

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

Request body

Name Type Required Description
AppName string false

Name of application which executes API call.

Type: varchar(255)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderId integer false

Id of one Supplier Order to be deleted.

Type: int

Default value:

Example: @SupplierOrderId = 13

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderNr integer false

Supplier/purchase order number of one supplier/purchase order to be deleted.

Type: int

Default value:

Example: @SupplierOrderId = 13

Available from: 19.02 (8.4.50.37001)
SupplierOrderIds string false

Ids of more Supplier Orders (comma separated values).

Type: varchar(8000)

Default value:

Example: @SupplierOrderIds = (13,25)

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderNrs string false

Supplier/purchase order numbers of more Supplier Orders (comma separated values).

Type: varchar(8000)

Default value:

Example: @SupplierOrderIds = (13,25)

Available from: 19.02 (8.4.50.37001)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSupplierOrderDelete>
      <AppName>string</AppName>
      <SupplierOrderId>0</SupplierOrderId>
      <SupplierOrderIds>string</SupplierOrderIds>
      <SupplierOrderNr>0</SupplierOrderNr>
      <SupplierOrderNrs>string</SupplierOrderNrs>
    </pixiSupplierOrderDelete>
  </Body>
</Envelope>

Response

1. Result Set.

Name Type Description
ReturnCode string

Return code. (SUCCESS, ERROR, WARNING)

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)
ErrorMessage string

Description of the error.

Type: varchar (300)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSupplierOrderDeletePost400TextXmlResponse>
  <ReturnCode>string</ReturnCode>
  <ErrorMessage>string</ErrorMessage>
</PixiSupplierOrderDeletePost400TextXmlResponse>

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:pixiSupplierOrderDelete>
            <AppName xsi:type="xsd:string"></AppName>
            <SupplierOrderId xsi:type="xsd:integer">@SupplierOrderId = 13</SupplierOrderId>
            <SupplierOrderNr xsi:type="xsd:integer">@SupplierOrderId = 13</SupplierOrderNr>
            <SupplierOrderIds xsi:type="xsd:string">@SupplierOrderIds = (13,25)</SupplierOrderIds>
            <SupplierOrderNrs xsi:type="xsd:string">@SupplierOrderIds = (13,25)</SupplierOrderNrs>
        </ns1:pixiSupplierOrderDelete>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSupplierOrderDelete', [
    'AppName' => '', // string
    'SupplierOrderId' => '@SupplierOrderId = 13', // integer
    'SupplierOrderNr' => '@SupplierOrderId = 13', // integer
    'SupplierOrderIds' => '@SupplierOrderIds = (13,25)', // string
    'SupplierOrderNrs' => '@SupplierOrderIds = (13,25)', // 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);
}