pixiGetSOrders
API which retrieves supplier orders with corresponding suppliers. Pixi_GetSOrders drop because API call replaced this procedure.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
RLimit | integer | false | Number of returned records. Type: int Default value: 0 Example: Available from: LOU Official (6.3.0.4452) |
ShowCls | boolean | false | Filter: Display supplier orders on status CLS. Type: bit Default value: 1 Example: Available from: LOU Official (6.3.0.4452) |
ShowCon | boolean | false | Filter: Display supplier orders on status CON. Type: bit Default value: 1 Example: Available from: LOU Official (6.3.0.4452) |
ShowNew | boolean | false | Filter: Display supplier orders on status NEW. Type: bit Default value: 1 Example: Available from: LOU Official (6.3.0.4452) |
ShowOrd | boolean | false | Filter: Display supplier orders on status BES. Type: bit Default value: 1 Example: Available from: LOU Official (6.3.0.4452) |
LocationID | string | false | Location on which you search for supplier orders. Type: varchar(3) Default value: 001 Example: Available from: LOU Official (6.3.0.4452) |
ShowNoDate | boolean | false | Decide whether to return SOrders with no estimated delivery date set. Only orders that are/were already ordered are considered. Type: bit Default value: 0 Example: Available from: AVA Official - Update 7 (8.4.7.23158) |
ExtOrderNrs | string | false | Filter list of External order numbers in XML format. Type: varchar(-1) Default value: NULL Example: <ExtOrders>
Available from: AVA 17.04 (8.4.28.29614) |
ShowDueDate | boolean | false | Decide whether to return overdue SOrders. Only orders that are/were already ordered are considered. Type: bit Default value: 0 Example: Available from: LOU Official (6.3.0.4452) |
StatusChangeDateTo | string | false | Filter result to supplier orders where status change timestamp is after the parameter value. Type: datetime Default value: NULL Example: 2017-01-31 23:23:59.996 Available from: AVA 17.04 (8.4.28.29614) |
StatusChangeDateFrom | string | false | Filter result to supplier orders where status change timestamp is before the parameter value. Type: datetime Default value: NULL Example: 2017-01-01 00:00:00.000 Available from: AVA 17.04 (8.4.28.29614) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetSOrders>
<LocationID>string</LocationID>
<RLimit>0</RLimit>
<ShowNew>true</ShowNew>
<ShowOrd>true</ShowOrd>
<ShowCon>true</ShowCon>
<ShowCls>true</ShowCls>
<ShowDueDate>true</ShowDueDate>
<ShowNoDate>true</ShowNoDate>
<StatusChangeDateFrom>string</StatusChangeDateFrom>
<StatusChangeDateTo>string</StatusChangeDateTo>
<ExtOrderNrs>string</ExtOrderNrs>
</pixiGetSOrders>
</Body>
</Envelope>
Response
1. Supplier orders
Name | Type | Description |
---|---|---|
Status | string | Supplier order status Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | Order number in pixi* 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) |
XMLsent | boolean | Indicator that XML was sent Type: bit Available from: 25.06 (25.6.0.58802) |
CreateEmp | string | Creator of the record (pixi* user) Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Supplier order date Type: datetime Available from: 25.06 (25.6.0.58802) |
SOrderKey | integer | Supplier order ID Type: int Available from: 25.06 (25.6.0.58802) |
SupplName | string | Supplier name Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateEmp | string | User who last updated the record Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDate | string | Create date Type: datetime Available from: 25.06 (25.6.0.58802) |
ExtOrderNr | string | External supplier order number Type: nvarchar Available from: 25.06 (25.6.0.58802) |
SupplGroup | string | Supplier group Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | Last update date of the record Type: datetime Available from: 25.06 (25.6.0.58802) |
SOrdersNote | string | Supplier order note Type: varchar Available from: 25.06 (25.6.0.58802) |
GoodsReceipts | string | List of SDelHNr (Supplier Delivery Header Nr) separated by semicolon. Type: varchar Available from: 25.06 (25.6.0.58802) |
RecordBatchNr | integer | Always "NULL" Type: int Available from: 25.06 (25.6.0.58802) |
SOrderLocation | string | Location of supplier order Type: varchar Available from: 25.06 (25.6.0.58802) |
PixiOrderCreated | boolean | Always "NULL" Type: bit Available from: 25.06 (25.6.0.58802) |
SupplierFulfillment | boolean | Indicator of direct fulfillment order Type: bit Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetSOrdersPost200TextXmlResponse>
<OrderNr>0</OrderNr>
<SupplNr>string</SupplNr>
<SupplGroup>string</SupplGroup>
<OrderDate>string</OrderDate>
<Status>string</Status>
<CreateDate>string</CreateDate>
<CreateEmp>string</CreateEmp>
<UpdateDate>string</UpdateDate>
<UpdateEmp>string</UpdateEmp>
<SOrderLocation>string</SOrderLocation>
<RecordBatchNr>0</RecordBatchNr>
<SOrderKey>0</SOrderKey>
<ExtOrderNr>string</ExtOrderNr>
<XMLsent>true</XMLsent>
<SupplierFulfillment>true</SupplierFulfillment>
<SOrdersNote>string</SOrdersNote>
<SupplName>string</SupplName>
<PixiOrderCreated>true</PixiOrderCreated>
<GoodsReceipts>string</GoodsReceipts>
</PixiGetSOrdersPost200TextXmlResponse>
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:pixiGetSOrders>
<RLimit xsi:type="xsd:integer"></RLimit>
<ShowCls xsi:type="xsd:boolean"></ShowCls>
<ShowCon xsi:type="xsd:boolean"></ShowCon>
<ShowNew xsi:type="xsd:boolean"></ShowNew>
<ShowOrd xsi:type="xsd:boolean"></ShowOrd>
<LocationID xsi:type="xsd:string"></LocationID>
<ShowNoDate xsi:type="xsd:boolean"></ShowNoDate>
<ExtOrderNrs xsi:type="xsd:string"><ExtOrders></ExtOrderNrs>
<ShowDueDate xsi:type="xsd:boolean"></ShowDueDate>
<StatusChangeDateTo xsi:type="xsd:string">2017-01-31 23:23:59.996</StatusChangeDateTo>
<StatusChangeDateFrom xsi:type="xsd:string">2017-01-01 00:00:00.000</StatusChangeDateFrom>
</ns1:pixiGetSOrders>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetSOrders', [
'RLimit' => '', // integer
'ShowCls' => '', // boolean
'ShowCon' => '', // boolean
'ShowNew' => '', // boolean
'ShowOrd' => '', // boolean
'LocationID' => '', // string
'ShowNoDate' => '', // boolean
'ExtOrderNrs' => '<ExtOrders>', // string
'ShowDueDate' => '', // boolean
'StatusChangeDateTo' => '2017-01-31 23:23:59.996', // string
'StatusChangeDateFrom' => '2017-01-01 00:00:00.000', // 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);
}