CryptiumPayDocs
API reference

List catalog items

Read your merchant catalog with offset pagination.

GET/api/items

List the authenticated merchant catalog. Requires merchant-id and signature headers.

Request fields from the OpenAPI specification
FieldTypeRequiredDescription
limitquerystringNoPage size; query is a decimal string from 1 to 100. Default 25.
offsetquerystringNoNon-negative offset with no leading zeroes, at most nine digits. Default 0.
include_archivedquerystringNoWhether archived items are included. Default false.

Source: download OpenAPI 3.1. Examples below use illustrative values.

Request

Sign {} for this bodyless GET, including when using query parameters:

GET /api/items?limit=25&offset=0&include_archived=false
merchant-id: YOUR_MERCHANT_ID
signature: YOUR_COMPUTED_SIGNATURE

Response

Returns a plain JSON array of catalog items. There is no data, total, or cursor wrapper. The default limit is 25 and offset is 0; archived items are excluded unless requested.

Results are ordered by creation time descending, then ID descending. Continue with a larger offset until a page contains fewer items than the requested limit. A catalog changing between requests can affect offset pagination.

Query values are strings. Use true or false literally for include_archived; values such as 1 are rejected. The limit is 1 to 100 and offset uses a non-negative integer with no leading zeroes, up to nine digits.

Catalog changes are made through the merchant console. This endpoint only reads items for the authenticated merchant.

On this page