Unofficial Pixi-API-Documentation

by koempf24.de

pixiCancelOrderline

Pixi-Docs
Old Pixi-Docs

API call cancels or sets to not available one single orderline or bundle with reletaed items on it, when status is not in Final State, item in box or already on invoice line.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: The Api call will exit with return value 0 when it was successfull. And with return value 1 in case of error.

General

Request

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

Request body

Name Type Required Description
Status string false

Orderline status

Type: varchar(3)

Default value: STO

Example: NLB

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderlineKey integer false

Orderline ID

Type: int

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)
BundleOrderlineKey integer false

BundleOrderline ID from OrderLines table, if set then change will be done only on given Bundle and items in the bundle

Type: int

Default value: NULL

Example: 123

Available from: 22.05 (22.5.0.27301)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCancelOrderline>
      <OrderlineKey>0</OrderlineKey>
      <Status>string</Status>
      <BundleOrderlineKey>0</BundleOrderlineKey>
    </pixiCancelOrderline>
  </Body>
</Envelope>

Response

1. Result

Name Type Description
SuccessfulMessage string

Success message

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCancelOrderlinePost200TextXmlResponse>
  <SuccessfulMessage>string</SuccessfulMessage>
</PixiCancelOrderlinePost200TextXmlResponse>

2. Result

Name Type Description
ErrorMessage string

Error message

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCancelOrderlinePost200TextXmlResponse>
  <SuccessfulMessage>string</SuccessfulMessage>
</PixiCancelOrderlinePost200TextXmlResponse>

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:pixiCancelOrderline>
            <Status xsi:type="xsd:string">NLB</Status>
            <OrderlineKey xsi:type="xsd:integer">123</OrderlineKey>
            <BundleOrderlineKey xsi:type="xsd:integer">123</BundleOrderlineKey>
        </ns1:pixiCancelOrderline>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCancelOrderline', [
    'Status' => 'NLB', // string
    'OrderlineKey' => '123', // integer
    'BundleOrderlineKey' => '123', // integer
]);

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);
}