Skip to content
digizeDocs

List stock

GET
/api/v1/commerce/inventory
curl --request GET \
  --url https://digize.com/api/v1/commerce/inventory \
  --header 'x-api-key: <x-api-key>'

Stock for every variant that’s counted: on hand, held by open checkouts, available, and the last 30 days’ sales.

Needs the commerce:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
rows
required
Array<object>
object
variantId
required
string
productId
required
string
product
required
string
variant
required
string
sku
required
string
category
required
string
color
required
string
Allowed values: primary accent secondary success warning info destructive
onHand
required
number
reserved
required
number
available
required
number
reorderAt
required
number
cost
required
number
price
required
number
status
required
string
Allowed values: in_stock low out
sold
required

Units sold in the last 30 days.

number
locations
required
Array<object>
object
locationId
required
string
name
required
string
onHand
required
number
total
required
number

Example 

{
  "rows": [
    {
      "color": "primary",
      "status": "in_stock"
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}