Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Promote product drafts

Bulk-promotes product draft changesets onto their live products.

POST/api/v2/{team_slug}/{app_slug}/products/drafts/promote
Authorization
AuthorizationBearer token · headerrequired

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

Path parameters
team_slugstringrequired
app_slugstringrequired
Request body
requiredapplication/json
product_draftsProductDraftIDItem[]required
min items 1 · max items 20
Show properties
Array of ProductDraftIDItem
idUUIDrequired
Responses
200

OK (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
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.enad.io/api/v2/string/string/products/drafts/promote' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "product_drafts": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}'
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"
    }
  ]
}