Introduction
The purpose of this service is to provide new and 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/NewAndHeldOrders/CustomerCode/XYZ/SiteCode/AB
Response
Sample
<NewAndHeldOrders>
<HD>
<CustC>TEST</CustC>
<CustN>Test comp LTD</CustN>
<OrdRef>7</OrdRef>
<DocRef>PRED8116</DocRef>
<DName>GDPR ERASED</DName>
<DPost>SW20 0QU</DPost>
<OrdDt>2012-04-26T00:00:00</OrdDt>
<Cases>11</Cases>
<Singles>0</Singles>
<DefCust>TEST</DefCust>
</HD>
<HD>
<CustC>TEST</CustC>
<CustN>Test comp LTD</CustN>
<OrdRef>53</OrdRef>
<DocRef>53</DocRef>
<DName>Corsham (A1)</DName>
<DPost>SN13 9PP</DPost>
<OrdDt>2012-05-07T05:50:44.443</OrdDt>
<Cases>1</Cases>
<Singles>0</Singles>
<DefCust>TEST</DefCust>
</HD>
</NewAndHeldOrders>
| Segment | Segment L1 | Segment | Field Description |
|---|---|---|---|
| NewAndHeldOrders | |||
| 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 | ||
| DefCust | Deferment customer | ||
| HD | |||
| NewAndHeldOrders |
Response Codes
| Code | Message |
|---|---|
| 200 | Order found and response prepared successfully. |
| 204 | No order found for the parameters provided. |