Archive a product (offer)
archive_productArchives a product by setting its status to Archived. Once archived, it cannot be made public or hidden via the API; only an admin can restore it.
Instructions
Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.
Soft-archives the product — sets it to Archived. Terminal at this surface: once archived, the product cannot be returned to PUBLIC/HIDDEN through the open-api (restoration stays admin-only). Idempotent: re-DELETE on an already-archived product also returns 204.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"product_id": "<product_id>"
},
"name": "archive_product"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private shop profile label; not a provider identity or authorization proof. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| product_id | Yes | Native productId |