body
of each action across WMS, so you can write data in a consistent way across all of them.
For each resource, we call this the “Base Schema”. See the Create Order Base Schema as an example.
However, the required and optional fields may vary depending on the WMS you are writing to. Additionally, some WMS may require a field that is unique to them.
To handle these cases, we have also included each WMS’s schema in the reference. See Extensiv’s Create Order Schema
for an example.
On the API side, we have created an endpoint that will return the required and optional fields for a given entity in a given WMS.
/integrations
endpoint, the required and optional fields to create an order in the Some WMS
WMS are as follows:
Field | Description | Type | Required |
---|---|---|---|
line_items.product_id | The product ID of the line item | string | Yes |
line_items.quantity | The quantity of the line item | number | Yes |
order_number | The order number | string | No |
line_items | The line items | array | No |
channel | The channel | string | No |
trading_partner | The trading partner | string | No |
warehouse_id | The warehouse ID | string | Yes |
null
value for any field.
For example, order_number
is an optional field. Sending in the following request will result in a 422 error response: