Skip to content
FloeeAPI

API reference · Catalogue

Archive products

POST/api/v1/catalogue/products/archiveScope catalogue:sync

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

curlshell
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

FieldTypeDescription
external_ids (required)(string | number)[]Your store's product ids.
Example bodyjson
{
  "external_ids": [
    "101",
    "gid://shopify/Product/8812"
  ]
}

Responses

200

How many were archived, and which ids Floee did not know.

200 responsejson
{
  "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.

StatuserrorWhen
400invalid bodyexternal_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.