Inventory
The following endpoints are used to create inventory adjustments. Remember that completing orders and receiving production orders will also create inventory changes. So only use inventory adjustments for other types of adjustments.
Creating intra-day adjustments
Endpoint: POST /3pl/inventory/manual-adjustments
Parameter | Required | Default | Description |
---|---|---|---|
adjustments.* | Yes | An array of object adjustment |
Adjustment
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 | |
quantity | Yes, if no adjustment is supplied | Use quantity if you want to set the quantity of the variant to a specific number | |
adjustment | Yes, if no quantity is supplied | Use adjustment if you want to create a relative adjustment to the current inventory. E.g. +2 would increase inventory with 2 and -2 would decrease current inventory with 2 | |
text | Optionally, add a text that is shown in Traede. Use this to describe why the change was made. |
Example
POST /3pl/inventory/manual-adjustments
{
"adjustments": [
{
"sku": "1000-Black-S",
"adjustment": -5,
"text": "Missing pieces"
},
{
"sku": "1000-Black-M",
"adjustment": 5,
"text": "Found some pieces in the corner"
}
]
}
Doing a full nightly inventory sync
To avoid accumulating differences in inventory over time it is highly recommended to do a full inventory sync once every night.
info
It is recommended doing an inventory sync once every night
caution
WARNING! Since this endpoint is a “full inventory sync” any variant NOT included in the request will be set to 0.
Endpoint: POST /3pl/inventory/sync-inventory
Parameter | Required | Default | Description |
---|---|---|---|
levels.* | Yes | An array of object level | |
inventory_location_id | Sometimes | null | An id of a inventory location |
info
inventory_location_id
is required if you have multiple inventory locations set up for 3PL.
If you only have one inventory location, you can omit this parameter.
If you have multiple inventory locations, and do not provide it, the sync-inventory will fail.
Level
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 | |
quantity | Yes | The number of pieces in stock |
Example
POST /3pl/inventory/sync-inventory
{
"levels": [
{
"sku": "1000-Black-S",
"quantity": 2
},
{
"sku": "1000-Black-M",
"quantity": 3
}
]
}