pixiReadAddItems
API call to retrieve all relevant supplier data
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: Call returns flat data directly from the table
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
RowCount | integer | false | Number of maximum returned rows Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
AddItemKey | integer | false | pixi* Additem ID (starting ID + 1 used for pagination) Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateTo | string | false | Create Date to (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateTo | string | false | Update Date To (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateFrom | string | false | Create Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateFrom | string | false | Update Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateAndUpdateDateTo | string | false | Create or Update Date to (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateAndUpdateDateFrom | string | false | Create or Update Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReadAddItems>
<AddItemKey>0</AddItemKey>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadAddItems>
</Body>
</Envelope>
Response
1. Returns additional item data (Items in connection with suppliers)
Name | Type | Description |
---|---|---|
SKU | string | SKU number assigned to item Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
UPC | string | Item barcode Type: varchar (13) Available from: 25.06 (25.6.0.58802) |
Price | number | Item price Type: money Available from: 25.06 (25.6.0.58802) |
Active | boolean | Flag that marks the supplier for this item is active Type: bit Available from: 25.06 (25.6.0.58802) |
EANUPC | string | Item barcode Type: varchar (13) Available from: 25.06 (25.6.0.58802) |
ItemRef | integer | Item ID Type: int Available from: 25.06 (25.6.0.58802) |
SupplNr | string | Supplier number (code) Type: varchar (4) Available from: 25.06 (25.6.0.58802) |
MwStSatz | number | VAT Rate Type: decimal Available from: 25.06 (25.6.0.58802) |
AutoPrice | boolean | Always set to 0 when imported from shop. Type: bit Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number. Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
ItemNrOld | string | Obsolete field. Not imported from the shop. Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
AddItemKey | integer | AddItem ID Type: int Available from: 25.06 (25.6.0.58802) |
CreateDate | string | Create date Type: smalldatetime 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) |
UpdateDate | string | Last update date of the record. Type: smalldatetime Available from: 25.06 (25.6.0.58802) |
Curr_Source | string | Item price currency Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number. Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
LastImportDate | string | Time stamp when the item was last imported from the shop Type: datetime Available from: 25.06 (25.6.0.58802) |
PreferredSupplier | boolean | Flag that marks the used supplier as preferred supplier for the item. Type: bit Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReadAddItemsPost200TextXmlResponse>
<AddItemKey>0</AddItemKey>
<EANUPC>string</EANUPC>
<UPC>string</UPC>
<ItemNrSuppl>string</ItemNrSuppl>
<ItemNrInt>string</ItemNrInt>
<ItemNrOld>string</ItemNrOld>
<SupplNr>string</SupplNr>
<Price>0</Price>
<SupplPrice>0</SupplPrice>
<Curr_Source>string</Curr_Source>
<MwStSatz>0</MwStSatz>
<AutoPrice>true</AutoPrice>
<CreateDate>string</CreateDate>
<UpdateDate>string</UpdateDate>
<ItemRef>0</ItemRef>
<LastImportDate>string</LastImportDate>
<SKU>string</SKU>
<PreferredSupplier>true</PreferredSupplier>
<Active>true</Active>
</PixiReadAddItemsPost200TextXmlResponse>
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:pixiReadAddItems>
<RowCount xsi:type="xsd:integer">123</RowCount>
<AddItemKey xsi:type="xsd:integer">123</AddItemKey>
<CreateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateDateTo>
<UpdateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateTo>
<CreateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateDateFrom>
<UpdateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateFrom>
<CreateAndUpdateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateAndUpdateDateTo>
<CreateAndUpdateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateAndUpdateDateFrom>
</ns1:pixiReadAddItems>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadAddItems', [
'RowCount' => '123', // integer
'AddItemKey' => '123', // integer
'CreateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'UpdateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'CreateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
'UpdateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
'CreateAndUpdateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'CreateAndUpdateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // 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);
}