Versions Compared

Old Version 5

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

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.

Service Name

Convention

API Only

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

Contents of this page :

Table of Contents
stylenone

Last Updates

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

Date

Change

 

 

 

 

Example Output

Input Parameters

PDF

Parameter

CSV

Details

XML

Required

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

CustCode

Customer Code

Mandatory

SiteCode

Site Code

Mandatory

DocRef

Document Reference

Mandatory

Get Example

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

Response

2330OS/CustCode/ABC123/SiteCode/RR/DocRef/123456

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

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>
            <STS>PICK COMPLETE</STS>
            <DM>CARR</DM>
            <PCNO>2313164646984</PCNO>
            <PCDD>25/07/2024</PCDD>
            <COK>YES</COK>
            <CCO>DPD LOCAL</CCO>
       </R>
</T>

XML Element Details

Description

T

Table of results

R

Order/pick record - can repeat

CCO

XML Segment

XML API Element

Length

Notes

<T>

<R>

Will repeat for each order

<CCO>

Customer code - Your warehouse account reference

SCO

<SCO>

Site code - The site code where your account is based at the warehouse

DRF

<DRF>

Document reference - Your reference for the order

ORH

<ORH>

Order UID - The warehouse reference for your order

SPH

<SPH>

Pick UID - The warehouse pick reference for the order

PCF

<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?

R

T

Response Codes

Common response codes

Code

Message

200

Order found and response prepared successfully.

204

No order found for the parameters provided.

 

<STS>

Cancelled
Held by VCIS user
User held
System held
Awaiting approval
Pre-pick planning
Awaiting pick
Pick planned
Pick prepared
eFulfillment Pick Prepared
Pick complete
Awaiting Despatch
Collected or despatched

<DM>

Delivery Method

  • Warehouse arranged

  • Collection from warehouse

  • Connected Parcel Carrier

<PCNO>

Parcel Carrier Consignment No

<PCDD>

Parcel Carrier despatch date

<COK>

Ready for Collection

<CCO>

Collection Company

</R>

</T>