Upsert collections relationships

Bulk-upserts product-to-collection relationships; sort_order is authoritative on conflict.

PUT/api/v2/{team_slug}/{app_slug}/collections/products

Authorization

AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters

team_slugstringrequired

app_slugstringrequired

Request body

requiredapplication/json

productsUpsertCollectionProductItem[]required

min items 1 · max items 20

Show properties

Array of UpsertCollectionProductItem

collection_idUUIDrequired

product_idUUIDrequired

sort_orderintegerrequired

Responses

200

OK (partial success possible)

dataCollectionProduct[]required

Show properties

Array of CollectionProduct

collection_idUUIDrequired

product_idUUIDrequired

sort_orderintegerrequired

errorsCollectionProductError[]required

Show properties

Array of CollectionProductError

collection_idUUIDrequired

product_idUUIDrequired

messagestringrequired

400

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

401

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

403

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

500

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

team_slugpath*app_slugpath*

Bodyapplication/json

Request body

Request

curl -X PUT 'https://api.enad.io/api/v2/string/string/collections/products' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "products": [
    {
      "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "sort_order": 0
    }
  ]
}'

const response = await fetch("https://api.enad.io/api/v2/string/string/collections/products", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"products\": [\n    {\n      \"collection_id\": \"4bdef85c-3f50-4006-a713-2350da665f80\",\n      \"product_id\": \"0d012afa-f885-4e65-aeca-37e27701e2d1\",\n      \"sort_order\": 0\n    }\n  ]\n}"
});

import requests

response = requests.put(
    "https://api.enad.io/api/v2/string/string/collections/products",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"products\": [\n    {\n      \"collection_id\": \"4bdef85c-3f50-4006-a713-2350da665f80\",\n      \"product_id\": \"0d012afa-f885-4e65-aeca-37e27701e2d1\",\n      \"sort_order\": 0\n    }\n  ]\n}",
)

Response

{
  "data": [
    {
      "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "sort_order": 0
    }
  ],
  "errors": [
    {
      "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "message": "string"
    }
  ]
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}