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

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

Input Parameters

Parameter	Details	Required
CustomerCode		Mandatory
SiteCode		Mandatory
DocRef		Mandatory

Get Example

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

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

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

XML Element Details

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?
	<STS>		Cancelled Held by VCIS user User held System held Awaiting approval Awaiting approval Pre-pick planning 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

</R>
</T>

Date	Change

2330 Order Status (API)

Last Updates

Input Parameters

Get Example

Response Codes

Response Example

XML Element Details