Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetFulfillmentOptions

Pixi-Docs
Old Pixi-Docs

API call updates the direct fulfillment option

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Direct-Fulfillment

Request

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

Request body

Name Type Required Description
DF_Type integer false

Direct Fulfillment option

Type: int

Default value: NULL

Example: 2

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

pixi* order number

Type: int

Default value: NULL

Example: 123

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

pixi* orderline ID

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetFulfillmentOptions>
      <OrderlineKey>0</OrderlineKey>
      <OrderNr>0</OrderNr>
      <DF_Type>0</DF_Type>
    </pixiSetFulfillmentOptions>
  </Body>
</Envelope>

Response

1. Orderline data

Name Type Description
Status string

Orderline status

Type: varchar (3)

Available from: / (25.7.0.59144)
DF_type string

Direct Fulfillment option

Type: varchar (1)

Available from: / (25.7.0.59144)
OrderNr integer

Order number in pixi*

Type: int

Available from: / (25.7.0.59144)
IsEditable boolean

Indicator if the orderline is actually editable

Type: bit

Available from: / (25.7.0.59144)
OrderlineKey integer

ID for the Orderline record

Type: int

Available from: / (25.7.0.59144)

Response Example

<PixiSetFulfillmentOptionsPost200TextXmlResponse>
  <OrderNr>0</OrderNr>
  <OrderlineKey>0</OrderlineKey>
  <Status>string</Status>
  <DF_type>string</DF_type>
  <IsEditable>true</IsEditable>
</PixiSetFulfillmentOptionsPost200TextXmlResponse>

2. Error message

Name Type Description
ErrorNr string

Error number

Type: varchar(3)

Available from: / (25.7.0.59144)
ErrorMessage string

Error message

Type: varchar(1024)

Available from: / (25.7.0.59144)

Response Example

<PixiSetFulfillmentOptionsPost400TextXmlResponse>
  <ErrorNr>string</ErrorNr>
  <ErrorMessage>string</ErrorMessage>
</PixiSetFulfillmentOptionsPost400TextXmlResponse>

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:pixiSetFulfillmentOptions>
            <DF_Type xsi:type="xsd:integer">2</DF_Type>
            <OrderNr xsi:type="xsd:integer">123</OrderNr>
            <OrderlineKey xsi:type="xsd:integer">123</OrderlineKey>
        </ns1:pixiSetFulfillmentOptions>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetFulfillmentOptions', [
    'DF_Type' => '2', // integer
    'OrderNr' => '123', // integer
    'OrderlineKey' => '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);
}