pixiFindOrderlineForBox
API returns most appropriate orderline from picklist for scanned-in item
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: The API call can only be used when "Premium API" setting is enabled.
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
Box | integer | false | Box number Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
Qty | integer | false | Item quantity Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
EANUPC | string | true | Item barcode Type: varchar(50) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderNr | string | false | pixi* order number Type: varchar(50) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
UsedBoxes | integer | false | Number of used boxes Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
LocationID | string | true | Location ID Type: varchar(3) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
PickListNr | integer | false | Picklist number Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
ExpressBoxes | integer | false | Number of express boxes Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderlineKey | integer | false | Orderline ID Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
SupplOrderNr | integer | false | Supplier order number Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
1SSnoPLscanIn | boolean | false | Use one scan shipping functionality Type: bit Default value: 0 Example: 0 or 1 Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiFindOrderlineForBox>
<EANUPC>string</EANUPC>
<LocationID>string</LocationID>
<Box>0</Box>
<Qty>0</Qty>
<SupplOrderNr>0</SupplOrderNr>
<UsedBoxes>0</UsedBoxes>
<ExpressBoxes>0</ExpressBoxes>
<PickListNr>0</PickListNr>
<OrderNr>string</OrderNr>
<_x0031_SSnoPLscanIn>true</_x0031_SSnoPLscanIn>
<OrderlineKey>0</OrderlineKey>
</pixiFindOrderlineForBox>
</Body>
</Envelope>
Response
1. Orderline details
Name | Type | Description |
---|---|---|
Qty | integer | Orderline item quantity Type: int Available from: 25.06 (25.6.0.58802) |
ArtNr | string | Item barcode Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
PLqty | integer | Item quantity on the picklist Type: int Available from: 25.06 (25.6.0.58802) |
Status | string | Orderline status Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
AddrRef | integer | Billing adddress ID Type: int Available from: 25.06 (25.6.0.58802) |
ArtName | string | Name of the item. Type: varchar (120) Available from: 25.06 (25.6.0.58802) |
ItemRef | integer | Item ID Type: int Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | Order number in pixi* Type: int Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Order date imported from the shop Type: datetime Available from: 25.06 (25.6.0.58802) |
LocationID | string | Order location code Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
OutsideQty | integer | Indicator that the quantity provided with parameters is higher than the one on the orderline Type: int Available from: 25.06 (25.6.0.58802) |
ShipAdrRef | integer | Shipping address ID Type: int Available from: 25.06 (25.6.0.58802) |
OrderlineKey | integer | ID for the Orderline record Type: int Available from: 25.06 (25.6.0.58802) |
LastOrdLocationID | string | Last order location code Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
IsPersonalizedScanIn | boolean | Indicates that the orderline item is a personalized item Type: bit Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiFindOrderlineForBoxPost200TextXmlResponse>
<Status>string</Status>
<OrderlineKey>0</OrderlineKey>
<ArtNr>string</ArtNr>
<ArtName>string</ArtName>
<Qty>0</Qty>
<OrderNr>0</OrderNr>
<AddrRef>0</AddrRef>
<ShipAdrRef>0</ShipAdrRef>
<LocationID>string</LocationID>
<LastOrdLocationID>string</LastOrdLocationID>
<OrderDate>string</OrderDate>
<ItemRef>0</ItemRef>
<OutsideQty>0</OutsideQty>
<IsPersonalizedScanIn>true</IsPersonalizedScanIn>
<PLqty>0</PLqty>
</PixiFindOrderlineForBoxPost200TextXmlResponse>
2. Status output
Name | Type | Description |
---|---|---|
Status | string | Execution status (OK/ERROR) Type: varchar (20) Available from: 25.06 (25.6.0.58802) |
StatusMessage | string | Description of the status Type: varchar (200) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiFindOrderlineForBoxPost200TextXmlResponse>
<Status>string</Status>
<OrderlineKey>0</OrderlineKey>
<ArtNr>string</ArtNr>
<ArtName>string</ArtName>
<Qty>0</Qty>
<OrderNr>0</OrderNr>
<AddrRef>0</AddrRef>
<ShipAdrRef>0</ShipAdrRef>
<LocationID>string</LocationID>
<LastOrdLocationID>string</LastOrdLocationID>
<OrderDate>string</OrderDate>
<ItemRef>0</ItemRef>
<OutsideQty>0</OutsideQty>
<IsPersonalizedScanIn>true</IsPersonalizedScanIn>
<PLqty>0</PLqty>
</PixiFindOrderlineForBoxPost200TextXmlResponse>
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:pixiFindOrderlineForBox>
<Box xsi:type="xsd:integer">123</Box>
<Qty xsi:type="xsd:integer">123</Qty>
<EANUPC xsi:type="xsd:string">abcdefg</EANUPC> <!-- required -->
<OrderNr xsi:type="xsd:string">abcdefg</OrderNr>
<UsedBoxes xsi:type="xsd:integer">123</UsedBoxes>
<LocationID xsi:type="xsd:string">abcdefg</LocationID> <!-- required -->
<PickListNr xsi:type="xsd:integer">123</PickListNr>
<ExpressBoxes xsi:type="xsd:integer">123</ExpressBoxes>
<OrderlineKey xsi:type="xsd:integer">123</OrderlineKey>
<SupplOrderNr xsi:type="xsd:integer">123</SupplOrderNr>
<1SSnoPLscanIn xsi:type="xsd:boolean">0 or 1</1SSnoPLscanIn>
</ns1:pixiFindOrderlineForBox>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiFindOrderlineForBox', [
'Box' => '123', // integer
'Qty' => '123', // integer
'EANUPC' => 'abcdefg', // string (required)
'OrderNr' => 'abcdefg', // string
'UsedBoxes' => '123', // integer
'LocationID' => 'abcdefg', // string (required)
'PickListNr' => '123', // integer
'ExpressBoxes' => '123', // integer
'OrderlineKey' => '123', // integer
'SupplOrderNr' => '123', // integer
'1SSnoPLscanIn' => '0 or 1', // boolean
]);
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);
}