Bulk Local Inventory (deprecated)
POST/inventory/bulk/local
The bulk local inventory endpoint is used to create or update inventory records.
This endpoint is deprecated in favor of Bulk Inventory by lookup key / inventory type
where you can use the same payload, but you need to set the lookup key param to sku
and the inventory type param to local
.
On creating a record, inventory type local is matching the product on the field sku. If the product is found, inventory record will be created.
For updating a record, matching fields are: sku, warehouseId and location. Record is updated only when inventory record with all three matching fields is found, otherwise new record is created.
Available fields
Name | Required |
---|---|
quantity (integer) | yes |
sku (string) | yes |
warehouseId (integer) | no Default value is 0 |
location (string) | no Default value is empty |
costPrice (integer) | no Default value is product costprice |
nextDeliveryDate (date) | no |
notes (string) | no |
dateModified
is always updated with the current date and time.
Request
- application/json
Body
Array [
]
inventory
object[]
Responses
- 200
Bulk Local Inventory - 200
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Bulk Local Inventory - 200
Schema
Array [
]
data
object[]
{
"data": [
{
"action": "update",
"success": true
},
{
"action": "update",
"success": true
}
],
"messages": [
"Completed"
],
"total": 2
}
{
"data": [
{
"action": "update",
"success": true
},
{
"action": "update",
"success": true
}
],
"messages": [
"Completed"
],
"total": 2
}