pixiGetReturnItems
API call returns items of a specific return case.
Since pixi version: AVA 17.11 (8.4.35.32155) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ReturnId | integer | true | ReturnId for which returned items should be returned. Type: int Default value: Example: 4003 Available from: AVA 17.11 (8.4.35.32155) |
LanguageId | integer | false | Laguage ID in which the description for return reasons should be returned. (1=English; 2=German) Type: int Default value: 1 Example: 2 Available from: AVA 17.11 (8.4.35.32155) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetReturnItems>
<ReturnId>0</ReturnId>
<LanguageId>0</LanguageId>
</pixiGetReturnItems>
</Body>
</Envelope>
Response
1. Return details
Name | Type | Description |
---|---|---|
Id | integer | Return item row ID Type: int Available from: 25.06 (25.6.0.58802) |
BinId | integer | Bin ID to which item was returned Type: int Available from: 25.06 (25.6.0.58802) |
EANUPC | string | Item barcode Type: varchar (13) Available from: 25.06 (25.6.0.58802) |
ItemId | integer | pixi* item ID Type: int Available from: 25.06 (25.6.0.58802) |
ItemName | string | Item name Type: varchar (120) Available from: 25.06 (25.6.0.58802) |
Quantity | integer | Quantity of the items returned Type: int Available from: 25.06 (25.6.0.58802) |
ReasonId | integer | Return Reason ID Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
ReasonCode | string | Return reason code Type: varchar (100) Available from: 25.06 (25.6.0.58802) |
BatchNumber | string | Item batch number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
UserComment | string | User's comment Type: nvarchar(max) Available from: 25.06 (25.6.0.58802) |
LocationCode | string | Location code to which item was returned Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
InvoiceLineId | integer | Invoice item ID Type: int Available from: 25.06 (25.6.0.58802) |
IsSpecialCase | boolean | Notes if it is a special case Type: bit Available from: 25.06 (25.6.0.58802) |
BestBeforeDate | string | Item best before date Type: datetime Available from: 25.06 (25.6.0.58802) |
CustomerComment | string | Customer's coment Type: nvarchar(max) Available from: 25.06 (25.6.0.58802) |
RecordModifiedOn | string | Last modification date of a record Type: smalldatetime Available from: 25.06 (25.6.0.58802) |
ReasonDescription | string | Localized return description. Type: varchar(max) Available from: 25.06 (25.6.0.58802) |
ItemClassification | string | Returned Item Classification Code Type: varchar (100) Available from: 25.06 (25.6.0.58802) |
ItemClassificationDescription | string | Returned Item Classification Code Description Type: varchar (max) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetReturnItemsPost200TextXmlResponse>
<Id>0</Id>
<ReasonId>0</ReasonId>
<ReasonDescription>string</ReasonDescription>
<ItemId>0</ItemId>
<EANUPC>string</EANUPC>
<ItemName>string</ItemName>
<Quantity>0</Quantity>
<LocationCode>string</LocationCode>
<BinId>0</BinId>
<BestBeforeDate>string</BestBeforeDate>
<BatchNumber>string</BatchNumber>
<InvoiceLineId>0</InvoiceLineId>
<IsSpecialCase>true</IsSpecialCase>
<CustomerComment>string</CustomerComment>
<UserComment>string</UserComment>
<RecordModifiedOn>string</RecordModifiedOn>
<ItemNrInt>string</ItemNrInt>
<ReasonCode>string</ReasonCode>
<ItemClassification>string</ItemClassification>
<ItemClassificationDescription>string</ItemClassificationDescription>
</PixiGetReturnItemsPost200TextXmlResponse>
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:pixiGetReturnItems>
<ReturnId xsi:type="xsd:integer">4003</ReturnId> <!-- required -->
<LanguageId xsi:type="xsd:integer">2</LanguageId>
</ns1:pixiGetReturnItems>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetReturnItems', [
'ReturnId' => '4003', // integer (required)
'LanguageId' => '2', // integer
]);
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);
}