pixiReadItems
API Call to retrieve all items. For better results use API call pixiReadAddItems .
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| ItemKey | integer | false | pixi* Item Key Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
| RowCount | integer | false | number of rows returned maximum 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="">
<pixiReadItems>
<ItemKey>0</ItemKey>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadItems>
</Body>
</Envelope>
Response
1. Item information
| Name | Type | Description |
|---|---|---|
| UPC | string | Type: varchar Available from: / (25.11.0.62283) |
| VPE | string | Field is deprecated Type: smallint Available from: / (25.11.0.62283) |
| Price | number | Type: money Available from: / (25.11.0.62283) |
| Width | number | Type: numeric Available from: / (25.11.0.62283) |
| EANUPC | string | Item barcode Type: varchar Available from: / (25.11.0.62283) |
| Heigth | number | Type: numeric Available from: / (25.11.0.62283) |
| Length | number | Type: numeric Available from: / (25.11.0.62283) |
| Weight | number | Weight in grams Type: numeric Available from: / (25.11.0.62283) |
| DisDate | string | Field is deprecated Type: datetime Available from: / (25.11.0.62283) |
| Enabled | boolean | Type: bit Available from: / (25.11.0.62283) |
| ItemKey | integer | pixi* item ID Type: int Available from: / (25.11.0.62283) |
| RelDate | string | Field is deprecated Type: datetime Available from: / (25.11.0.62283) |
| SupplNr | string | Supplier number (code) Type: varchar Available from: / (25.11.0.62283) |
| IsBundle | boolean | Type: bit Available from: / (25.11.0.62283) |
| ItemName | string | Item name Type: varchar Available from: / (25.11.0.62283) |
| MwStSatz | string | VAT Rate Type: smallint Available from: / (25.11.0.62283) |
| Quantity | integer | Type: int Available from: / (25.11.0.62283) |
| AutoPrice | boolean | Type: bit Available from: / (25.11.0.62283) |
| DataSuppl | string | Type: varchar Available from: / (25.11.0.62283) |
| ItemNrInt | string | Shop item number Type: varchar Available from: / (25.11.0.62283) |
| ItemNrOld | string | Type: varchar Available from: / (25.11.0.62283) |
| OrderUnit | string | Type: varchar Available from: / (25.11.0.62283) |
| SupplName | string | Supplier name Type: varchar Available from: / (25.11.0.62283) |
| TontrText | string | Name of the category Type: varchar Available from: / (25.11.0.62283) |
| UpdateEmp | string | User who last updated the record Type: varchar Available from: / (25.11.0.62283) |
| ConfigType | string | Type: varchar Available from: / (25.11.0.62283) |
| CreateDate | string | Create date Type: smalldatetime Available from: / (25.11.0.62283) |
| SupplPrice | number | Supplier price of the item Type: money Available from: / (25.11.0.62283) |
| UpdateDate | string | Last update date of the record Type: smalldatetime Available from: / (25.11.0.62283) |
| Curr_Source | string | Type: varchar Available from: / (25.11.0.62283) |
| ItemNrSuppl | string | Supplier item number Type: varchar Available from: / (25.11.0.62283) |
| MinOrderQty | integer | Field is deprecated Type: int Available from: / (25.11.0.62283) |
| MinStockQty | integer | Minimum stock quantity for the item Type: int Available from: / (25.11.0.62283) |
| Manufacturer | string | Name of the manufacturer Type: varchar Available from: / (25.11.0.62283) |
| PicLinkLarge | string | URL to picture of the item (large size) Type: varchar Available from: / (25.11.0.62283) |
| PicLinkSmall | string | URL to picture of the item (small size) Type: varchar Available from: / (25.11.0.62283) |
| BookAccountEu | string | Type: varchar Available from: / (25.11.0.62283) |
| ExportQtyAvail | integer | Field is deprecated Type: int Available from: / (25.11.0.62283) |
| LastImportDate | string | Type: datetime Available from: / (25.11.0.62283) |
| AvgDeliveryTime | integer | Field is deprecated Type: int Available from: / (25.11.0.62283) |
| BookAccountNonEu | string | Type: varchar Available from: / (25.11.0.62283) |
| SerialNrRequired | boolean | Type: bit Available from: / (25.11.0.62283) |
| CustomsTariffText | string | Customs Tariff Text imported for the item with item import Type: varchar Available from: / (25.11.0.62283) |
| BookAccountEU_Suppl | string | Type: varchar Available from: / (25.11.0.62283) |
| CustomsTariffNumber | string | Type: varchar Available from: / (25.11.0.62283) |
| BookAccountEuCompanies | string | Type: varchar Available from: / (25.11.0.62283) |
| BookAccountNonEU_Suppl | string | Type: varchar Available from: / (25.11.0.62283) |
| CustomsCountryOfOrigin | string | Country of Origin imported for the item with item import (ISO-2 format) Type: varchar Available from: / (25.11.0.62283) |
| CustomsPreviousProcess | string | Type: varchar Available from: / (25.11.0.62283) |
| ExportReportedQtyAvail | integer | Field is deprecated Type: int Available from: / (25.11.0.62283) |
| ExportEstimatedDelivery | string | Type: datetime Available from: / (25.11.0.62283) |
| BookAccountEUCompanies_Suppl | string | Type: varchar Available from: / (25.11.0.62283) |
Response Example
<PixiReadItemsPost200TextXmlResponse>
<ItemKey>0</ItemKey>
<EANUPC>string</EANUPC>
<UPC>string</UPC>
<ItemNrSuppl>string</ItemNrSuppl>
<ItemNrInt>string</ItemNrInt>
<ItemNrOld>string</ItemNrOld>
<SupplNr>string</SupplNr>
<DataSuppl>string</DataSuppl>
<ItemName>string</ItemName>
<ConfigType>string</ConfigType>
<Price>0</Price>
<SupplPrice>0</SupplPrice>
<Curr_Source>string</Curr_Source>
<MwStSatz>string</MwStSatz>
<AutoPrice>true</AutoPrice>
<RelDate>string</RelDate>
<DisDate>string</DisDate>
<Weight>0</Weight>
<Heigth>0</Heigth>
<Width>0</Width>
<Length>0</Length>
<PicLinkLarge>string</PicLinkLarge>
<PicLinkSmall>string</PicLinkSmall>
<VPE>string</VPE>
<MinOrderQty>0</MinOrderQty>
<CreateDate>string</CreateDate>
<UpdateDate>string</UpdateDate>
<AvgDeliveryTime>0</AvgDeliveryTime>
<Quantity>0</Quantity>
<MinStockQty>0</MinStockQty>
<BookAccountEu>string</BookAccountEu>
<BookAccountNonEu>string</BookAccountNonEu>
<BookAccountEuCompanies>string</BookAccountEuCompanies>
<SerialNrRequired>true</SerialNrRequired>
<OrderUnit>string</OrderUnit>
<ExportQtyAvail>0</ExportQtyAvail>
<ExportReportedQtyAvail>0</ExportReportedQtyAvail>
<ExportEstimatedDelivery>string</ExportEstimatedDelivery>
<Enabled>true</Enabled>
<BookAccountEU_Suppl>string</BookAccountEU_Suppl>
<BookAccountNonEU_Suppl>string</BookAccountNonEU_Suppl>
<BookAccountEUCompanies_Suppl>string</BookAccountEUCompanies_Suppl>
<CustomsTariffNumber>string</CustomsTariffNumber>
<CustomsCountryOfOrigin>string</CustomsCountryOfOrigin>
<CustomsTariffText>string</CustomsTariffText>
<CustomsPreviousProcess>string</CustomsPreviousProcess>
<UpdateEmp>string</UpdateEmp>
<LastImportDate>string</LastImportDate>
<IsBundle>true</IsBundle>
<SupplName>string</SupplName>
<TontrText>string</TontrText>
<Manufacturer>string</Manufacturer>
</PixiReadItemsPost200TextXmlResponse>
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:pixiReadItems>
<ItemKey xsi:type="xsd:integer">123</ItemKey>
<RowCount xsi:type="xsd:integer">123</RowCount>
<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:pixiReadItems>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadItems', [
'ItemKey' => '123', // integer
'RowCount' => '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);
}