📦 Products & PricingProducts

Create a product collection

Create a product collection. The URL handle must be unique for the merchant, and every product must belong to the merchant.

POST/product-collections

Create a product collection. The URL handle must be unique for the merchant, and every product must belong to the merchant.


Related endpoints

  • GET /products — List products
  • POST /products — Create product
  • GET /products/{id} — Get product by ID
  • PATCH /products/{id} — Update product
  • PUT /products/external/{source}/{externalId} — Upsert product by external ID
  • PUT /products/external/batch — Batch upsert products by external ID
  • GET /product-collections — List product collections
  • GET /product-collections/{id} — Get a product collection

Common errors

  • 403 authorization_error — the caller is identified but the action is denied. Codes include insufficient_permissions, ip_not_allowed, merchant_mismatch, and origin_not_allowed.
  • 409 conflict — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
  • 422 unprocessable_entity — business-rule failure (for example, refunding more than the original charge).

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/product-collections" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example",
    "slug": "example"
  }'

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "00000000-0000-4000-8000-000000000001",    "object": "product_collection",    "name": "Example customer",    "slug": "string",    "description": "string",    "image_asset_id": "string",    "position": 0,    "version": 0,    "product_ids": [      "string"    ],    "created_at": "2026-09-01T12:00:00Z",    "updated_at": "2026-09-01T12:00:00Z"  }}