pixiReadOrderlines
API Call to retrieve all relevant orderlines lines
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
RowCount | integer | false | Maximum number of rows returned Type: int Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateTo | string | false | Create Date to (excluding) Type: datetime Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderlineKey | integer | false | pixi* orderline Key. If @RowCount is NULL then it returns only this row, otherwise next @RowCount records. Type: int Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateTo | string | false | Update Date To (excluding) Type: datetime Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateFrom | string | false | Create Date from (including) Type: datetime Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateFrom | string | false | Update Date from (including) Type: datetime Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateAndUpdateDateTo | string | false | Create or Update Date to (excluding) Type: datetime Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateAndUpdateDateFrom | string | false | Create or Update Date from (including) Type: datetime Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReadOrderlines>
<OrderlineKey>0</OrderlineKey>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadOrderlines>
</Body>
</Envelope>
Response
1. Orderlines list
Name | Type | Description |
---|---|---|
Qty | integer | Quantity Type: INT Available from: 25.06 (25.6.0.58802) |
Note | string | Type: VARCHAR(60) Available from: 25.06 (25.6.0.58802) |
ArtNr | string | Barcode Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
BoxNr | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
Price | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
ArtVAT | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
ConfMS | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
InvRef | integer | ID for the Invoice record Type: INT Available from: 25.06 (25.6.0.58802) |
NODRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
ShipId | string | Type: VARCHAR(13) Available from: 25.06 (25.6.0.58802) |
Source | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
Status | string | Status Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
AddrRef | integer | ID for the Address record Type: INT Available from: 25.06 (25.6.0.58802) |
ArtName | string | Name of the item Type: varchar (120) Available from: 25.06 (25.6.0.58802) |
ConfVia | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
CustRef | integer | IF for the Customer record Type: INT Available from: 25.06 (25.6.0.58802) |
DF_type | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
ItemRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
OrGosF1 | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
OrGosF2 | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
OrderMS | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | Order number in pixi* Type: INT Available from: 25.06 (25.6.0.58802) |
ShipRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
TaxRate | number | Type: numeric Available from: 25.06 (25.6.0.58802) |
VATsRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
rowguid | string | Type: UNIQUEIDENTIFIER Available from: 25.06 (25.6.0.58802) |
Backlist | string | Type: SMALLINT Available from: 25.06 (25.6.0.58802) |
ConfDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
Discount | string | Type: SMALLINT Available from: 25.06 (25.6.0.58802) |
LConfVia | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
Order_Id | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
Refunded | boolean | Type: BIT Available from: 25.06 (25.6.0.58802) |
SerialNr | string | Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
ShipCost | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
ShipDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
SupplRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
TimeZone | string | Type: CHAR(6) Available from: 25.06 (25.6.0.58802) |
WaitDays | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
CreateEmp | string | Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
FullPrice | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
LConfDate | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
MusicType | string | Type: VARCHAR(4) Available from: 25.06 (25.6.0.58802) |
OrCCPLock | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
OrdShopID | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
Price_Net | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
SupplInfo | string | Type: VARCHAR(4) Available from: 25.06 (25.6.0.58802) |
TaxAmount | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
UpdateEmp | string | Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
VoucherID | string | Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
ChangeDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
ConfigType | string | Type: VARCHAR(4) Available from: 25.06 (25.6.0.58802) |
CreateDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
DFShipDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
DIcheckbox | boolean | Type: BIT Available from: 25.06 (25.6.0.58802) |
HALEmailed | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
LocationID | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
NotEmailed | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
OrReplFlag | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
SOrderDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
ShipAdrRef | integer | ID for the Shipping Address record Type: INT Available from: 25.06 (25.6.0.58802) |
SupplGroup | string | Type: VARCHAR(4) Available from: 25.06 (25.6.0.58802) |
SupplPrice | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
VATPercent | number | Type: NUMERIC Available from: 25.06 (25.6.0.58802) |
BatchNumber | string | Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
ConfEmailed | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
Curr_Source | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
AktionsKennz | string | Type: VARCHAR(10) Available from: 25.06 (25.6.0.58802) |
BackorderRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
CCEXpEmailed | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
CCReqEmailed | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
DelayEMailed | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
DiscountPerc | number | Type: NUMERIC Available from: 25.06 (25.6.0.58802) |
OrderlineKey | integer | ID for the Orderline record Type: INT Available from: 25.06 (25.6.0.58802) |
BookAccountNr | string | Type: VARCHAR(20) Available from: 25.06 (25.6.0.58802) |
DiscountValue | string | Type: MOMNEY Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
OrderExchRate | number | Type: numeric Available from: 25.06 (25.6.0.58802) |
OrderLineType | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
SOrderlineRef | integer | *Obsolete Type: INT Available from: 25.06 (25.6.0.58802) |
AlreadyOrdered | boolean | Type: BIT Available from: 25.06 (25.6.0.58802) |
BestBeforeDate | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
ChangeSequence | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
ItemNrExternal | string | Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
LastDelayEmail | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
MeasuredWeight | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
OrShippingNote | string | Type: VARCHAR(100) Available from: 25.06 (25.6.0.58802) |
PickListNrUsed | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
CustomerEMailed | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
ForceFirstSuppl | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
ForceLocToSuppl | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
Price_OrderCurr | number | *Obsolete Type: MONEY Available from: 25.06 (25.6.0.58802) |
ShipCostPerItem | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
UpdateBackToHal | boolean | Type: BIT Available from: 25.06 (25.6.0.58802) |
InvSorderlineRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
SupplGroupScanIn | string | Type: VARCHAR(4) Available from: 25.06 (25.6.0.58802) |
oItemSpecialNote | string | Type: VARCHAR(8000) Available from: 25.06 (25.6.0.58802) |
EstimatedDelivery | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
ForceParallelShip | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
InvoiceNrExternal | string | Type: VARCHAR(20) Available from: 25.06 (25.6.0.58802) |
LastOrdLocationID | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
RealSorderlineRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
SupplPrice_Source | string | Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
BundleOrderlineRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
NLBCustomerEmailed | string | Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
ShipCost_OrderCurr | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
OrderDateStartOfDay | string | Type: DATETIME Available from: 25.06 (25.6.0.58802) |
Price_OrderCurr_Set | integer | *Obsolete Type: INT Available from: 25.06 (25.6.0.58802) |
DFShipmentTrackingID | string | Type: VARCHAR(100) Available from: 25.06 (25.6.0.58802) |
OriginalOrderlineRef | integer | Type: INT Available from: 25.06 (25.6.0.58802) |
ItemOriginalFullPrice | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
PriceWeightUnits_Price | number | Type: MONEY Available from: 25.06 (25.6.0.58802) |
ShipCost_OrderCurr_Set | integer | *Obsolete Type: INT Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReadOrderlinesPost200TextXmlResponse>
<OrderlineKey>0</OrderlineKey>
<OrderNr>0</OrderNr>
<CustRef>0</CustRef>
<AddrRef>0</AddrRef>
<ShipAdrRef>0</ShipAdrRef>
<InvRef>0</InvRef>
<NODRef>0</NODRef>
<SupplRef>0</SupplRef>
<SupplInfo>string</SupplInfo>
<ShipRef>0</ShipRef>
<ArtNr>string</ArtNr>
<ArtName>string</ArtName>
<Qty>0</Qty>
<Backlist>string</Backlist>
<Price>0</Price>
<SupplPrice>0</SupplPrice>
<ArtVAT>string</ArtVAT>
<Status>string</Status>
<Note>string</Note>
<OrderMS>string</OrderMS>
<ConfMS>string</ConfMS>
<ConfigType>string</ConfigType>
<MusicType>string</MusicType>
<Source>string</Source>
<OrderDate>string</OrderDate>
<TimeZone>string</TimeZone>
<SOrderDate>string</SOrderDate>
<ConfDate>string</ConfDate>
<ConfVia>string</ConfVia>
<LConfDate>0</LConfDate>
<LConfVia>string</LConfVia>
<ShipDate>string</ShipDate>
<AktionsKennz>string</AktionsKennz>
<Discount>string</Discount>
<ShipId>string</ShipId>
<BoxNr>0</BoxNr>
<OrderLineType>string</OrderLineType>
<BackorderRef>0</BackorderRef>
<OrderCurrency>string</OrderCurrency>
<CreateDate>string</CreateDate>
<CreateEmp>string</CreateEmp>
<UpdateDate>string</UpdateDate>
<UpdateEmp>string</UpdateEmp>
<OrderExchRate>0</OrderExchRate>
<ItemRef>0</ItemRef>
<WaitDays>0</WaitDays>
<Price_OrderCurr>0</Price_OrderCurr>
<TaxAmount>0</TaxAmount>
<TaxRate>0</TaxRate>
<ShipCost>0</ShipCost>
<ShipCostPerItem>string</ShipCostPerItem>
<ShipCost_OrderCurr>0</ShipCost_OrderCurr>
<OrderNrExternal>string</OrderNrExternal>
<ItemNrExternal>string</ItemNrExternal>
<LocationID>string</LocationID>
<LastOrdLocationID>string</LastOrdLocationID>
<SupplGroup>string</SupplGroup>
<SOrderlineRef>0</SOrderlineRef>
<CustomerEMailed>string</CustomerEMailed>
<DelayEMailed>string</DelayEMailed>
<SupplGroupScanIn>string</SupplGroupScanIn>
<rowguid>string</rowguid>
<OrdShopID>string</OrdShopID>
<OrGosF1>string</OrGosF1>
<OrGosF2>string</OrGosF2>
<SupplPrice_Source>string</SupplPrice_Source>
<Curr_Source>string</Curr_Source>
<LastDelayEmail>string</LastDelayEmail>
<ConfEmailed>string</ConfEmailed>
<HALEmailed>string</HALEmailed>
<CCReqEmailed>string</CCReqEmailed>
<CCEXpEmailed>string</CCEXpEmailed>
<NotEmailed>string</NotEmailed>
<OrShippingNote>string</OrShippingNote>
<ForceFirstSuppl>string</ForceFirstSuppl>
<ForceLocToSuppl>string</ForceLocToSuppl>
<ForceParallelShip>string</ForceParallelShip>
<VoucherID>string</VoucherID>
<OrReplFlag>string</OrReplFlag>
<OrCCPLock>string</OrCCPLock>
<ChangeDate>string</ChangeDate>
<ChangeSequence>0</ChangeSequence>
<InvSorderlineRef>0</InvSorderlineRef>
<BundleOrderlineRef>0</BundleOrderlineRef>
<Refunded>true</Refunded>
<DIcheckbox>true</DIcheckbox>
<OriginalOrderlineRef>0</OriginalOrderlineRef>
<oItemSpecialNote>string</oItemSpecialNote>
<DiscountValue>string</DiscountValue>
<DiscountPerc>0</DiscountPerc>
<BookAccountNr>string</BookAccountNr>
<SerialNr>string</SerialNr>
<UpdateBackToHal>true</UpdateBackToHal>
<AlreadyOrdered>true</AlreadyOrdered>
<FullPrice>0</FullPrice>
<DF_type>string</DF_type>
<DFShipDate>string</DFShipDate>
<DFShipmentTrackingID>string</DFShipmentTrackingID>
<NLBCustomerEmailed>string</NLBCustomerEmailed>
<PriceWeightUnits_Price>0</PriceWeightUnits_Price>
<MeasuredWeight>0</MeasuredWeight>
<OrderDateStartOfDay>string</OrderDateStartOfDay>
<PickListNrUsed>0</PickListNrUsed>
<InvoiceNrExternal>string</InvoiceNrExternal>
<Order_Id>0</Order_Id>
<ItemOriginalFullPrice>0</ItemOriginalFullPrice>
<Price_Net>0</Price_Net>
<Price_OrderCurr_Set>0</Price_OrderCurr_Set>
<ShipCost_OrderCurr_Set>0</ShipCost_OrderCurr_Set>
<VATPercent>0</VATPercent>
<VATsRef>0</VATsRef>
<BatchNumber>string</BatchNumber>
<BestBeforeDate>string</BestBeforeDate>
<RealSorderlineRef>0</RealSorderlineRef>
<EstimatedDelivery>string</EstimatedDelivery>
</PixiReadOrderlinesPost200TextXmlResponse>
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:pixiReadOrderlines>
<RowCount xsi:type="xsd:integer"></RowCount>
<CreateDateTo xsi:type="xsd:string"></CreateDateTo>
<OrderlineKey xsi:type="xsd:integer"></OrderlineKey>
<UpdateDateTo xsi:type="xsd:string"></UpdateDateTo>
<CreateDateFrom xsi:type="xsd:string"></CreateDateFrom>
<UpdateDateFrom xsi:type="xsd:string"></UpdateDateFrom>
<CreateAndUpdateDateTo xsi:type="xsd:string"></CreateAndUpdateDateTo>
<CreateAndUpdateDateFrom xsi:type="xsd:string"></CreateAndUpdateDateFrom>
</ns1:pixiReadOrderlines>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadOrderlines', [
'RowCount' => '', // integer
'CreateDateTo' => '', // string
'OrderlineKey' => '', // integer
'UpdateDateTo' => '', // string
'CreateDateFrom' => '', // string
'UpdateDateFrom' => '', // string
'CreateAndUpdateDateTo' => '', // string
'CreateAndUpdateDateFrom' => '', // 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);
}