Outbound Orders

Inbound Orders are the ones with goods that will be added to your stock, they can be regular Outbound Orders (Operation 1), Stock Adjustment (Unavailable) Orders (Operation 6) or Stock Adjustment Orders (Operation 8).

Orders can be created through our Orders endpoint, the request should look something like this:

[
  {
    "relationalOrderCode": "4657812",
    "relationalLogisticOperationId": "171", 
    "subOperation": "FOOD", 
    "relationalEntityId": "5413", 
    "operation": 1, 
    "typing": "2022-03-28T19:46:59.376Z",
    "whoTyped": "John Doe",
    "orderItems": [
      {
        "relatedProductId": "5487",
        "quantity": 10,
        "itemNumber": 1,
      }
    ]
  }
]

These are the mandatory fields to create an Order, you can see all fields below.

All Fields

Name	Description	Req.	Default value
relationalOrderCode	Document Id in origin system.	Yes
relationalLogisticOperationId	Logistics Operation Id in origin system.	Yes
operation	2 for regular Inbound Orders and 7 for LeftOvers.	Yes
subOperation	Order's suboperation, can be any value, e.g. Purchase, Transfer.	Yes
reasonSubOperation	Reason for suboperation, can be any value.	No
relationalEntityId	Customer or Logistics Operation Id in origin system depending if it's a LeftOvers Order or not.	Yes
typing	Creation date in origin system.	Yes
whoTyped	Who created the Order, can be any value.	Yes
orderOrigin	Order's Origin, can be any value.	No	Can be configured in WMS
relationalCarrierCode	Carrier Id in origin system	No
orderObservation	Notes on Order, can be any value.	No
relationalTitleCode	Invoice Id in origin system.	No
invoiceNumber	Invoice Number (Brazil Only).	No
invoiceSeries	Invoice Series (Brazil Only).	No
orderItems	Order Items, see here.	Yes
relationalRecipientCode	Recipient Id in origin system.	No
deliveryAddressTypeId	Delivery address type, e.g. Resiential, Commercial.	No
deliveryDistrict	Delivery address district.	No
deliveryZipCode	Delivery address ZipCode.	No
deliveryAddress	Delivery street address.	No
deliveryAddressComplement	Delivery street address complement.	No
deliveryCity	Delivery address city.	No
deliveryStateAcronym	Delivery state acronym, e.g. RJ.	No
deliveryDays	Estimated delivery in days.	No
receiver	The recipient.	No
documentuser	A identifier of the recipient.	No
documentObservation	The recipient document type, can be any value, e.g. ID.	No
receiverphone	The recipient phone number.	No
deliveryOrderNote	A note to the packing list.	No
formOfPayment	Payment method, e.g. Card, Cash.	No
dueDate	Expected shipment date.	No
deadline	Maximum delivery date.	No
urgentOrder	1 If the order has priority on picking, 0 if not.	No
printInvoice	True if the invoice should be printed in WMS.	No	false
descriptionShiftDelivery	Can be any value, used to group and prioritize.	No
descriptionRegionDelivery	Can be any value, used to group and prioritize.	No
channel	Can be any value, used to group and prioritize.	No
deliveryRoute	Delivery route.	No
obsPreGrade	Note to be printed within the picking list.	No.

Order Items

Name	Description	Req.
relatedProductId	Product Id in origin system.	Yes
quantity	Product Quantity.	Yes
itemNumber	Item number in inbound document.	Yes
itemNote	Notes on Item within the inbound document.	No
minimumValidity	Minimum validity in days.	No
variableQuantity	Variable quantity.	No
standardMeasure	Default measure.	No
itemInventoryNote	Notes on Item to check during the inbound.	No
orderItemVolumeLots	Expected batch during inbound, see here.	No

Batch volumes

Name	Description	Req.
originLot	Lot to sort.	Yes
quantity	Lot quantity.	Yes
validityOrigin	Lot expiration date.	Yes
manufacturingDate	Manufacturing date.	No
itemLotNote	Lot notes, can be any value.	No
relatedOriginClassification	Lot Classification Id in origin system.	No
variableQuantity	Product variable quantity.	No

For more information about the required properties please refer to our API Reference here .