Overview | The purpose of this service is to provide the live order status for a given warehouse reference All stock orders will show an order status however there are three key types
If you are looking to confirm orders for invoicing you should look at the order pick confirmation which is a consistent point (also the duty point) for the order as the status not definitive and can be rolled back. | |
Service Name | 2330OS | |
Limitations | Fields from MST onwards are only available if the warehouse are performing the delivery for any collections this information will be missing as they will not be known 2330 - will display all orders which have not been marked as despatched/collected, and if completed then will remain on the output for no more than 7 days. 2331 - you can request the status of any order irrespective of status |
Input Parameters
Parameter | Details | Required | |
---|---|---|---|
OrderUID | Our order UIDCustomerCode | Mandatory | |
SiteCode | Mandatory | ||
Postcode | The postcode for the OrderUID aboveDocRef | Mandatory |
Get Example
http://<pathtoapi>/service/2330OS/OrderUID/123456/Postcode/CM15%200LB
Response Codes
Common response codes
Code | Message |
---|---|
200 | Order found and response prepared successfully. |
204 | No order found for the parameters provided. |
Response Example
Sample
|
XML Element Details
R
XML Segment | XML API Element | Length | Notes | |
<T> | ||||
<R> | Will repeat for each order | |||
<CCO> | Customer code - Your warehouse account reference | |||
<SCO> | Site code - The site code where your account is based at the warehouse | |||
<DRF> | Document reference - Your reference for the order | |||
<ORH> | Order UID - The warehouse reference for your order | |||
<SPH> | Pick UID - The warehouse pick reference for the order | |||
<PCF> | Pick confirmed - Have the warehouse finished the pick? | </R> | ||
</T> |
Description
T
Table of results
R
Order/pick record - can repeat
CCO
Customer code - Your warehouse account reference
SCO
Site code - The site code where your account is based at the warehouse
DRF
Document reference - Your reference for the order
ORH
Order UID - The warehouse reference for your order
SPH
Pick UID - The warehouse pick reference for the order
PCF
Pick confirmed - Have the warehouse finished the pick?
MST
Delivery manifest status
PDD
Planned delivery date
FT1
Original ETA window from time
TT1
Original ETA window to time
FT2
Revised ETA window from time
TT2
Revised ETA window to time
ATD
Actual time of delivery - includes both the date and time
POD
Is the POD ready to be requested using 3. POD?
<STS> | Cancelled | ||
<DM> | Delivery Method
| ||
<PCNO> | Parcel Carrier Consignment No | ||
<PCDD> | Parcel Carrier despatch date | ||
</R> | |||
</T> |