WARES JSON Orders Exchange¶

WARES can respond with either Order or Shipment documents when an order is shipped. A response order will contain all filled data elements including entries generated by the warehouse, so this response is documented first to present the complete order data specification.

ORDER Response Data Elements¶

Label	Description	M/O	Datatype	By	When
documentKey	Sequential document identifier	M	Numeric	Whse	Resp
status	Processing status code	M	Numeric	Whse	Resp
postDate	Document received date	M	Date	Whse	Resp
account	Warehouse customer identifier	M	String	Whse	Order
source	Customer tracking source	O	String	Cust	Order
referenceCode	“6A”	O	String	Whse	Order
reference	Customer’s sales order number	M	String	Cust	Order
referenceCode	“CO”	O	String	Whse	Order
poNumber	Consignee purchase order no.	O	String	Cust	Order
carrier	Customer/warehouse carrier SCAC	O	String	Cust	Order
route	Customer carrier text	O	Text	Cust	Order
freightPay	Pay Code “PP”, “CC”, or “TP”	M	String	Cust	Order
receiveName	Warehouse data file reference	M	String	Whse	Resp
shipment	Whse shipment (BOL) identifier	M	Numeric	Whse	Resp
dateCode	“10”	O	String	Whse	Order
dateShip	Requested shipment date	M	Date	Cust	Order
dateCode	“02”	O	String	Whse	Order
dateDeliver	Requested delivery date	O	Date	Cust	Order
dateCode	“01”	O	String	Whse	Order
dateCancel	Cancel if not shipped date	O	Date	Cust	Order
noteCode	“WHI”	O	String	Whse	Order
instructions	Customer message to warehouse	O	Text	Cust	Order
noteCode	“BOL”	O	String	Whse	Order
comments	Statement for Bill of Lading	O	Text	Cust	Order

addressType	“ST”	M	String	Cust	Order
addressKey	Identifier for consignee addr.	M	String	Cust	Order
addressName	Ship to address name	M	Text	Cust	Order
addressStreet	Ship to street address (\n)	M	Text	Cust	Order
addressCity	Ship to city (domestic)	C	String	Cust	Order
addressState	Ship to state (domestic)	C	String	Cust	Order
addressZip	Ship to ZIP (domestic)	C	String	Cust	Order
addressPhone	Ship to phone	O	Text	Cust	Order
addressContact	Ship to contact	O	Text	Cust	Order
addressType	“PF”	O	String	Cust	Order
addressKey	Freight Payor identifier (TP)	O	String	Cust	Order
addressName	Freight payor address name	O	Text	Cust	Order
addressStreet	Freight payor street (\n)	O	Text	Cust	Order
addressCity	Freight payor city (domestic)	C	String	Cust	Order
addressState	Freight payor state (domestic)	C	String	Cust	Order
addressZip	Freight payor ZIP (domestic)	C	String	Cust	Order
addressPhone	Freight payor phone	O	Text	Cust	Order
addressContact	Freight payor contact	O	Text	Cust	Order

lineKey	Sequential line identifier	M	Numeric	Whse	Resp
stockNumber	Product/Variety identifier	M	String	Cust	Order
alternateId	UPC/Consignee product code	O	String	Cust	Order
product	Warehouse internal product code	M	String	Whse	Resp
control	Customer/Warehouse lot code	O/M	String	Both	Both
description	Customer product description	O	Text	Cust	Order
orderUom	Customer order unit of measure	M	String	Cust	Order
orderQty	Customer order quantity	M	Numeric	Cust	Order
packageUom	Warehouse pick/ship UOM	M	String	Whse	Resp
packageQty	Warehouse order quantity	M	Numeric	Whse	Resp
backorderQty	Warehouse backorder quantity	O	Numeric	Whse	Resp
canceledQty	Warehouse cancel quantity	O	Numeric	Whse	Resp
shippedQty	Warehouse shipped quantity	M	Numeric	Whse	Resp
optionalQty	Customer optional qty data	O	Numeric	Cust	Order
optionalValue	Customer optional value data	O	Numeric	Cust	Order

Note

Mandatory/Optional (M/O) indicates whether a data element is required or can be omitted in either the original order or the warehouse response. Some elements are conditional (C), as with addresses which may be either domestic or foreign. Only domestic addresses use City/State/ZIP elements.
Code elements (referenceCode, dateCode, noteCode) are used to distinguish the meaning of following values. Currently code elements may be omitted because the subsequent values are associated with unique database entries. (This may change in future versions of WARES.) Code values may seem odd, as they conform to EDI X12 standards. (WARES supports EDI data exchange as well as JSON.)
FreightPay codes are either PP (prepaid), CC (Collect), or TP (Third Party). When using third-party freight payment, a freight payment address (code PF) should be provided in the Addresses section. Otherwise the freight payment address should be omitted.
Some elements are typed as Text instead of String. These elements may contain escape sequences such as newline (\n), while WARES does not expect escape sequences in simple strings.

JSON Sample Files¶

Download a JSON customer orders file for an example of 14 orders originating from the customer.

Download a JSON warehouse response file to see the warehouse response to the same 14 orders.

Customer Order Data Elements¶

A customer order would contain a subset of the data elements in the warehouse response, as most elements which originate with the warehouse would be omitted. The resulting data specification is listed following.

Label	Description	M/O	Datatype	By	When
postDate	Document transmitted date	M	Date	Whse	Resp
account	Warehouse customer identifier	M	String	Whse	Order
source	Customer tracking source	O	String	Cust	Order
reference	Customer’s sales order number	M	String	Cust	Order
poNumber	Consignee purchase order no.	O	String	Cust	Order
carrier	Customer/warehouse carrier SCAC	O	String	Cust	Order
route	Customer carrier text	O	Text	Cust	Order
freightPay	Pay Code “PP”, “CC”, or “TP”	M	String	Cust	Order
dateShip	Requested shipment date	M	Date	Cust	Order
dateDeliver	Requested delivery date	O	Date	Cust	Order
dateCancel	Cancel if not shipped date	O	Date	Cust	Order
instructions	Customer message to warehouse	O	Text	Cust	Order
comments	Statement for Bill of Lading	O	Text	Cust	Order

addressType	“ST”	M	String	Cust	Order
addressKey	Identifier for consignee addr.	M	String	Cust	Order
addressName	Ship to address name	M	Text	Cust	Order
addressStreet	Ship to street address (\n)	M	Text	Cust	Order
addressCity	Ship to city (domestic)	C	String	Cust	Order
addressState	Ship to state (domestic)	C	String	Cust	Order
addressZip	Ship to ZIP (domestic)	C	String	Cust	Order
addressPhone	Ship to phone	O	Text	Cust	Order
addressContact	Ship to contact	O	Text	Cust	Order
addressType	“PF”	O	String	Cust	Order
addressKey	Freight Payor identifier (TP)	O	String	Cust	Order
addressName	Freight payor address name	O	Text	Cust	Order
addressStreet	Freight payor street (\n)	O	Text	Cust	Order
addressCity	Freight payor city (domestic)	C	String	Cust	Order
addressState	Freight payor state (domestic)	C	String	Cust	Order
addressZip	Freight payor ZIP (domestic)	C	String	Cust	Order
addressPhone	Freight payor phone	O	Text	Cust	Order
addressContact	Freight payor contact	O	Text	Cust	Order

lineKey	Sequential line identifier	M	Numeric	Whse	Resp
stockNumber	Product/Variety identifier	M	String	Cust	Order
alternateId	UPC/Consignee product code	O	String	Cust	Order
control	Customer/Warehouse lot code	O	String	Both	Both
description	Customer product description	O	Text	Cust	Order
orderUom	Customer order unit of measure	M	String	Cust	Order
orderQty	Customer order quantity	M	Numeric	Cust	Order
optionalQty	Customer optional qty data	O	Numeric	Cust	Order
optionalValue	Customer optional value data	O	Numeric	Cust	Order

Note

Where Whse appears in the By column, the warehouse response document will overwrite data sent by the customer.

Sample Customer Order¶

Following is a sample customer order to the warehouse.

[

{
   "postDate": "2003-01-12TZ",
   "account": "BMC",
   "source": "server1",
   "references": [
     {
       "referenceCode": "6A",
       "reference": "6733"
     },
     {
       "referenceCode": "CO",
       "poNumber": "6852"
     }
   ],
   "carrier": "SUXP",
   "freightPay": "PP",
   "dateCodes": [
     {
       "dateCode": "10",
       "dateShip": "2002-01-15TZ"
     },
     {
       "dateCode": "02",
       "dateDeliver": "2002-01-17TZ"
     },
     {
       "dateCode": "01",
       "dateCancel": "2002-01-21TZ"
     }
   ],
   "notes": [
     {
       "noteCode": "WHI",
       "instructions": null
     }
   ],
   "addresses": [
     {
       "addressType": "ST",
       "addressKey": "10017",
       "addressName": "Pitch Pipes Refinery, Inc.",
       "addressStreet": "5270 Industrial Boulevard\\nSuite 401",
       "addressCity": "Lubbock",
       "addressState": "TX",
       "addressZip": "79411",
       "addressPhone": "8065554411"
     }
   ],
   "detail": [
     {
       "lineKey": "001",
       "stockNumber": "BMC001",
       "description": "21x13x08 single white KDC",
       "orderUom": "BD",
       "orderQty": 2
     },
     {
       "lineKey": "002",
       "stockNumber": "BMC002",
       "description": "14x12x21 single brown KDC",
       "orderUom": "BD",
       "orderQty": 3
     },
     {
       "lineKey": "003",
       "stockNumber": "BMC003",
       "description": "18x16x24 double brown KDC",
       "orderUom": "BD",
       "orderQty": 4
     }
   ]
}

]

Table Of Contents

Previous topic

Next topic

This Page

WARES JSON Orders Exchange¶

ORDER Response Data Elements¶

JSON Sample Files¶

Customer Order Data Elements¶

Sample Customer Order¶