pixiGetSupplierOrder
API call retrieves purchase orders with purchase orderlines.
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: NEW|NEU: NEW is the initial status of a purchase order after its creation. BES|ORD: Purchase order status Ordered (BES) is used when you send the purchase orders to the supplier. In this status, you can still add, update or remove items. CON|BGT: Once the purchase order status is set to Confirmed (CON) by the supplier you cannot change add, update or remove items. CLS|ABG: Purchase order status Closed (CLS) is used when the goods receipt for this purchase order was done and all items were delivered or marked as not delivered. Status parameter must include only one of this statuses: NEW, BES, CON, CLS. Datetime parameters will only include the date. Hours, minutes and seconds are ignored.
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
Start | integer | false | Start at row Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
DateTo | string | false | Date range end Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss 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, CLS, Available from: LOU Official - Update 46 (6.9.46.27927) |
SupplNr | string | false | Supplier number (code) Type: varchar(4) Default value: NULL Example: MGS Available from: LOU Official - Update 46 (6.9.46.27927) |
DateFrom | string | false | Shows all Orderlines from that given Date on Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
RowCount | integer | false | Define how many rows you want to get back max Type: int Default value: 1000 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
SupplOrderNr | integer | false | Purchase order internal number 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="">
<pixiGetSupplierOrder>
<SupplNr>string</SupplNr>
<SupplOrderNr>0</SupplOrderNr>
<DateFrom>string</DateFrom>
<DateTo>string</DateTo>
<Status>string</Status>
<RowCount>0</RowCount>
<Start>0</Start>
</pixiGetSupplierOrder>
</Body>
</Envelope>
Response
1. Purchase order result
Name | Type | Description |
---|---|---|
VPE | integer | Package unit Type: int Available from: 25.06 (25.6.0.58802) |
Note | string | Special note Type: varchar Available from: 25.06 (25.6.0.58802) |
RowNr | string | Start row number Type: bigint Available from: 25.06 (25.6.0.58802) |
EANUPC | string | Item barcode(EAN) Type: varchar Available from: 25.06 (25.6.0.58802) |
Status | string | Purchase order status Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemKey | integer | Item ID Type: int Available from: 25.06 (25.6.0.58802) |
SupplNr | string | Supplier number (code) Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemName | string | Item name Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderQty | integer | Ordered quantity Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Order create date Type: datetime Available from: 25.06 (25.6.0.58802) |
ExtOrderNr | string | External Order Number Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderedQty | integer | Ordered quantity Type: int Available from: 25.06 (25.6.0.58802) |
SupplPrice | number | Supplier price of the item Type: money Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number Type: varchar Available from: 25.06 (25.6.0.58802) |
DeliveredQty | integer | Delivered quantity Type: int Available from: 25.06 (25.6.0.58802) |
UndeliveredQty | integer | Not delivered quantity Type: int Available from: 25.06 (25.6.0.58802) |
SupplierOrderId | integer | Supplier Order Id Type: int Available from: 25.06 (25.6.0.58802) |
SupplierOrderNR | integer | Purchase order internal number Type: int Available from: 25.06 (25.6.0.58802) |
DeliveryLocation | string | Delivery Location Id Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemCodeInternal | string | Internal item Number Type: varchar Available from: 25.06 (25.6.0.58802) |
EstimatedDelivery | string | Estimated delivery date Type: datetime Available from: 25.06 (25.6.0.58802) |
SupplierOrderType | string | Purchase order type (1= Purchase Order, 2=Pre-Order) Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplierOrderlineId | integer | Supplier Orderline Id Type: int Available from: 25.06 (25.6.0.58802) |
SupplierOrderlineKey | integer | Purchase orderline key Type: int Available from: 25.06 (25.6.0.58802) |
SupplierOrderCreateDate | string | Record create Purchase Order date Type: datetime Available from: 25.06 (25.6.0.58802) |
SupplierOrderCreateUser | string | User who created Purchase Order Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplierOrderNRExternal | string | External order number Type: nvarchar Available from: 25.06 (25.6.0.58802) |
SupplierOrderUpdateDate | string | Purchase order update date Type: datetime Available from: 25.06 (25.6.0.58802) |
SupplierOrderUpdateUser | string | Username of the last user that updated purchase order Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplierOrderLineUpateUser | string | Username of the last user that updated purchase orderline Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplierOrderlineUpdateDate | string | Purchase orderline update date Type: datetime Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetSupplierOrderPost200TextXmlResponse>
<RowNr>string</RowNr>
<SupplierOrderlineKey>0</SupplierOrderlineKey>
<SupplierOrderNR>0</SupplierOrderNR>
<SupplierOrderNRExternal>string</SupplierOrderNRExternal>
<OrderDate>string</OrderDate>
<SupplNr>string</SupplNr>
<Status>string</Status>
<EstimatedDelivery>string</EstimatedDelivery>
<Note>string</Note>
<EANUPC>string</EANUPC>
<ItemNrSuppl>string</ItemNrSuppl>
<OrderQty>0</OrderQty>
<VPE>0</VPE>
<ItemName>string</ItemName>
<SupplierOrderUpdateDate>string</SupplierOrderUpdateDate>
<SupplierOrderUpdateUser>string</SupplierOrderUpdateUser>
<SupplierOrderlineUpdateDate>string</SupplierOrderlineUpdateDate>
<SupplierOrderLineUpateUser>string</SupplierOrderLineUpateUser>
<ItemKey>0</ItemKey>
<SupplPrice>0</SupplPrice>
<OrderedQty>0</OrderedQty>
<UndeliveredQty>0</UndeliveredQty>
<DeliveredQty>0</DeliveredQty>
<SupplierOrderType>string</SupplierOrderType>
<ItemNrInt>string</ItemNrInt>
<ItemCodeInternal>string</ItemCodeInternal>
<DeliveryLocation>string</DeliveryLocation>
<ExtOrderNr>string</ExtOrderNr>
<SupplierOrderId>0</SupplierOrderId>
<SupplierOrderlineId>0</SupplierOrderlineId>
<SupplierOrderCreateDate>string</SupplierOrderCreateDate>
<SupplierOrderCreateUser>string</SupplierOrderCreateUser>
</PixiGetSupplierOrderPost200TextXmlResponse>
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:pixiGetSupplierOrder>
<Start xsi:type="xsd:integer">123</Start>
<DateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateTo>
<Status xsi:type="xsd:string">NEW, BES, CON, CLS,</Status>
<SupplNr xsi:type="xsd:string">MGS</SupplNr>
<DateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateFrom>
<RowCount xsi:type="xsd:integer">123</RowCount>
<SupplOrderNr xsi:type="xsd:integer">123</SupplOrderNr>
</ns1:pixiGetSupplierOrder>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetSupplierOrder', [
'Start' => '123', // integer
'DateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'Status' => 'NEW, BES, CON, CLS,', // string
'SupplNr' => 'MGS', // string
'DateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
'RowCount' => '123', // integer
'SupplOrderNr' => '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);
}