border.bot
Docs menu

API reference

API reference

Export as CSV

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

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

Your catalogue (or the products a filter finds, up to 10,000) as CSV: one row per item, every field, and the approved code per market. It imports again as it is. 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

Responses#

  • 200: The CSV text. (CatalogExportResponse)
  • 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/exports' \
  -H 'Authorization: Bearer bb_live_...'