pixiReadReturnLines
API call returns return line records
Since pixi version: 21.01 (9.0.23.54983) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| Id | integer | false | Return line id. If @RowCount is NULL then it returns only this row, otherwise next @RowCount records. Type: int Default value: NULL Example: 123 Available from: 21.01 (9.0.23.54983) |
| RowCount | integer | false | Maximum number of records returned Type: int Default value: 1000 Example: 123 Available from: 21.01 (9.0.23.54983) |
| CreateDateTo | string | false | Create Date to (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983) |
| UpdateDateTo | string | false | Update Date To (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983) |
| CreateDateFrom | string | false | Create Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983) |
| UpdateDateFrom | string | false | Update Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983) |
| CreateAndUpdateDateTo | string | false | Create or Update Date to (excluding) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983) |
| CreateAndUpdateDateFrom | string | false | Create or Update Date from (including) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReadReturnLines>
<Id>0</Id>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadReturnLines>
</Body>
</Envelope>Response
1. Return line information
| Name | Type | Description |
|---|---|---|
| Id | integer | Return line Id Type: int Available from: 25.06 (25.6.0.58802) |
| ReasonId | integer | Reason Id Type: int Available from: 25.06 (25.6.0.58802) |
| ReturnId | integer | Foreign key to Return table. Type: int Available from: 25.06 (25.6.0.58802) |
| UserComment | string | Users commnet about the returned item Type: nvarchar Available from: 25.06 (25.6.0.58802) |
| ItemPriceNet | number | Item net price. Type: money Available from: 25.06 (25.6.0.58802) |
| InvoiceLineId | integer | Invoice line Id Type: int Available from: 25.06 (25.6.0.58802) |
| IsSpecialCase | boolean | Notes that there is something special about item being returned Type: bit Available from: 25.06 (25.6.0.58802) |
| ReturnItemQty | integer | Returned item quantity. Type: int Available from: 25.06 (25.6.0.58802) |
| InvoiceItemQty | integer | Invoice item quantity. Type: int Available from: 25.06 (25.6.0.58802) |
| ItemPriceGross | number | Item gross price. Type: money Available from: 25.06 (25.6.0.58802) |
| CustomerComment | string | Customers comment about the returned item Type: nvarchar Available from: 25.06 (25.6.0.58802) |
| InvBinItemLogId | integer | Foreign key to the put to stock operation. Type: int Available from: 25.06 (25.6.0.58802) |
| RecordCreatedOn | string | Date of creation. Type: smalldatetime Available from: 25.06 (25.6.0.58802) |
| RecordModifiedOn | string | Timestamp of the last modification of the record Type: smalldatetime Available from: 25.06 (25.6.0.58802) |
| RecordCreatedByUserId | integer | Foreign key to users table - user name who created the object. Type: int Available from: 25.06 (25.6.0.58802) |
| RecordModifiedByUserId | integer | Foreign key to users table - user name who last modified the object. Type: int Available from: 25.06 (25.6.0.58802) |
| ItemQualityClassificationId | integer | Foreign key to CodeTableValue Item Quality Classification codetable. Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReadReturnLinesPost200TextXmlResponse>
<Id>0</Id>
<ReasonId>0</ReasonId>
<InvoiceLineId>0</InvoiceLineId>
<IsSpecialCase>true</IsSpecialCase>
<CustomerComment>string</CustomerComment>
<UserComment>string</UserComment>
<RecordModifiedOn>string</RecordModifiedOn>
<ReturnId>0</ReturnId>
<InvBinItemLogId>0</InvBinItemLogId>
<InvoiceItemQty>0</InvoiceItemQty>
<ReturnItemQty>0</ReturnItemQty>
<ItemPriceGross>0</ItemPriceGross>
<ItemPriceNet>0</ItemPriceNet>
<RecordCreatedOn>string</RecordCreatedOn>
<RecordCreatedByUserId>0</RecordCreatedByUserId>
<RecordModifiedByUserId>0</RecordModifiedByUserId>
<ItemQualityClassificationId>0</ItemQualityClassificationId>
</PixiReadReturnLinesPost200TextXmlResponse>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:pixiReadReturnLines>
<Id xsi:type="xsd:integer">123</Id>
<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:pixiReadReturnLines>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiReadReturnLines', [
'Id' => '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);
}