API reference Products Publish a product

Publish a product

POST methodhttps://api.anyshop.io/v1/products/{id}/publish

Puts a draft on sale, on your storefront and at checkout, in both modes. Refused while something its type needs is missing, such as a verified file; a listing a person has to look at first is held for review instead. Needs a live key.

Scope products:write
Live keys only
Idempotent with Idempotency-Key
403 store_suspended while suspended

Path parameters

idstring required

Headers

Idempotency-Keystring Up to 255 characters. A retry with the same key and request gets the first answer, without running twice (24 hours).

Example

as_live_

curl -X POST \
  https://api.anyshop.io/v1/products/prod_01m3rr5kmbeb2s18x1kpntjxqb/publish \
  -H "Authorization: Bearer $ANYSHOP_LIVE_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "object": "product",
  "id": "prod_01m3rr5kmbeb2s18x1kpntjxqb",
  "name": "Lumen Studio Pro",
  "slug": "lumen-studio-pro",
  "description": "",
  "type": "serial",
  "category": "game_keys",
  "status": "draft",
  "currency": "USD",
  "variants": [
    {
      "id": "var_01m3rr5kmd6h0q2t8w4y9zb7ce",
      "name": "Standard",
      "price": 1999
    }
  ],
  "max_quantity_per_order": 2,
  "low_stock_threshold": 20,
  "platform": "Windows and macOS",
  "region": "Global",
  "delivery_instructions": "",
  "created_at": "2026-10-02T14:21:07.000Z",
  "updated_at": "2026-10-02T14:21:07.000Z",
  "published_at": null
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

The product object.

Errors

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After