pixiReadBundleOrderlines
API call returns bundle orderlines
Since pixi version: 21.01 (9.0.23.54983) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
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) |
OrderlineKey | integer | false | pixi bundle orderline 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) |
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="">
<pixiReadBundleOrderlines>
<OrderlineKey>0</OrderlineKey>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadBundleOrderlines>
</Body>
</Envelope>
Response
1. Bundle ordeline details
Name | Type | Description |
---|---|---|
Qty | integer | Bundle item quantity Type: int Available from: / (25.7.0.59144) |
Note | string | Bundle orderline note Type: varchar (60) Available from: / (25.7.0.59144) |
ArtNr | string | Item barcode Type: varchar (50) Available from: / (25.7.0.59144) |
Price | number | Bundle item price Type: money Available from: / (25.7.0.59144) |
Source | string | Record creation source Type: varchar (1) Available from: / (25.7.0.59144) |
Status | string | Bundle orderline status Type: varchar (3) Available from: / (25.7.0.59144) |
AddrRef | integer | Billing address ID Type: int Available from: / (25.7.0.59144) |
ArtName | string | Name of the item Type: varchar (120) Available from: / (25.7.0.59144) |
CustRef | integer | ID of customer Type: int Available from: / (25.7.0.59144) |
DF_type | string | Direct fulfillment type Type: varchar (1) Available from: / (25.7.0.59144) |
ItemRef | integer | Item ID Type: int Available from: / (25.7.0.59144) |
OrderMS | string | Currency code Type: varchar (3) Available from: / (25.7.0.59144) |
OrderNr | integer | Order number in pixi* Type: int Available from: / (25.7.0.59144) |
TaxRate | number | VAT rate Type: numeric Available from: / (25.7.0.59144) |
VATsRef | integer | VAT refference ID Type: int Available from: / (25.7.0.59144) |
rowguid | string | Uniquely identifying row Type: uniqueidentifier Available from: / (25.7.0.59144) |
TimeZone | string | Time zone Type: char Available from: / (25.7.0.59144) |
WaitDays | integer | Days to wait before shipping Type: int Available from: / (25.7.0.59144) |
CreateEmp | string | Creator of the recodr (pixi user) Type: varchar (50) Available from: / (25.7.0.59144) |
FullPrice | number | Bundle orderline full price Type: money Available from: / (25.7.0.59144) |
OrdShopID | string | Shop ID Type: varchar (3) Available from: / (25.7.0.59144) |
OrderDate | string | Order date Type: datetime Available from: / (25.7.0.59144) |
Price_Net | number | Price without VAT Type: money Available from: / (25.7.0.59144) |
SupplInfo | string | Supplier code Type: varchar (4) Available from: / (25.7.0.59144) |
TaxAmount | number | VAT amount Type: money Available from: / (25.7.0.59144) |
UpdateEmp | string | User who last updated the record Type: varchar (50) Available from: / (25.7.0.59144) |
VoucherID | string | ID of the voucher Type: varchar (50) Available from: / (25.7.0.59144) |
ConfigType | string | Category ID Type: varchar (4) Available from: / (25.7.0.59144) |
CreateDate | string | Create date Type: datetime Available from: / (25.7.0.59144) |
LocationID | string | Location ID Type: varchar (3) Available from: / (25.7.0.59144) |
ShipAdrRef | integer | Shipping address ID Type: int Available from: / (25.7.0.59144) |
SupplGroup | string | Item supplier group Type: varchar (4) Available from: / (25.7.0.59144) |
SupplPrice | number | Supplier price of the item Type: money Available from: / (25.7.0.59144) |
UpdateDate | string | Last update date of the record Type: datetime Available from: / (25.7.0.59144) |
VATPercent | number | VAT percent Type: numeric Available from: / (25.7.0.59144) |
DiscountPerc | number | Discount percent Type: numeric Available from: / (25.7.0.59144) |
OrderlineKey | integer | ID for the Orderline record Type: int Available from: / (25.7.0.59144) |
DiscountValue | number | Discount value Type: money Available from: / (25.7.0.59144) |
OrderLineType | string | Type of order Type: varchar (3) Available from: / (25.7.0.59144) |
ItemNrExternal | string | Item number external (Imported from Shop) Type: varchar (50) Available from: / (25.7.0.59144) |
OrderNrExternal | string | External order number Type: varchar (50) Available from: / (25.7.0.59144) |
ShipCostPerItem | string | Shipping costs per item Type: varchar (1) Available from: / (25.7.0.59144) |
oItemSpecialNote | string | Bundle item note Type: varchar (8000) Available from: / (25.7.0.59144) |
LastOrdLocationID | string | Last order location ID Type: varchar (3) Available from: / (25.7.0.59144) |
Response Example
<PixiReadBundleOrderlinesPost200TextXmlResponse>
<OrderlineKey>0</OrderlineKey>
<OrderNr>0</OrderNr>
<CustRef>0</CustRef>
<AddrRef>0</AddrRef>
<ShipAdrRef>0</ShipAdrRef>
<SupplInfo>string</SupplInfo>
<ArtNr>string</ArtNr>
<ArtName>string</ArtName>
<Qty>0</Qty>
<Price>0</Price>
<SupplPrice>0</SupplPrice>
<Status>string</Status>
<Note>string</Note>
<OrderMS>string</OrderMS>
<ConfigType>string</ConfigType>
<Source>string</Source>
<OrderDate>string</OrderDate>
<TimeZone>string</TimeZone>
<OrderLineType>string</OrderLineType>
<CreateDate>string</CreateDate>
<CreateEmp>string</CreateEmp>
<UpdateDate>string</UpdateDate>
<UpdateEmp>string</UpdateEmp>
<ItemRef>0</ItemRef>
<WaitDays>0</WaitDays>
<TaxAmount>0</TaxAmount>
<TaxRate>0</TaxRate>
<ShipCostPerItem>string</ShipCostPerItem>
<OrderNrExternal>string</OrderNrExternal>
<ItemNrExternal>string</ItemNrExternal>
<LocationID>string</LocationID>
<LastOrdLocationID>string</LastOrdLocationID>
<SupplGroup>string</SupplGroup>
<rowguid>string</rowguid>
<OrdShopID>string</OrdShopID>
<VoucherID>string</VoucherID>
<oItemSpecialNote>string</oItemSpecialNote>
<DiscountValue>0</DiscountValue>
<DiscountPerc>0</DiscountPerc>
<FullPrice>0</FullPrice>
<DF_type>string</DF_type>
<Price_Net>0</Price_Net>
<VATPercent>0</VATPercent>
<VATsRef>0</VATsRef>
</PixiReadBundleOrderlinesPost200TextXmlResponse>
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:pixiReadBundleOrderlines>
<RowCount xsi:type="xsd:integer">123</RowCount>
<CreateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateDateTo>
<OrderlineKey xsi:type="xsd:integer">123</OrderlineKey>
<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:pixiReadBundleOrderlines>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadBundleOrderlines', [
'RowCount' => '123', // integer
'CreateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'OrderlineKey' => '123', // integer
'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);
}