Batch create/upsert images

Up to 100 items in one call. With merge_key, every item gets upsert semantics (create-or-update by that key); without it, pure creates. Items are processed independently and the response is PER-ITEM: HTTP 200 does NOT mean every item succeeded — check each status (created | updated | error) and surface error.message/error.field_errors for failures. A 5,000-SKU ERP delta push is 50 calls with merge_key: "sku".

Scope: write:images.

post/images/batch

Request

  • Base URL
    https://www.merchkit.com/api/v1
  • Auth
    HTTP bearer

Request body

merge_keystring

Optional shared merge key — when present, items upsert instead of create.

Response

Per-item results, in input order, under a summary that makes "N of M failed" a single field read. Check every item — a 200 only means the batch was processed. Route retries on error.retriable, never on message text. Summaries from re-runs must not be summed (an idempotent retry reports updates for rows the first attempt created).

Example response

{
  "summary": {
    "total": 3,
    "created": 1,
    "updated": 1,
    "failed": 1,
    "has_errors": true
  },
  "data": [
    {
      "index": 0,
      "merge_value": "ARIA-DT-72",
      "id": "9b2f6c1e-8a04-4c6e-b0d3-5f2f6f7a9e21",
      "status": "updated"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.