Production orders
Production orders in Traede represent inbound orders that are to be received and put into stock in the WMS. Below is a description of the parameters of a production order.
Get production orders
Endpoint: GET /3pl/production/orders/delivery-notes
Available properties for filtering: supplier_id, created_at, updated_at
Data of response
| Parameter | Required | Default | Description |
|---|---|---|---|
production_order_delivery_notes.* | Yes | An array of production order delivery notes | |
total | Yes | The total number of production order delivery notes |
Production order delivery notes
| Parameter | Required | Default | Description |
|---|---|---|---|
production_order_delivery_note_number | Yes | The number of the production order delivery | |
supplier_number | Yes | The number of the supplier of the production order | |
supplier | Yes | The name of the supplier of the production order | |
currency | Yes | The currency of the production order | |
expected_delivery | null | The expected delivery date of the delivery | |
notes | null | Optionally some notes to the production order delivery | |
production_order_delivery_note_meta | object | {} | An object with {"key": "value"} with custom meta data of the production order delivery note. See custom fields for more information |
production_order_meta | object | {} | An object with {"key": "value"} with custom meta data of the production order. See custom fields for more information |
created_at | Yes | ||
updated_at | Yes | ||
lines | Yes | Array of object lines |
Lines
| Parameter | Required | Default | Description |
|---|---|---|---|
product_name | Yes | The name of the product. This is the name of the product without attributes (Color, Size, etc.) | |
item_number | Yes | The item number of the product. NOTE: This is the number on the product-level, not variant-level. For variant-level refer to sku | |
attributes | Yes | An object with {"key": "value"} with the attributes of the variant. This will be Colors, Sizes, etc. | |
full_name | Yes | The name of the product plus its attributes. Use this for delivery notes and packing lists | |
sku | Yes | The unique identifier of this specific variant. Use this for identification in your WMS | |
ean | null | The EAN code of this variant | |
country_of_origin | null | Country of origin of the product. This is given as a 2-letter ISO code (DK, DE, etc.) | |
composition | null | The composition of the product (materials) | |
hs_tariff_code | null | The HS Tariff Code of the product | |
expected_quantity | Yes | The number of pieces that is expected to be received on the production order delivery |
Receiving a production order
Marking a production order as received
Endpoint: POST /3pl/production/receive
| Parameter | Required | Default | Description |
|---|---|---|---|
production_order_delivery_note | Yes | Object of production order delivery note |
Production order delivery note
| Parameter | Required | Default | Description |
|---|---|---|---|
production_order_delivery_note_number | Yes | The identifier of the production order delivery | |
meta | Optional object of {"key": "value"} custom fields on the production order delivery note. See custom fields for more information | ||
lines | Yes | Array of object lines |
note
meta is a partial update. Sent keys are added or replaced. Keys that are not included are left unchanged. If meta is omitted, existing custom fields are not changed.
The field must be named meta. Do not send production_order_delivery_note_meta — that name is only used on GET/push responses and is ignored on receive.
Delivery note lines
| Parameter | Required | Default | Description |
|---|---|---|---|
sku | Yes, if no ean is given | The SKU of the line | |
ean | Yes, if no sku is given | The EAN of the line | |
received_quantity | Yes | The number of pieces that were received |
Example
POST /3pl/production/receive
{
"production_order_delivery_note": {
"production_order_delivery_note_number": "1000-1",
"meta": {
"warehouse_status": "in_progress"
},
"lines": [
{
"sku": "1000-Black-S",
"received_quantity": 10
},
{
"sku": "1000-Black-M",
"received_quantity": 10
}
]
}
}