JSON DOCUMENTS Export¶
The DOS WARES export utility writes transaction documents in numbered JSON transaction files. All transactions share a common data structure which is described following.
Note
Column F/S/J indicates a WARES data field (F), a synthetic field (S), or a synthetic column specific to the JSON export (J). Column S/M indicates whether a column is single-valued (S) or array multivalue (M). Column A/N refers to whether the data will be quoted string (A) or unquoted numeric (N).
RECEIPTS¶
F/S/J | JSON NAME | M/S | A/N | DICTIONARY (“value”) | COMMANDS |
---|---|---|---|---|---|
N/A | keys | ||||
N/A | documentType | S | A | “RE” | |
F | document | S | A | @ID | |
N/A | revision | S | A | “00” | |
F | status | S | A | STATUS | |
F | postDate | S | A | DATE | (D-JS) |
F | account | S | A | ACCOUNT | |
F | building | S | A | BUILDING | |
N/A | references | ||||
N/A | referenceCode | S | A | “CO” | |
F | reference | S | A | PO_NUMBER | |
N/A | referenceCode | S | A | “6A” | |
F | reference | S | A | REFERENCE | |
N/A | addresses | ||||
N/A | addressCode | S | A | “ST” | |
F | address | S | A | BUILDING (“null”) | |
N/A | addressCode | S | A | “SF” | |
F | address | S | A | CONSIGNEE (“null”) | |
N/A | addressCode | S | A | “A” | |
F | address | S | A | ACCOUNT | |
F | shipAddress | T | A | ADDRESS | |
F | contact | S | A | CONTACT | |
F | carrier | S | A | CARRIER | |
S | route | S | A | CARRIER | [XL,ADDRESSES] |
F | freightPay | S | A | FREIGHT_PAY | |
N/A | transport | S | A | “M” | |
N/A | loading | S | A | “01” | |
S | fob | S | A | CONSIGNEE | [XL,ADDRESSES] |
N/A | vehicles | ||||
N/A | vehicleCode | S | A | “TJ” | |
N/A | vehicle | S | A | VEHICLE | |
N/A | values | ||||
N/A | dateCode | S | A | “null” | |
N/A | dateTime | S | A | “null” | |
N/A | temperatureCode | S | A | “null” | |
N/A | temperature | S | A | “null” | |
N/A | quantityCode | S | A | “null” | |
N/A | quantity | S | A | “null” | |
N/A | notes | ||||
N/A | noteCode | S | A | “WHI” | |
F | note | S | A | INSTRUCTIONS (“null”) | |
N/A | noteCode | S | A | “ORI” | |
F | note | S | A | COMMENTS (“null”) |
SHIPMENTS¶
F/S/J | JSON NAME | M/S | A/N | DICTIONARY (“value”) | COMMANDS |
---|---|---|---|---|---|
N/A | keys | ||||
N/A | documentType | S | A | “SW” | |
F | document | S | A | @ID | |
N/A | revision | S | A | “00” | |
F | status | S | A | STATUS | |
F | postDate | S | A | DATE | (D-JS) |
F | account | S | A | ACCOUNT | |
F | building | S | A | BUILDING | |
N/A | references | ||||
N/A | referenceCode | S | A | “CO” | |
F | reference | S | A | PO_NUMBER | |
N/A | referenceCode | S | A | “6A” | |
F | reference | S | A | REFERENCE | |
N/A | addresses | ||||
N/A | addressCode | S | A | “SF” | |
F | address | S | A | BUILDING (“null”) | |
N/A | addressCode | S | A | “ST” | |
F | address | S | A | CONSIGNEE (“null”) | |
N/A | addressCode | S | A | “PF” | |
J | address | S | A | FREIGHT_KEY (“null”) | |
N/A | addressCode | S | A | “A” | |
F | address | S | A | ACCOUNT | |
F | shipAddress | T | A | ADDRESS | |
F | contact | S | A | CONTACT | |
F | carrier | S | A | CARRIER | |
S | route | S | A | CARRIER | [XL,ADDRESSES] |
F | freightPay | S | A | FREIGHT_PAY | |
N/A | transport | S | A | “M” | |
N/A | loading | S | A | “01” | |
S | fob | S | A | CONSIGNEE | [XL,ADDRESSES] |
N/A | vehicles | ||||
N/A | vehicleCode | S | A | “TJ” | |
N/A | vehicle | S | A | VEHICLE | |
N/A | values | ||||
N/A | dateCode | S | A | “null” | |
N/A | dateTime | S | A | “null” | |
N/A | temperatureCode | S | A | “null” | |
N/A | temperature | S | A | “null” | |
N/A | quantityCode | S | A | “null” | |
N/A | quantity | S | A | “null” | |
N/A | notes | ||||
N/A | noteCode | S | A | “WHI” | |
F | note | S | A | INSTRUCTIONS (“null”) | |
N/A | noteCode | S | A | “BOL” | |
F | note | S | A | COMMENTS (“null”) |
ADJUSTS¶
F/S/J | JSON NAME | M/S | A/N | DICTIONARY (“value”) | COMMANDS |
---|---|---|---|---|---|
N/A | keys | ||||
N/A | documentType | S | A | “AW” | |
F | document | S | A | @ID | |
N/A | revision | S | A | “00” | |
F | status | S | A | STATUS | |
F | postDate | S | A | DATE | (D-JS) |
F | account | S | A | ACCOUNT | |
F | building | S | A | BUILDING | |
N/A | references | ||||
N/A | referenceCode | S | A | “CO” | |
F | reference | S | A | PO_NUMBER | |
N/A | referenceCode | S | A | “6A” | |
F | reference | S | A | REFERENCE | |
N/A | addresses | ||||
N/A | addressCode | S | A | “LG” | |
F | address | S | A | BUILDING | |
N/A | addressCode | S | A | “A” | |
F | address | S | A | ACCOUNT | |
N/A | values | ||||
N/A | dateCode | S | A | “null” | |
N/A | dateTime | S | A | “null” | |
N/A | temperatureCode | S | A | “null” | |
N/A | temperature | S | A | “null” | |
N/A | quantityCode | S | A | “null” | |
N/A | quantity | S | A | “null” | |
N/A | notes | ||||
N/A | noteCode | S | A | “WHI” | |
F | note | S | A | INSTRUCTIONS (“null”) | |
N/A | noteCode | S | A | “ORI” | |
F | note | S | A | COMMENTS (“null”) |
TRANSACTION LINES¶
Transaction line detail corresponds exactly to lines in the lot details, as documented at TRANSACTION LINES.