Versions Compared

Old Version 3

changes.mady.by.user Alan Gilchrist

Saved on

compared with

New Version Current

changes.mady.by.user Alan Gilchrist

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Obtain

Provides the delivery status

, applicable only when the warehouse are performing the delivery.

Name Convention

API only

Limitations

Only works for items within Distribution which are generally items the warehouse are delivering.

Will only return live deliveries those with status O,C,D

for all items within the Distribution Transport system.

Service Name

2420DS

Limitations

Will only contain items where the warehouse is arranging the delivery.

2420 provides a bulk return of all consignments which are status O,C or D

2421 can provide a reply for anything in any status within the distribution system.

Last Updates

We will only show entries highlighting changes which are less than 2 years old

Date

Change

 

 

 

 

On this page :

Table of Contents
stylenone

Input Parameters

Parameter

Details

Required

CustomerCode

Customer Code which would be the stock holding customer whose stock is being delivered

Mandatory

SiteCode

Site Code for the above

 

Example Output

PDF

CSV

XML

2410 XML Specifications

Get Example

https://<pathtoapi>/service/2420DS/CustomerCode/JONES12/SiteCode/DR

Response Codes

Common response codes

Code

Message

200

Response OK

204

No delivery found for the parameters provided.

Response Example

Code Block
breakoutModewide
  <T>
        <R>
            <CCO>XYZ1234</CCO>
            <SCO>FF</SCO>
            <DRF>D1232323123</DRF>
            <ORH>234908</ORH>
            <SPH>1231445</SPH>
            <STS>Delivered</STS>
            <DTE>2024-11-22</DTE>
            <PDD>2024-11-26</PDD>
            <BDT>2024-11-26</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>
            <ESIG>JONES</ESIG>
        </R>
    </T>

XML Element Details

XML Segment

XML API Element

Description

Format or Potential Output Options

<T>

<R>

<CCO>

Customer Code

<SCO>

Site Code

<DRF>

Document Ref

<ORH>

Order UID

<SPH>

Pick UID

<STS>

Consignment Status

(P) Pending OR
(O) Outstanding OR
(C) Despatched OR
(D) Delivered OR
(X)Cancelled OR
(I) Invoiced

<DTE>

Consignment Date

<PDD>

Planned delivery date

<BDT>

Requested Booked date

2016-12-

23T00:00:00

23

<CDP>

Confirmed departed at

2016-12-23T07:05:23

<CDL>

Confirmed delivered at

2016-12-23T12:26:03

<OEF>

Original ETA window from time (ePOD users only)

11:00:00

<OET>

Original ETA window to time (ePOD users only)

11:45:00

<REF>

Revised ETA window from time (ePOD users only)

13:00:00

<RET>

Revised ETA window to time (ePOD users only)

13:45:00

<ESIG>

Electronic Signatory Name (ePOD users only)

</R>

</T>