Versions Compared

Old Version 3

changes.mady.by.user Alan Gilchrist

Saved on

compared with

New Version 4

changes.mady.by.user Alan Gilchrist

Saved on

Key

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

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

  • Transfer order which is considered complete when the transfer takes place

  • Collection from warehouse which is considered complete when an order is collected

  • Deliveries by the warehouse which is considered complete when the order is pick confirmed.

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.

Name Convention

API Only

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

Last Updates

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

Date

Change

 

 

 

 

Example Output

PDF

CSV

XML

2310 XML Specifications

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>

Introduction

The purpose of this service is to provide the live order status for a given reference of ours.

Parameters

Parameter

Details

Required

OrderUID

Our order UID

Mandatory

Postcode

The postcode for the OrderUID above

Mandatory

Example

http://<pathtoapi>/service/OrderStatus/OrderUID/123456/Postcode/CM15%200LB

Response

Sample

Code Block
<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.