Introduction
The purpose of this service is to provide held orders.
See Service for information about request limit
Parameters
| Parameter | Details | Required |
|---|---|---|
| CustomerCode | The Customer Code of the account | Mandatory |
| SiteCode | The Site Code of the account | Mandatory |
Example
https://<pathtoapi>/service/HeldOrders/CustomerCode/XYZ/SiteCode/AB
Response
Sample
<HeldOrders>
<HD>
<CustC>GDPR</CustC>
<CustN>GDPR Esd</CustN>
<OrdRef>325</OrdRef>
<DocRef>1234</DocRef>
<DName>LONDON CITY</DName>
<DPost>RM18 7NN</DPost>
<OrdDt>2012-08-31T00:00:00</OrdDt>
<Cases>2</Cases>
<Singles>2</Singles>
<LD>
<PCode>002641</PCode>
<PDesc>YQUEM 1986 12X75</PDesc>
<PckDesc>12x0.75 1986 Per Pallet 1</PckDesc>
<Rtn>09/D001915</Rtn>
<Cases>1</Cases>
<Singles>1</Singles>
<INS>0</INS>
</LD>
<LD>
<PCode>006484</PCode>
<PDesc>COS D'ESTOURNEL 2005</PDesc>
<PckDesc>12x0.75 2005 Per Pallet 1</PckDesc>
<Rtn>12/0028964</Rtn>
<Cases>1</Cases>
<Singles>1</Singles>
<INS>1</INS>
</LD>
</HD>
</HeldOrders>
| Segment | Segment L1 | Segment | Segment L3 | Field Description |
|---|---|---|---|---|
| HeldOrders | Held orders | |||
| HD | Herder element | |||
| CustC | Customer code | |||
| CustN | Customer name | |||
| OrdRef | Order reference | |||
| DocRef | Document reference | |||
| DName | Delivery name | |||
| DPost | Delivery postcode | |||
| OrdDt | Order date | |||
| Cases | Cases | |||
| Singles | Singles | |||
| LD | Line element | |||
| PCode | Product code | |||
| PDesc | Product description | |||
| PckDesc | Package description | |||
| Rtn | Rotation number | |||
| Cases | Cases | |||
| Singles | Singles | |||
| INS | is Insufficient stock? (bit) | |||
| LD | ||||
| HD | ||||
| HeldOrders |
Response Codes
| Code | Message |
|---|---|
| 200 | Order found and response prepared successfully. |
| 204 | No order found for the parameters provided. |