Unofficial Pixi-API-Documentation

by koempf24.de

pixiUpdateSupplierOrder

Pixi-Docs
Old Pixi-Docs

Update purchase order.

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

    With this call you can update fields:
    - Status
    - Ordered
    - Ordered by
    - Confirmed
    - Confirmed by
    - External order number
    - Note to Supplier
    - Expected delivery date
    
    Automatically update fields:
    - Modified
    - Modified by
Suppliers

Request

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

Request body

Name Type Required Description
Note string false

Adds a note to the given purchase order

Type: text

Default value: NULL

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)
Status string false

Purchase order status

Type: varchar(3)

Default value: NULL

Example: NEW, BES, CON or CLS

Available from: LOU Official - Update 46 (6.9.46.27927)
UserName string false

User name of user who execute API call.

Type: varchar(50)

Default value: API

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)
SupplierOrderNR integer true

InternalNumber of (one) purchase order.

Type: int

Default value:

Example: 70000013

Available from: LOU Official - Update 46 (6.9.46.27927)
EstimatedDeliveryDate string false

Sets the estimated delivery date for this purchase order

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official - Update 46 (6.9.46.27927)
SupplierOrderNRExtdrnal string false

External order number

Type: varchar(25)

Default value: NULL

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiUpdateSupplierOrder>
      <SupplierOrderNR>0</SupplierOrderNR>
      <Status>string</Status>
      <Note>string</Note>
      <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
      <SupplierOrderNRExtdrnal>string</SupplierOrderNRExtdrnal>
      <UserName>string</UserName>
    </pixiUpdateSupplierOrder>
  </Body>
</Envelope>

Response

1. Update status response

Name Type Description
ReturnCode string

Update status (Error/Success)

Type: varchar

Available from: 25.06 (25.6.0.58802)
ErrorMessage string

Detail status description

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiUpdateSupplierOrderPost400TextXmlResponse>
  <ReturnCode>string</ReturnCode>
  <ErrorMessage>string</ErrorMessage>
</PixiUpdateSupplierOrderPost400TextXmlResponse>

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:pixiUpdateSupplierOrder>
            <Note xsi:type="xsd:string">abcdefg</Note>
            <Status xsi:type="xsd:string">NEW, BES, CON or CLS</Status>
            <UserName xsi:type="xsd:string">abcdefg</UserName>
            <SupplierOrderNR xsi:type="xsd:integer">70000013</SupplierOrderNR> <!-- required -->
            <EstimatedDeliveryDate xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</EstimatedDeliveryDate>
            <SupplierOrderNRExtdrnal xsi:type="xsd:string">abcdefg</SupplierOrderNRExtdrnal>
        </ns1:pixiUpdateSupplierOrder>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiUpdateSupplierOrder', [
    'Note' => 'abcdefg', // string
    'Status' => 'NEW, BES, CON or CLS', // string
    'UserName' => 'abcdefg', // string
    'SupplierOrderNR' => '70000013', // integer (required)
    'EstimatedDeliveryDate' => 'YYYY-MM-DD hh:mm:ss', // string
    'SupplierOrderNRExtdrnal' => 'abcdefg', // 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);
}