Skip to main content
POST
/
v1
/
inventories
Update Inventory
curl --request POST \
  --url https://api.wizcommerce.com/v1/inventories \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "sku": "SKU-001",
  "inventory_status": "IN_STOCK",
  "available_quantity": 100,
  "reserved_quantity": 100,
  "in_stock_quantity": 100,
  "back_order_quantity": 100,
  "back_order_allowed": true,
  "out_of_stock_threshold": 100,
  "track_inventory": true,
  "on_order_details": [
    {
      "quantity": 100,
      "date": "2025-01-01T00:00:00Z",
      "identifier": "on_order_0"
    }
  ],
  "in_transit_details": [
    {
      "quantity": 100,
      "date": "2025-01-01T00:00:00Z",
      "identifier": "in_transit_0"
    }
  ],
  "dynamic_details": "{\"key\":\"value\"}",
  "notes": "Notes"
}
'
{
  "data": {
    "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "product_id": "1234567890",
    "available_quantity": 100,
    "sku": "SKU-001",
    "reserved_quantity": 100,
    "in_stock_quantity": 100,
    "back_order_quantity": 100,
    "inventory_status": "IN_STOCK",
    "status": "active",
    "track_inventory": true,
    "on_order_details": [
      {
        "quantity": 100,
        "date": "2025-01-01",
        "identifier": "1234567890"
      }
    ],
    "in_transit_details": [
      {
        "quantity": 100,
        "date": "2025-01-01",
        "identifier": "1234567890"
      }
    ],
    "notes": "Notes",
    "back_order_allowed": true,
    "created_at": "2025-01-01T15:04:05Z",
    "updated_at": "2025-01-01T15:04:05Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.wizcommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Body

application/json

Inventory Create or Update Request

​
sku
string
required
Maximum string length: 255
Example:

"SKU-001"

​
inventory_status
enum<string>
required
Available options:
OUT_OF_STOCK,
IN_STOCK,
BACK_ORDER
Example:

"IN_STOCK"

​
available_quantity
integer
Example:

100

​
reserved_quantity
integer
Example:

100

​
in_stock_quantity
integer
Example:

100

​
back_order_quantity
integer
Example:

100

​
back_order_allowed
boolean
default:true
Example:

true

​
out_of_stock_threshold
integer
Example:

100

​
track_inventory
boolean
default:true
Example:

true

​
on_order_details
object[]
​
in_transit_details
object[]
​
dynamic_details
string
Example:

"{\"key\":\"value\"}"

​
notes
string

HTML content

Example:

"Notes"

Response

Created

​
data
object