List products

Requires an active API credential with the catalog:read permission. Each row is a sellable denomination: use its id as product_id when ordering. Inspect recipient_fields for every required account field and its label before showing the order form. These fields are configured on the Cardzone Product, not its fulfillment sources. Catalog availability and credential restrictions still apply. By default only products you can order now are listed, all with status: available. Pass include_unavailable=true to also list products you can see but cannot order right now, with status out_of_stock or unavailable, so you can pause them instead of losing track of them. Hidden products, products without an active price, unprofitable products, and products of a delivery type your API credential cannot order are never listed. With a sandbox key, this endpoint returns static scenario products. Send one of those product id values as product_id when creating an order to trigger the matching hardcoded response.

GET

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

Authorization

BearerAuth
HTTP
required

Query parameters

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

default: false

Returns

200

Products. With sandbox keys, this returns static scenario products whose id values trigger hardcoded order responses.

JSON

products
array of
object
required
- id
  string
  required
  Sellable Cardzone product/variant UUID. In sandbox mode, this is also the scenario selector for hardcoded order responses.
  
  format: uuid
- name
  string
  required
- status
  available
  or
  out_of_stock
  or
  unavailable
  required
  available: you can order it now. out_of_stock: Cardzone has marked it out of stock, and your store has none of its own stock. It stays out of stock until Cardzone marks it available again. unavailable: there is no way to fulfill it for your store. In order errors it also covers products that are hidden for your store or have no active price; the catalog never lists those. Orders for products that are not available are rejected with 404 and the same value in error.product_status.
- delivery_type
  voucher
  or
  topup
  required
- purchase_price
  object
  required
  Your merchant unit price
  
  amount
  string
  required
  Decimal amount as a string
  
  currency
  string
  required
- recommended_retail_price
  object
  required
  Suggested resale unit price
  
  amount
  string
  required
  Decimal amount as a string
  
  currency
  string
  required
- recipient_fields
  array of
  object
  required
  Required fields configured on the Cardzone Product, in display order and independent of provider routing. Empty for voucher rows.
  
  key
  string
  required
  Product-configured canonical key, including custom keys such as region_id or account_tag. Never a provider parameter name.
  
  pattern: ^(?!constructor$|prototype$)[a-z][a-z0-9_]*$
  label
  string
  required
  Localized display label; use key, not label, in recipient requests.
  
  required
  true
  required
- product_code
  optional
  string
  Cardzone internal product code for support/debugging. In sandbox mode this identifies the static response scenario.
- description
  optional
  string
  or null
- category_id
  optional
  string
  or null
  Category slug
- category_name
  optional
  string
  or null
- player_lookup
  optional
  boolean
  True when POST /api/b2b/v1/player_profiles can resolve the in-game profile for this product's recipient. Always false for voucher rows.
}

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.
}

404

Category was not found

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.
}