Create product drafts

Bulk-creates product drafts. Successful entities are returned in data; per-item failures in errors keyed by product_id.

POST/api/v2/{team_slug}/{app_slug}/products/drafts

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

team_slugstringrequired

app_slugstringrequired

Request body

requiredapplication/json

product_draftsCreateProductDraftItem[]required

min items 1 · max items 20

Show properties

Array of CreateProductDraftItem

product_idUUIDrequired

changesetProductDraftChangeset

Show properties

namestring

descriptionstring

html_descriptionstring

short_descriptionstring

html_short_descriptionstring

meta_titlestring

meta_descriptionstring

categoriesProductDraftCategoryRef[]

Show properties

Array of ProductDraftCategoryRef

idUUIDrequired

orderinteger

is_main_categoryboolean

collectionsUUID[]

tagsProductDraftTagRef[]

Show properties

Array of ProductDraftTagRef

keystringrequired

orderinteger

imagesProductDraftImageRef[]

Show properties

Array of ProductDraftImageRef

idUUIDrequired

priorityinteger

attributesUUID[]

publish_atstring<date-time> | null

Responses

201

Created (partial success possible)

dataProductDraft[]required

Show properties

Array of ProductDraft

idUUIDrequired

app_idUUIDrequired

product_idUUIDrequired

changesetProductDraftChangeset | null

Show properties

Any of:

ProductDraftChangeset

namestring

descriptionstring

html_descriptionstring

short_descriptionstring

html_short_descriptionstring

meta_titlestring

meta_descriptionstring

categoriesProductDraftCategoryRef[]

Show properties

Array of ProductDraftCategoryRef

idUUIDrequired

orderinteger

is_main_categoryboolean

collectionsUUID[]

tagsProductDraftTagRef[]

Show properties

Array of ProductDraftTagRef

keystringrequired

orderinteger

imagesProductDraftImageRef[]

Show properties

Array of ProductDraftImageRef

idUUIDrequired

priorityinteger

attributesUUID[]

null

null

publish_atstring<date-time> | null

created_atstring<date-time>required

updated_atstring<date-time> | null

errorsProductDraftError[]required

Show properties

Array of ProductDraftError

product_idUUID | null

Show properties

Any of:

UUID

string<uuid>

null

null

idUUID | null

Show properties

Any of:

UUID

string<uuid>

null

null

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

{
  "product_drafts": [
    {
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "changeset": {
        "name": "string",
        "description": "string",
        "html_description": "string",
        "short_description": "string",
        "html_short_description": "string",
        "meta_title": "string",
        "meta_description": "string",
        "categories": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "order": 0,
            "is_main_category": true
          }
        ],
        "collections": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "tags": [
          {
            "key": "string",
            "order": 0
          }
        ],
        "images": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "priority": 0
          }
        ],
        "attributes": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
      },
      "publish_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Request

curl -X POST 'https://api.enad.io/api/v2/string/string/products/drafts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "product_drafts": [
    {
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "changeset": {
        "name": "string",
        "description": "string",
        "html_description": "string",
        "short_description": "string",
        "html_short_description": "string",
        "meta_title": "string",
        "meta_description": "string",
        "categories": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "order": 0,
            "is_main_category": true
          }
        ],
        "collections": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "tags": [
          {
            "key": "string",
            "order": 0
          }
        ],
        "images": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "priority": 0
          }
        ],
        "attributes": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
      },
      "publish_at": "2019-08-24T14:15:22Z"
    }
  ]
}'

const response = await fetch("https://api.enad.io/api/v2/string/string/products/drafts", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"product_drafts\": [\n    {\n      \"product_id\": \"0d012afa-f885-4e65-aeca-37e27701e2d1\",\n      \"changeset\": {\n        \"name\": \"string\",\n        \"description\": \"string\",\n        \"html_description\": \"string\",\n        \"short_description\": \"string\",\n        \"html_short_description\": \"string\",\n        \"meta_title\": \"string\",\n        \"meta_description\": \"string\",\n        \"categories\": [\n          {\n            \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n            \"order\": 0,\n            \"is_main_category\": true\n          }\n        ],\n        \"collections\": [\n          \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n        ],\n        \"tags\": [\n          {\n            \"key\": \"string\",\n            \"order\": 0\n          }\n        ],\n        \"images\": [\n          {\n            \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n            \"priority\": 0\n          }\n        ],\n        \"attributes\": [\n          \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n        ]\n      },\n      \"publish_at\": \"2019-08-24T14:15:22Z\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.enad.io/api/v2/string/string/products/drafts",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"product_drafts\": [\n    {\n      \"product_id\": \"0d012afa-f885-4e65-aeca-37e27701e2d1\",\n      \"changeset\": {\n        \"name\": \"string\",\n        \"description\": \"string\",\n        \"html_description\": \"string\",\n        \"short_description\": \"string\",\n        \"html_short_description\": \"string\",\n        \"meta_title\": \"string\",\n        \"meta_description\": \"string\",\n        \"categories\": [\n          {\n            \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n            \"order\": 0,\n            \"is_main_category\": true\n          }\n        ],\n        \"collections\": [\n          \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n        ],\n        \"tags\": [\n          {\n            \"key\": \"string\",\n            \"order\": 0\n          }\n        ],\n        \"images\": [\n          {\n            \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n            \"priority\": 0\n          }\n        ],\n        \"attributes\": [\n          \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n        ]\n      },\n      \"publish_at\": \"2019-08-24T14:15:22Z\"\n    }\n  ]\n}",
)

Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "changeset": {
        "name": "string",
        "description": "string",
        "html_description": "string",
        "short_description": "string",
        "html_short_description": "string",
        "meta_title": "string",
        "meta_description": "string",
        "categories": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "order": 0,
            "is_main_category": true
          }
        ],
        "collections": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "tags": [
          {
            "key": "string",
            "order": 0
          }
        ],
        "images": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "priority": 0
          }
        ],
        "attributes": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
      },
      "publish_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "errors": [
    {
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "message": "string"
    }
  ]
}

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

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

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

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