Create receiving order

POST {{fulfillment_client_url}}/warehouse/order

Save the information of an order, recieve the shipping type, the information of the products and his variants, and the boxes with the quantity of the products that must contain (referenced by its ecartId).

Body definition

name	Type	Description	Required
shippingType	String	the method to ship the order	true
products	Array	List of products that include the order	true
boxes	Array	List of boxes that include the order	true
warehouseId	Integer	id of the warehouse that should prepare the order	true
shippingDate	Timestamp	The date that the order should be shipped	true

Products

this are the fields that include the objects in the products array

name	Type	Description	Required
ecartId	Integer	Identifier of the ecart account	false
sku	String	Identifier of the product inside the shop, for reference of the client	false
description	String	Description of the product	false
name	String	Name of the product	true
currency	String	Currency that use the shop	true
productType	String	type of the product	false
price	Decimal	price of the product	true
length	Decimal	length of the product	true
width	Decimal	with of the product	true
height	Decimal	height of the product	true
weight	Decimal	weight of the product	true
imageUrl	String	image of the product	true
variants	Array	The variants of this products that differ by some characteristics	true

The variants of the product contain the fields of ecartId, sku, name, currency, price, length, width, height and weight with the same validations.

Boxes

this are the fields that include the objects in the boxes array

name	Type	Description	Required
trackingNumber	Integer	The id of the box to update	false
products	Array	list of products that are include in this box	true

Each product in the in the array of boxes contains ecartId and amount. Note that the ecartId has to be one of the products includes in the array of the main object.

Request Body

{"shopId"=>1, "shippingType"=>"Parcel", "products"=>[{"ecartId"=>"2433", "sku"=>"123", "description"=>"desc1", "currency"=>"MXN", "productType"=>nil, "price"=>"328.70", "variants"=>[{"ecartId"=>"2498", "sku"=>"1-123", "name"=>"20.5 x 20.5 x 19.4 cm | 23ECTs / 25 Piezas / Default", "currency"=>nil, "price"=>"297.15", "length"=>1, "width"=>1, "height"=>1, "weight"=>"9", "unitForSize"=>"cm", "unitForWeight"=>"kg"}, {"ecartId"=>"2497", "sku"=>"2-123", "name"=>"20 x 15 x 12 cm | 26ECTs / 25 Piezas / Default", "currency"=>nil, "price"=>"240.92", "length"=>1, "width"=>1, "height"=>1, "weight"=>"6"}], "length"=>1, "width"=>1, "height"=>1, "weight"=>1, "imageUrl"=>"https://cdn.shopify.com/s/files/1/0015/6090/3792/products/Caja-de-carton-33.5-x-26-x-25.5_12157078-907e-4ba2-90ac-21cb6405a1d8.jpg?v=1576862213", "shopId"=>1}, {"ecartId"=>"2734", "sku"=>"456", "description"=>"desc2", "currency"=>"MXN", "productType"=>nil, "price"=>"328.70", "variants"=>[{"ecartId"=>"2799", "sku"=>"1-456", "name"=>"20.5 x 20.5 x 19.4 cm | 23ECTs / 25 Piezas / Default", "currency"=>nil, "price"=>"297.15", "length"=>1, "width"=>1, "height"=>1, "weight"=>"9"}, {"ecartId"=>"2798", "sku"=>"2-456", "name"=>"20 x 15 x 12 cm | 26ECTs / 25 Piezas / Default", "currency"=>nil, "price"=>"240.92", "length"=>1, "width"=>1, "height"=>1, "weight"=>"6"}], "length"=>1, "width"=>1, "height"=>1, "weight"=>1, "imageUrl"=>"https://cdn.shopify.com/s/files/1/0015/6090/3792/products/Caja-de-carton-33.5-x-26-x-25.5_12157078-907e-4ba2-90ac-21cb6405a1d8.jpg?v=1576862213", "shopId"=>1}], "boxes"=>[{"fulfillmentShipmentId"=>nil, "products"=>[{"ecartId"=>"2498", "amount"=>"7"}, {"ecartId"=>"2497", "amount"=>"4"}], "comment"=>""}, {"fulfillmentShipmentId"=>nil, "products"=>[{"ecartId"=>"2799", "amount"=>"12"}, {"ecartId"=>"2798", "amount"=>"15"}], "comment"=>""}], "warehouseId"=>1, "shippingDate"=>"2020-03-19 19:52:00"}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string

RESPONSES

status: OK

{&quot;orderId&quot;:3,&quot;fileUrl&quot;:&quot;https://fulfillment-stage.s3.us-east-2.amazonaws.com/orders/Receive-order-invoice-3.pdf&quot;}