Docs menu
Get started
API reference
Classification
Landed cost
Products
Compliance
Reference
Origin
Bulk
Catalogue
- GETList products
- POSTCreate a product
- GETGet a product
- PATCHUpdate a product
- POSTArchive a product
- GETA product’s history
- GETA product’s codes
- POSTAdd a code
- POSTSuggest codes
- POSTApprove a code
- POSTReject a code
- POSTClassify many products
- GETYour imports
- POSTImport a CSV file
- GETAn import
- GETExport as CSV
- POSTSync records from a source
- GETApproved codes to write back
- GETCatalogue vocabularies
- GETSource kinds
- GETDefault target markets
- POSTSet default target markets
API reference
Archive a product
POST https://api.border.bot/v1/catalog/products/{id}/archive
Requires an API key (Authorization: Bearer bb_live_…).
Retires a product and its items: out of lists and SKU lookups (its SKUs become free), kept with its sources, content, codes and history. Nothing in the catalogue is ever deleted. Restore it by updating its status. Free.
API key scope: catalog.
Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
id |
string (uuid) | yes | The product’s id. |
Responses#
200: The archived product. (CatalogProductResponse)400: Invalid input (invalid_input). (Error)401: Missing, invalid, revoked or expired API key (unauthorized). (Error)403: The API key doesn’t have thecatalogscope (forbidden,details.reason: "missing_scope"). (Error)429: Rate limited (rate_limited). Retry afterRetry-Afterseconds;RateLimitsays which limit was hit (r=0,tseconds until its window ends) andRateLimit-Policyits quota. (Error)500: Unexpected error (internal). (Error)
Example#
curl -X POST 'https://api.border.bot/v1/catalog/products/{id}/archive' \
-H 'Authorization: Bearer bb_live_...'