Skip to main content
POST
/
api
/
v1
/
:team_slug
/
:app_slug
/
products
/
:product_id
/
draft
Error
A valid request URL is required to generate request examples
{
  "data": {
    "app_id": "<string>",
    "changeset": {
      "attributes": [
        "<string>"
      ],
      "categories": [
        {
          "id": "<string>",
          "order": 123
        }
      ],
      "collections": [
        "<string>"
      ],
      "description": "<string>",
      "html_description": "<string>",
      "html_short_description": "<string>",
      "images": [
        {
          "id": "<string>",
          "priority": 123
        }
      ],
      "meta_description": "<string>",
      "meta_title": "<string>",
      "name": "<string>",
      "short_description": "<string>",
      "tags": [
        {
          "key": "<string>",
          "order": 123
        }
      ]
    },
    "created_at": "<string>",
    "id": "<string>",
    "product_id": "<string>",
    "publish_at": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

​
product_id
string
required

Product ID

Body

application/json

Draft changeset and optional publish_at

​
changeset
object
required
​
publish_at
string

Response

Draft created successfully

​
data
object
​
details
string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

​
success
boolean