RevKeenDocs
StatusSupport
API Reference

Batch upsert products by external ID

Create or update multiple products by external system ID. Supports up to 100 products per request with stale update protection. --- **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 **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `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`. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

PUT
/products/external/batch

Create or update multiple products by external system ID. Supports up to 100 products per request with stale update protection.

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

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 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.

Idempotency

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

Authorization

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

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X PUT "https://api.revkeen.com/v2/products/external/batch" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "practicehub",
    "products": [
      {
        "external_id": "prod_12345",
        "name": "Monthly Membership",
        "description": "string",
        "kind": "subscription",
        "amount_cents": 9900,
        "currency": "USD",
        "is_active": true,
        "interval": "month",
        "interval_count": 1,
        "external_updated_at": "2026-01-01T00:00:00Z",
        "external_ref": "string",
        "metadata": {}
      }
    ]
  }'
{  "created": 0,  "updated": 0,  "skipped": 0,  "failed": [    {      "external_id": "string",      "error": "string"    }  ]}

Create product POST

Create a new product. Requires 'products:write' scope. --- **Related endpoints** - `GET /products` — List products - `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 **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

Upsert product by external ID PUT

Create or update a product by external system ID. Uses stale update protection. --- **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/batch` — Batch upsert products by external ID **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `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. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).