Objective: Search order status (detailed with transport information)
JSON Composition for sending:
{
*"auth" : key obtained in get/auth method
*,"order" : {
"id" : unique order identification returned by put/order
,"number" : order number (optional parameter if id is used)
,"invoicenumber": can use invoice number plus series (ex: 123456-0), mandatory - [number]-[series]
}
}
Returns with:
{
"code" : integer
,"message" : text
,"order" : {
"code" : integer
,"message" : text
,"info" : contains basic order data
[
"info" : integer (Unique Order ID)
,"number" : text (order number)
,"date" : order date (d/m/y)
,"prediction" : delivery forecast date (depends on carrier return)
,"iderp" : returns id from client ERP (when available)
,"note" : returns observations provided by cliente
,"warnings" : return order warnings
]
,"deliveryTo" : (dataset sent in put/order)
,"shippment" :
{
"nick" : carrier name/nickname
,"method" : shipping method (ex: PAC/SEDEX)
,"vol" : number of volumes
,"tracker": SRO or order code with carrier
,"trackerurl" : Enivix URL for order tracking
,"url" : Actual carrier URL (depends on configuration)
}
,"warehouse" : (informed in put/order)
,"items" : (array object of items)
[
{
"sku" : item SKU
,"item" : item sequence
,"name" : description
,"amount" : quantity
,"unity" : unit
,"part" : batch identification
,"cubedWeight" : cubed weight
,"serial" : text vector with serial numbers
}
]
,"internalevents" :
[
{
"created": d/h logical record creation
,"os": d/h order insertion in wms
,"invoice": d/h invoice reception
,"startPicking": d/h picking start
,"endPicking": d/h picking end
,"startCheckout": d/h checkout start
,"endCheckout": d/h checkout end
,"dispatched": d/h shipment
,"in_transit": d/h in transit
,"out_for_delivery": d/h out for delivery
,"delivered": d/h delivery
,"fail": d/h delivery failure
,"cancelled" : d/h order cancellation (in OMS)
,"final" : d/h of last update
}
]
,"shippingevents":
[
{
"code" : varchar(20) – event code at carrier (see micro situation table)
,"message" : text – raw information from carrier
,"detalhe": text – raw information from carrier
,"complement": text - info complement
,"dtshipping" : date/time of event generation at carrier
,"internalcode" : integer – macro code of the event in Enivix (see macro situation table)
}
]
,"invoice":
[
{
"number": fiscal document number
,"series": document series
,"emission": d/h of emission
,"weight": gross weight
,"volumes": quantity of volumes
,"value": invoice value
,"key": fiscal key
,"document": NFe XML base64
}
]
,"resend": {
"id": original order ID
,"order": original order number
,"inserted": original order insertion date/time
,"situation": reason for resending
,"by": email of the user who generated the resend
}
,"wms":{
"weight": order weight,
,"weightm3": order cubed weight,
,"volumes": number of volumes
}
}
Code:
200: request fulfilled, see TAG order->code
404: ID not found
500: invalid auth
order->code: (macro situation table)
1: order received
3: waiting for wms
5: waiting for picking
7: wms integrated
8: waiting for invoice
10: digital picking performed
20: physical picking performed
25: invoice received
30: order picked for checkout
40: checkout performed
50: dispatched
60: collected by carrier
70: in transit
75: out for delivery
80: occurrence with the order
90: delivered to recipient
100: delivery failed
110: order refused
200: order cancelled
300: order returned to origin
400: order lost
411: cargo theft