API reference Products Create a product

Create a product

POST methodhttps://api.anyshop.io/v1/products

Adds a product to your catalog as a draft, with one variant, Standard, at the price you give. Publish it to put it on sale. The catalog is shared by live and test mode, so this needs a live key.

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

Body

application/json4 required, 7 optional

namestring requiredWhat buyers see on your storefront and in their email1 to 120 characters
typeenum requiredHow it is delivered: serial keys from your stock, license keys anyshop issues, a file download, your own server (dynamic), or instructions for a serviceseriallicensefiledynamicservice
categoryenum requiredWhere it is listedgame_keyssoftware_licensesdigital_filesaccess_membershipsservices
priceinteger requiredThe price of its Standard variant, in minor units of your store currency: 1999 is $19.99, 0 makes it freeAt least 0
descriptionstring Shown on the product pageUp to 10,000 characters
max_quantity_per_orderinteger How many one buyer can take in one order, default 11 to 100
low_stock_thresholdinteger or null Serial keys only. Below this many keys you get the daily low stock email and a stock.low event0 to 1,000,000
platformstring or null Serial keys only. Where the key is used, such as Windows and macOSUp to 60 characters
regionstring or null Serial keys only. Where the key worksUp to 60 characters
delivery_instructionsstring Shown with what was delivered: how to redeem a key, or what happens next for a serviceUp to 4,000 characters
dynamic_endpoint_urlstring or null Dynamic products: your https server, which anyshop calls after each payment with a Standard Webhooks signed request; its answer is deliveredUp to 2,048 characters

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 \
  -H "Authorization: Bearer $ANYSHOP_LIVE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lumen Studio Pro",
    "type": "serial",
    "category": "software_licenses",
    "price": 1999,
    "max_quantity_per_order": 2,
    "low_stock_threshold": 20,
    "platform": "Windows and macOS",
    "region": "Global",
    "delivery_instructions": "In Lumen Studio Pro, choose Help, Enter license key, and paste this key."
  }'

{
  "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