border.bot
Docs menu

API reference

API reference

Add a code

POST https://api.border.bot/v1/catalog/products/{id}/classifications

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

A code you hold for a market: a suggestion to review, or approved at once with approve. Markets in a customs union share its code (Germany and France the EU’s). Free.

API key scope: catalog.

Parameters#

Name Type Required Description
id string (uuid) yes The product’s id.

Request body (JSON)#

Name Type Required Description
market string yes
code string yes
approve boolean no
description string | null no
note string | null no

Responses#

  • 200: The code. (CatalogClassificationResponse)
  • 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 POST 'https://api.border.bot/v1/catalog/products/{id}/classifications' \
  -H 'Authorization: Bearer bb_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"market":"US","code":"7323.93.0080","approve":true}'