border.bot
Docs menu

API reference

API reference

List products

GET https://api.border.bot/v1/catalog/products

Requires an API key (Authorization: Bearer bb_live_…).

Your catalogue, newest change first, a page at a time (cursor). Filter by words or a SKU prefix (q), status, market, products missing an approved code for a market (missingCodeFor), products with a code waiting for review (needsReview), origin, or source kind. Free.

API key scope: catalog.

Parameters#

Name Type Required Description
q string no
status "draft" | "active" | "archived" no
market string no
missingCodeFor string no
needsReview boolean | "0" | "1" | "true" | "false" no
origin string no
source string no
cursor string no
limit integer no

Responses#

  • 200: A page of products. (CatalogProductsResponse)
  • 400: Invalid input (invalid_input). (Error)
  • 401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
  • 403: The API key doesn’t have the catalog scope (forbidden, details.reason: "missing_scope"). (Error)
  • 429: Rate limited (rate_limited). Retry after Retry-After seconds; RateLimit says which limit was hit (r=0, t seconds until its window ends) and RateLimit-Policy its quota. (Error)
  • 500: Unexpected error (internal). (Error)

Example#

bash
curl -X GET 'https://api.border.bot/v1/catalog/products' \
  -H 'Authorization: Bearer bb_live_...'