List inventory channels

GET

/v1/organizations/{organizationId}/inventory-channels

• Test API

API key scope: inventory:read.

Authorizations

• ApiKey

Parameters

Header Parameters

X-Request-Id

string

Optional client request id returned in structured errors.

Query Parameters

limit

number

default: 25 >= 1 <= 100

cursor

string

code

string

Example

DEFAULT

Responses

200

Inventory channels page.

Media typeapplication/json

object

items

required

Array<object>

object

id

required

string format: uuid

organizationId

required

string format: uuid

environment

required

string

Allowed values: live test

name

required

string

code

required

string

type

required

string

Allowed values: default ecommerce marketplace pos wholesale custom

status

required

string

Allowed values: active archived

metadata

object

key

additional properties

any

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

nextCursor

object

Example

{
  "items": [
    {
      "id": "eeeeeeee-eeee-4eee-8eee-eeeeeeeeeeee",
      "organizationId": "11111111-1111-4111-8111-111111111111",
      "environment": "test",
      "name": "Marketplace",
      "code": "MARKETPLACE",
      "type": "marketplace",
      "status": "active",
      "metadata": {
        "region": "US"
      },
      "createdAt": "2026-07-03T10:00:00.000Z",
      "updatedAt": "2026-07-03T10:00:00.000Z"
    }
  ],
  "nextCursor": null
}

403

The organization has exhausted its monthly public API request quota.

Media typeapplication/json

Example

{
  "error": {
    "code": "PLAN_LIMIT_EXCEEDED",
    "message": "Plan limit exceeded for api_requests",
    "requestId": "req_123",
    "details": {
      "entitlementKey": "api_requests",
      "scope": "environment",
      "environment": "live",
      "configured": true,
      "limit": "50000",
      "used": "50000",
      "requested": "1",
      "currentPlan": {
        "code": "free",
        "version": 1
      },
      "requiredPlan": {
        "code": "starter",
        "version": 1,
        "requiresOverride": false
      }
    }
  }
}