List categories

Requires an active API credential with the catalog:read permission. Lists the categories of products you can order now. Pass include_unavailable=true to also include the categories of out-of-stock and unavailable products, as the Products endpoint does with the same parameter; every category in the default list is still included. Sandbox credentials return the static sandbox category. Use the Products endpoint with a sandbox key to find scenario product IDs.

GET

https://cardzone.ai/api/b2b/v1/categories

Authorization

BearerAuth
HTTP
required

Query parameters

include_unavailable
optional
boolean
Also list products that cannot be ordered right now (status out_of_stock or unavailable).

default: false

Returns

200

401

Missing, revoked, or unknown API key. A live key also gets this while its store is inactive, or until the store's business verification is approved and its primary user's email is verified.

JSON

error
object
required
- code
  string
  required
- message
  string
  required
- details
  optional
  unknown
  Optional field-level validation details
- product_status
  optional
  out_of_stock
  or
  unavailable
  Present on 404 product errors when the product exists but cannot be ordered: out_of_stock or unavailable, with the same meaning as the catalog status. Absent when the product id is unknown or deleted.
}

403

forbidden when the API credential lacks the required permission, or insufficient_store_wallet_balance when a live key's store does not meet the wallet requirement.

JSON

error
object
required
- code
  string
  required
- message
  string
  required
- details
  optional
  unknown
  Optional field-level validation details
- product_status
  optional
  out_of_stock
  or
  unavailable
  Present on 404 product errors when the product exists but cannot be ordered: out_of_stock or unavailable, with the same meaning as the catalog status. Absent when the product id is unknown or deleted.
}