pixiGetDelivery
API Call to return
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: API call to return delivery documents.
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
LocID | string | false | Filter: Location id Type: varchar(3) Default value: NULL Example: 001 Available from: LOU Official - Update 46 (6.9.46.27927) |
Closed | boolean | false | Filter: Return only documents on closed status. Type: bit Default value: 0 Example: 1 Available from: LOU Official - Update 46 (6.9.46.27927) |
EANUPC | string | false | Filter: Barcode Type: varchar(200) Default value: NULL Example: abc Available from: LOU Official - Update 46 (6.9.46.27927) |
Offset | integer | false | Offset for delivery header id Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
Invoice | boolean | false | Filter: Return only documents on invoice status Type: bit Default value: 0 Example: 1 Available from: LOU Official - Update 46 (6.9.46.27927) |
SupplNr | string | false | Filter: Supplier number Type: varchar(200) Default value: NULL Example: abc Available from: LOU Official - Update 46 (6.9.46.27927) |
ItemName | string | false | Filter: Item name Type: varchar(200) Default value: NULL Example: abc Available from: LOU Official - Update 46 (6.9.46.27927) |
RowCount | integer | false | Maximim number of rows Type: int Default value: 100 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
SDelHKey | integer | false | Filter: Delivery header id Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
ItemNrInt | string | false | Filter: Internal item number Type: varchar(200) Default value: NULL Example: abc Available from: LOU Official - Update 46 (6.9.46.27927) |
PiccoUser | string | false | Filter: Picco user Type: varchar(50) Default value: NULL Example: abc Available from: LOU Official - Update 46 (6.9.46.27927) |
ItemNrSuppl | string | false | Filter: Supplier item number Type: varchar(200) Default value: NULL Example: abc Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateTo | string | false | Filter: Create date of Delivery (to) Type: datetime Default value: NULL Example: 20190515 Available from: 19.09 (9.0.7.42222) |
UpdateDateTo | string | false | Filter: Update date of Delivery (to) Type: datetime Default value: NULL Example: 20190515 Available from: 19.09 (9.0.7.42222) |
CreateDateFrom | string | false | Filter: Create date of Delivery (from) Type: datetime Default value: NULL Example: 20190505 Available from: 19.09 (9.0.7.42222) |
DeliveryNumber | integer | false | Filter: Delivery number Type: int Default value: NULL Example: abc Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateFrom | string | false | Filter: Update date of Delivery (from) Type: datetime Default value: NULL Example: 20190505 Available from: 19.09 (9.0.7.42222) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetDelivery>
<SDelHKey>0</SDelHKey>
<SupplNr>string</SupplNr>
<DeliveryNumber>0</DeliveryNumber>
<ItemNrInt>string</ItemNrInt>
<ItemNrSuppl>string</ItemNrSuppl>
<EANUPC>string</EANUPC>
<ItemName>string</ItemName>
<RowCount>0</RowCount>
<Offset>0</Offset>
<Closed>true</Closed>
<Invoice>true</Invoice>
<LocID>string</LocID>
<PiccoUser>string</PiccoUser>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
</pixiGetDelivery>
</Body>
</Envelope>
Response
1. Result
Name | Type | Description |
---|---|---|
SDelHNr | integer | Delivery number Type: int Available from: 25.06 (25.6.0.58802) |
SDelHKey | integer | Delivery header ID Type: int Available from: 25.06 (25.6.0.58802) |
PiccoUser | string | Picco user Type: varchar (59) Available from: 25.06 (25.6.0.58802) |
SDelHDate | string | Delivery date Type: datetime Available from: 25.06 (25.6.0.58802) |
SDelHNote | string | Note Type: varchar (8000) Available from: 25.06 (25.6.0.58802) |
SupplName | string | Supplier name Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
SDelHStatus | string | Status Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
SDelHSupplNr | string | Supplier number Type: varchar (4) Available from: 25.06 (25.6.0.58802) |
LockedByPicco | string | Is locked by picco user Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
SDelHCreateEmp | string | Created by user Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
SDelHUpdateEmp | string | Updated by user Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
SDelHCreateDate | string | Date of creation Type: datetime Available from: 25.06 (25.6.0.58802) |
SDelHLocationID | string | Location Id Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
SDelHUpdateDate | string | Date od update Type: datetime Available from: 25.06 (25.6.0.58802) |
SDelHextOrderNr | string | External order number Type: varchar (1000) Available from: 25.06 (25.6.0.58802) |
SDelHextInvoiceNr | string | External invoice number Type: varchar (25) Available from: 25.06 (25.6.0.58802) |
SDelHfinalDicsount | number | Final discount Type: money Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetDeliveryPost200TextXmlResponse>
<SDelHKey>0</SDelHKey>
<SDelHSupplNr>string</SDelHSupplNr>
<SDelHDate>string</SDelHDate>
<SDelHLocationID>string</SDelHLocationID>
<SDelHNr>0</SDelHNr>
<SDelHNote>string</SDelHNote>
<SDelHStatus>string</SDelHStatus>
<SDelHCreateDate>string</SDelHCreateDate>
<SDelHCreateEmp>string</SDelHCreateEmp>
<SDelHUpdateDate>string</SDelHUpdateDate>
<SDelHUpdateEmp>string</SDelHUpdateEmp>
<SDelHextInvoiceNr>string</SDelHextInvoiceNr>
<SDelHextOrderNr>string</SDelHextOrderNr>
<SDelHfinalDicsount>0</SDelHfinalDicsount>
<PiccoUser>string</PiccoUser>
<LockedByPicco>string</LockedByPicco>
<SupplName>string</SupplName>
</PixiGetDeliveryPost200TextXmlResponse>
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:pixiGetDelivery>
<LocID xsi:type="xsd:string">001</LocID>
<Closed xsi:type="xsd:boolean">1</Closed>
<EANUPC xsi:type="xsd:string">abc</EANUPC>
<Offset xsi:type="xsd:integer">123</Offset>
<Invoice xsi:type="xsd:boolean">1</Invoice>
<SupplNr xsi:type="xsd:string">abc</SupplNr>
<ItemName xsi:type="xsd:string">abc</ItemName>
<RowCount xsi:type="xsd:integer">123</RowCount>
<SDelHKey xsi:type="xsd:integer">123</SDelHKey>
<ItemNrInt xsi:type="xsd:string">abc</ItemNrInt>
<PiccoUser xsi:type="xsd:string">abc</PiccoUser>
<ItemNrSuppl xsi:type="xsd:string">abc</ItemNrSuppl>
<CreateDateTo xsi:type="xsd:string">20190515</CreateDateTo>
<UpdateDateTo xsi:type="xsd:string">20190515</UpdateDateTo>
<CreateDateFrom xsi:type="xsd:string">20190505</CreateDateFrom>
<DeliveryNumber xsi:type="xsd:integer">abc</DeliveryNumber>
<UpdateDateFrom xsi:type="xsd:string">20190505</UpdateDateFrom>
</ns1:pixiGetDelivery>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetDelivery', [
'LocID' => '001', // string
'Closed' => '1', // boolean
'EANUPC' => 'abc', // string
'Offset' => '123', // integer
'Invoice' => '1', // boolean
'SupplNr' => 'abc', // string
'ItemName' => 'abc', // string
'RowCount' => '123', // integer
'SDelHKey' => '123', // integer
'ItemNrInt' => 'abc', // string
'PiccoUser' => 'abc', // string
'ItemNrSuppl' => 'abc', // string
'CreateDateTo' => '20190515', // string
'UpdateDateTo' => '20190515', // string
'CreateDateFrom' => '20190505', // string
'DeliveryNumber' => 'abc', // integer
'UpdateDateFrom' => '20190505', // 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);
}