2411 API Get
- Joe Wagner
- Alan Gilchrist
- Harish Kushwah
Introduction
The purpose of this service is to provide the live delivery 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 |
Postcode | The postcode for the Document Reference above | Mandatory |
Example
Response
Sample
<T>
<R>
<STS>Delivered</STS>
<BDT>2016-12-23T00:00:00</BDT>
<CDP>2016-12-23T07:05:23</CDP>
<CDL>2016-12-23T13:26:03</CDL>
<OEF>11:00:00</OEF>
<OET>11:45:00</OET>
<REF>13:00:00</REF>
<RET>13:45:00</RET>
<ATD>2016-12-23T13:22:59</ATD>
</R>
</T>Details
Description | Example | |||
|---|---|---|---|---|
T | Table of results | |||
R | Delivery record - can repeat | |||
STS | Status | Delivered | ||
BDT | Booked date | 2016-12-23T00:00:00 | ||
CDP | Confirmed departed at | 2016-12-23T07:05:23 | ||
CDL | Confirmed delivered at | 2016-12-23T12:26:03 | ||
OEF | Original ETA window from time | 11:00:00 | ||
OET | Original ETA window to time | 11:45:00 | ||
REF | Revised ETA window from time | 13:00:00 | ||
RET | Revised ETA window to time | 13:45:00 | ||
ATD | Actual time of delivery | 2016-12-23T13:22:59 | ||
R | ||||
T |
Response Codes
Code | Message |
|---|---|
204 | No delivery found in the live system for the parameters provided, if this is not a current delivery then it may have been archived. |
204 | No delivery 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.