pixiReadOrderHeader
API Call to retrieve all relevant orders
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNr | integer | false | pixi* OrderNr Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| RowCount | integer | false | Number of rows returned. (The maximum allowed value is set to 100 000) Type: int Default value: 1000 Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| CreateDateTo | string | false | Create Date to (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| UpdateDateTo | string | false | Update Date To (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| CreateDateFrom | string | false | Create Date from (including) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| OrderHeaderKey | integer | false | pixi* Orderheader Key Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| UpdateDateFrom | string | false | Update Date from (including) Type: datetime Default value: NULL Example: 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: 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: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReadOrderHeader>
<OrderHeaderKey>0</OrderHeaderKey>
<OrderNr>0</OrderNr>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadOrderHeader>
</Body>
</Envelope>
Response
1. Result set
| Name | Type | Description |
|---|---|---|
| DFType | integer | DFType Type: int Available from: / (25.11.0.62283) |
| Extras | string | Extras Type: varchar Available from: / (25.11.0.62283) |
| AddrRef | integer | AddrRef Type: int Available from: / (25.11.0.62283) |
| CustRef | integer | CustRef Type: int Available from: / (25.11.0.62283) |
| OhGosF1 | string | OhGosF1 Type: varchar Available from: / (25.11.0.62283) |
| OhGosF2 | string | OhGosF2 Type: varchar Available from: / (25.11.0.62283) |
| OrderNr | integer | OrderNr Type: int Available from: / (25.11.0.62283) |
| Product | string | Product Type: varchar Available from: / (25.11.0.62283) |
| rowguid | integer | rowguid Type: int Available from: / (25.11.0.62283) |
| Discount | string | Discount Type: varchar Available from: / (25.11.0.62283) |
| OhShipID | string | OhShipID Type: varchar Available from: / (25.11.0.62283) |
| Referrer | string | Referrer Type: varchar Available from: / (25.11.0.62283) |
| ShipCost | string | ShipCost Type: varchar Available from: / (25.11.0.62283) |
| Shipdate | string | Shipdate Type: datetime Available from: / (25.11.0.62283) |
| ccpPayID | string | ccpPayID Type: varchar Available from: / (25.11.0.62283) |
| CreateEmp | string | CreateEmp Type: varchar Available from: / (25.11.0.62283) |
| IPAddress | string | IPAddress Type: varchar Available from: / (25.11.0.62283) |
| OhSLocked | string | OhSLocked Type: varchar Available from: / (25.11.0.62283) |
| Shop_Note | string | Shop_Note Type: varchar Available from: / (25.11.0.62283) |
| UpdateEmp | string | UpdateEmp Type: varchar Available from: / (25.11.0.62283) |
| Verfahren | string | Verfahren Type: varchar Available from: / (25.11.0.62283) |
| ChangeDate | string | ChangeDate Type: datetime Available from: / (25.11.0.62283) |
| ChannelRef | integer | ChannelRef Type: int Available from: / (25.11.0.62283) |
| CreateDate | string | CreateDate Type: datetime Available from: / (25.11.0.62283) |
| CurrencyId | integer | CurrencyId Type: int Available from: / (25.11.0.62283) |
| ExchRateId | integer | ExchRateId Type: int Available from: / (25.11.0.62283) |
| OhWaitDays | integer | OhWaitDays Type: int Available from: / (25.11.0.62283) |
| OhWrapType | string | OhWrapType Type: varchar Available from: / (25.11.0.62283) |
| OrderTotal | string | OrderTotal Type: varchar Available from: / (25.11.0.62283) |
| ShipAdrRef | integer | ShipAdrRef Type: int Available from: / (25.11.0.62283) |
| UpdateDate | string | UpdateDate Type: datetime Available from: / (25.11.0.62283) |
| GiftMessage | string | GiftMessage Type: varchar Available from: / (25.11.0.62283) |
| OhShipImmed | string | OhShipImmed Type: varchar Available from: / (25.11.0.62283) |
| OrderStatus | string | OrderStatus Type: varchar Available from: / (25.11.0.62283) |
| SubShopLogo | string | SubShopLogo Type: varchar Available from: / (25.11.0.62283) |
| SubShopName | string | SubShopName Type: varchar Available from: / (25.11.0.62283) |
| ResOnLocDate | string | ResOnLocDate Type: datetime Available from: / (25.11.0.62283) |
| ShipInstruct | string | ShipInstruct Type: varchar Available from: / (25.11.0.62283) |
| CCPNumOfTries | integer | CCPNumOfTries Type: int Available from: / (25.11.0.62283) |
| ManualResDate | string | ManualResDate Type: datetime Available from: / (25.11.0.62283) |
| OhWrapMessage | string | OhWrapMessage Type: varchar Available from: / (25.11.0.62283) |
| ChangeReported | string | ChangeReported Type: varchar Available from: / (25.11.0.62283) |
| ChangeSequence | integer | ChangeSequence Type: int Available from: / (25.11.0.62283) |
| OhSCostCharged | string | OhSCostCharged Type: varchar Available from: / (25.11.0.62283) |
| OhShippingNote | string | OhShippingNote Type: varchar Available from: / (25.11.0.62283) |
| OrderHeaderKey | integer | OrderHeaderKey Type: int Available from: / (25.11.0.62283) |
| PaidByCustomer | string | PaidByCustomer Type: varchar Available from: / (25.11.0.62283) |
| PaidBySwiftRef | string | PaidBySwiftRef Type: varchar Available from: / (25.11.0.62283) |
| ShipVendorCode | string | ShipVendorCode Type: varchar Available from: / (25.11.0.62283) |
| Address_Remarks | string | Address_Remarks Type: varchar Available from: / (25.11.0.62283) |
| CCPLastAuthCode | string | CCPLastAuthCode Type: varchar Available from: / (25.11.0.62283) |
| OhCCPmerchantID | string | OhCCPmerchantID Type: varchar Available from: / (25.11.0.62283) |
| OrderLinesTotal | string | OrderLinesTotal Type: varchar Available from: / (25.11.0.62283) |
| OrderNrExternal | string | OrderNrExternal Type: varchar Available from: / (25.11.0.62283) |
| ccpSetFailTries | integer | ccpSetFailTries Type: int Available from: / (25.11.0.62283) |
| CCPPaymentInfoOK | string | CCPPaymentInfoOK Type: varchar Available from: / (25.11.0.62283) |
| CCPReauthorizeYN | string | CCPReauthorizeYN Type: varchar Available from: / (25.11.0.62283) |
| OhChargeShipCost | string | OhChargeShipCost Type: varchar Available from: / (25.11.0.62283) |
| OhSCostChargeType | integer | OhSCostChargeType Type: int Available from: / (25.11.0.62283) |
| AutoPaymentCreated | boolean | AutoPaymentCreated Type: bit Available from: / (25.11.0.62283) |
| OrderLinesDiscount | string | OrderLinesDiscount Type: varchar Available from: / (25.11.0.62283) |
| ccpSetFailLastTime | string | ccpSetFailLastTime Type: datetime Available from: / (25.11.0.62283) |
| AutoReservationDone | boolean | AutoReservationDone Type: bit Available from: / (25.11.0.62283) |
| ExtraShippingCharged | string | ExtraShippingCharged Type: varchar Available from: / (25.11.0.62283) |
| OHMultiForceToPicklist | boolean | OHMultiForceToPicklist Type: bit Available from: / (25.11.0.62283) |
| OhSCostFirstItemCharged | string | OhSCostFirstItemCharged Type: varchar Available from: / (25.11.0.62283) |
| ForceToPicklistIfNotFULL | boolean | ForceToPicklistIfNotFULL Type: bit Available from: / (25.11.0.62283) |
| OHCancelAfterForcedShipOut | boolean | OHCancelAfterForcedShipOut Type: bit Available from: / (25.11.0.62283) |
Response Example
<PixiReadOrderHeaderPost200TextXmlResponse>
<OrderHeaderKey>0</OrderHeaderKey>
<OrderNr>0</OrderNr>
<ShipVendorCode>string</ShipVendorCode>
<GiftMessage>string</GiftMessage>
<ShipInstruct>string</ShipInstruct>
<Discount>string</Discount>
<IPAddress>string</IPAddress>
<CCPPaymentInfoOK>string</CCPPaymentInfoOK>
<CCPLastAuthCode>string</CCPLastAuthCode>
<CCPNumOfTries>0</CCPNumOfTries>
<CCPReauthorizeYN>string</CCPReauthorizeYN>
<CreateEmp>string</CreateEmp>
<CreateDate>string</CreateDate>
<UpdateEmp>string</UpdateEmp>
<UpdateDate>string</UpdateDate>
<CustRef>0</CustRef>
<AddrRef>0</AddrRef>
<ShipAdrRef>0</ShipAdrRef>
<rowguid>0</rowguid>
<OhSCostCharged>string</OhSCostCharged>
<OhShippingNote>string</OhShippingNote>
<OhChargeShipCost>string</OhChargeShipCost>
<OhWrapType>string</OhWrapType>
<OhWrapMessage>string</OhWrapMessage>
<OhSCostChargeType>0</OhSCostChargeType>
<OhSCostFirstItemCharged>string</OhSCostFirstItemCharged>
<OhShipImmed>string</OhShipImmed>
<OhSLocked>string</OhSLocked>
<OhGosF1>string</OhGosF1>
<OhGosF2>string</OhGosF2>
<OhWaitDays>0</OhWaitDays>
<OhShipID>string</OhShipID>
<Address_Remarks>string</Address_Remarks>
<Verfahren>string</Verfahren>
<Product>string</Product>
<Extras>string</Extras>
<Shipdate>string</Shipdate>
<ChangeDate>string</ChangeDate>
<ChangeSequence>0</ChangeSequence>
<ChangeReported>string</ChangeReported>
<ExtraShippingCharged>string</ExtraShippingCharged>
<ccpPayID>string</ccpPayID>
<ccpSetFailTries>0</ccpSetFailTries>
<ccpSetFailLastTime>string</ccpSetFailLastTime>
<PaidBySwiftRef>string</PaidBySwiftRef>
<Shop_Note>string</Shop_Note>
<PaidByCustomer>string</PaidByCustomer>
<OhCCPmerchantID>string</OhCCPmerchantID>
<ShipCost>string</ShipCost>
<AutoReservationDone>true</AutoReservationDone>
<ForceToPicklistIfNotFULL>true</ForceToPicklistIfNotFULL>
<DFType>0</DFType>
<ManualResDate>string</ManualResDate>
<OHMultiForceToPicklist>true</OHMultiForceToPicklist>
<OHCancelAfterForcedShipOut>true</OHCancelAfterForcedShipOut>
<SubShopLogo>string</SubShopLogo>
<SubShopName>string</SubShopName>
<Referrer>string</Referrer>
<AutoPaymentCreated>true</AutoPaymentCreated>
<ResOnLocDate>string</ResOnLocDate>
<ChannelRef>0</ChannelRef>
<OrderNrExternal>string</OrderNrExternal>
<OrderStatus>string</OrderStatus>
<OrderLinesTotal>string</OrderLinesTotal>
<OrderLinesDiscount>string</OrderLinesDiscount>
<OrderTotal>string</OrderTotal>
<CurrencyId>0</CurrencyId>
<ExchRateId>0</ExchRateId>
</PixiReadOrderHeaderPost200TextXmlResponse>
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:pixiReadOrderHeader>
<OrderNr xsi:type="xsd:integer"></OrderNr>
<RowCount xsi:type="xsd:integer"></RowCount>
<CreateDateTo xsi:type="xsd:string"></CreateDateTo>
<UpdateDateTo xsi:type="xsd:string"></UpdateDateTo>
<CreateDateFrom xsi:type="xsd:string"></CreateDateFrom>
<OrderHeaderKey xsi:type="xsd:integer"></OrderHeaderKey>
<UpdateDateFrom xsi:type="xsd:string"></UpdateDateFrom>
<CreateAndUpdateDateTo xsi:type="xsd:string"></CreateAndUpdateDateTo>
<CreateAndUpdateDateFrom xsi:type="xsd:string"></CreateAndUpdateDateFrom>
</ns1:pixiReadOrderHeader>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadOrderHeader', [
'OrderNr' => '', // integer
'RowCount' => '', // integer
'CreateDateTo' => '', // string
'UpdateDateTo' => '', // string
'CreateDateFrom' => '', // string
'OrderHeaderKey' => '', // integer
'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);
}