GET
/
inventories
List Inventories
curl --request GET \
  --url https://api.wizcommerce.com/v1/inventories \
  --header 'X-API-Key: <api-key>'
{
  "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"
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

sort_by
enum<string>
default:updated_at
Available options:
created_at,
updated_at,
product_id,
id
page
integer
Required range: x >= 1
sort
enum<string>
default:desc
Available options:
asc,
desc
page_size
integer
Required range: 1 <= x <= 100
status
enum<string>
default:active
Available options:
active,
inactive
sku
string

Response

200
application/json

OK

The response is of type object.