2311 API Get
Introduction
The purpose of this service is to provide the live order status for a given reference of your own.
Parameters
Parameter | Details | Required |
---|---|---|
CustomerCode | The Customer Code of the account | Mandatory |
SiteCode | The Site Code of the account | Mandatory |
DocRef | Document Reference (your reference) | Mandatory |
Example
http://<pathtoapi>/service/OrderStatusByDocRef/CustomerCode/XYZ/SiteCode/AB/DocRef/ORD001
Response
Sample
<T> <R> <CCO>ABC123</CCO> <SCO>ZZ</SiteCode> <DRF>SO123456789</DRF> <ORH>912345678</ORH> <SPH>812345679</SPH> <PCF>true</PCF> <MST>Delivered</MST> <PDD>2016-12-23</PDD> <FT1>10:00</FT1> <TT2>12:00</TT2> <FT2>11:00</FT2> <TT2>13:00</TT2> <ATD>2016-12-23T13:22:59</ATD> <POD>true</POD> </R> </T>
Details
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 /wiki/spaces/VEDI/pages/128912145? | ||
R | |||
T |
Response Codes
Common response codes
Code | Message |
---|---|
200 | Order found and response prepared successfully. |
204 | No order found for the parameters provided. |
Copyright Ontech Solutions 2017-2024. All rights reserved, no part may be replicated or distributed without the express permission of the owner.