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)

		}

}



Returns with:

{

	"code" : integer

	,"message" : text

	,"order" :

		{

			"code" : integer

			,"message" : text

			,"info" : contains basic order data

				[

					"info" : integer (Unique Order ID)

					,"number" : text (corresponds to order number)

					,"date" : order date (d/m/y)

					,"prediction" : delivery forecast date (depends on carrier return)

					,"iderp" : order ID number in the origin ERP (if provided)

					,"warnings" : return order warnings

				]

			,"deliveryTo" : (dataset sent in put/order)

			,"shippment" : 

				{

					"nick" : carrier name/nickname

					,"method" : shipping method (ex: PAC/SEDEX)

					,"vol" : volume quantity

					,"tracker": SRO or order code with carrier

					,"trackerurl" : Enivix URL for order tracking

					,"url" : Actual carrier URL (depends on configuration)

				}	

			,"wharehouse" : (informed in put/order)

			,"items" : (dataset sent in put/order)

            ,"summarybyvolume": [

            	{

            	   "tracking": volume identifier,

            	   "vol": sequential volume number,

            	   "created": volume creation date/time,

            	   "deliveryforecast": delivery forecast d/t,

            	   "outfordelivery": out for delivery d/t,

            	   "intransit": in transit d/t,

            	   "delivered": delivery d/t,

            	   "deliveryfailure": delivery failure d/t

                },

			,"internalevents" : 

				{

					"created": d/t logical record creation

					,"os": d/t order insertion in wms

					,"withoutBalance": indicates SKUs with no balance available to fulfill the order

					,"invoice": d/t invoice reception

					,"startPicking": d/t picking start

					,"endPicking": d/t picking end

					,"startCheckout": d/t checkout start

					,"endCheckout": d/t checkout end

					,"dispatched": d/t shipment

					,"in_transit": d/t in transit

					,"out_for_delivery": d/t out for delivery

					,"delivered": d/t delivery

					,"fail": d/t delivery failure

					,"cancelled" : d/t order cancellation (in OMS)

					,"volume" : volume number to be related to volume summary

				}

			,"shippingevents": logistics events list

				[{

					"code" : varchar(20) – event code at carrier (see micro status table)

					,"message" : text – raw information received by the carrier

					,"detalhe": text – raw information received by the carrier

					,"complement" : text - info complement

					,"dtshipping" : date/time of event generation at carrier

					,"internalcode" : integer – macro code of the event in Enivix (see macro status table)

				}]

			,"invoice": fiscal invoice information

				{

					"number" : fiscal invoice number

					,"series" : fiscal invoice series

					,"emission" : emission date

					,"weight" : invoice weight

					,"volumeS" : volume quantity

					,"value" : invoice value

					,"key" : electronic key

					,"document" : base64 of original xml/nfe

				}

			,"resend": original document data (in case of resend)

				{

					"id" : document id 

					,"order" : order number 

					,"inserted" : d/t of document inclusion 

					,"situation" : document status 

					,"by" : generated by 

				}

			,"wms" : data returned by WMS

				{

					"weight" : weight in grams

					,"weightm3" : cubed weight

					,"volumes" : calculated volumes

				}

		}

}



code

200: request fulfilled, see order->code TAG

404: ID not found

500: invalid auth



order->code: (macro status table)

1: order received (digitally)

3: awaiting wms (registered but not committed in WMS)

5: awaiting picking (committed in WMS awaiting picking)

8: awaiting invoice

9: good to go

10: digital picking performed

13: order cancelled

20: checkout

25: invoice received

28: tracking received (via client)

30: order picked for checkout

50: dispatched (picking completed, awaiting collection)

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