API reference · Catalogue
Archive products
Your store deleted these products. They go off sale; the rows are never deleted, and a later upsert restores them. At most 500 ids.
Request
curl -X POST "https://icebot.icebergaisolutions.com/api/v1/catalogue/products/archive" \
-H "Authorization: Bearer $ICEBOT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"external_ids":["101","gid://shopify/Product/8812"]}'Body
| Field | Type | Description |
|---|---|---|
external_ids (required) | (string | number)[] | Your store's product ids. |
{
"external_ids": [
"101",
"gid://shopify/Product/8812"
]
}Responses
200
How many were archived, and which ids Floee did not know.
{
"archived": 1,
"unknown": [
"gid://shopify/Product/8812"
]
}Errors
Every endpoint can also return 401 (missing, unknown or revoked key), 403 (origin not allowed, or the key lacks catalogue:sync) and 429 (rate limited). See Errors.
| Status | error | When |
|---|---|---|
400 | invalid body | external_ids is missing, empty, too long or has a blank entry. |
Source of truth: /api/v1/catalogue/products/archive in apps/dashboard/app/api/v1/catalogue/products/archive/route.ts.