DocsDocsReference

Create Product Draft

Creates a new draft changeset for a product. Only one draft can exist per product at a time. Optionally schedules automatic publication at a future time.

POST/api/v1/{team_slug}/{app_slug}/products/{product_id}/draft
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/products/{product_id}/draft

Creates a new draft changeset for a product. Only one draft can exist per product at a time. Optionally schedules automatic publication at a future time.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/draft
  • Summary: Create Product Draft
  • Description: Creates a new draft changeset for a product. Only one draft can exist per product at a time. Optionally schedules automatic publication at a future time.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
product_idpathYesstringProduct ID
Request bodyDocumented body
  • Required: Yes
  • Description: Draft changeset and optional publish_at
  • Content: application/json (object)

Create Product Draft Payload

PropertyTypeRequiredDetails
changesetobjectYes-
publish_atstringNo-

Product Draft Changeset

PropertyTypeRequiredDetails
attributesstring[]No-
categoriesobject[]No-
collectionsstring[]No-
descriptionstringNo-
html_descriptionstringNo-
html_short_descriptionstringNo-
imagesobject[]No-
meta_descriptionstringNo-
meta_titlestringNo-
namestringNo-
short_descriptionstringNo-
tagsobject[]No-

Draft Category Ref

PropertyTypeRequiredDetails
idstringNo-
is_main_categorybooleanNo-
orderintegerNo-

Draft Image Ref

PropertyTypeRequiredDetails
idstringNo-
priorityintegerNo-

Draft Tag Ref

PropertyTypeRequiredDetails
keystringNo-
orderintegerNo-

Generated example (synthetic):

{
  "changeset": {
    "attributes": [
      "string"
    ],
    "categories": [
      {
        "id": "string",
        "is_main_category": false,
        "order": 0
      }
    ],
    "collections": [
      "string"
    ],
    "description": "string",
    "html_description": "string",
    "html_short_description": "string",
    "images": [
      {
        "id": "string",
        "priority": 0
      }
    ],
    "meta_description": "string",
    "meta_title": "string",
    "name": "string",
    "short_description": "string",
    "tags": [
      {
        "key": "string",
        "order": 0
      }
    ]
  },
  "publish_at": "string"
}
Responses5 statuses
StatusDescriptionContent
201Draft created successfullyapplication/json (object)
400Invalid request (e.g. validation error)application/json (object)
401Unauthorized accessapplication/json (object)
409A draft already exists for this productapplication/json (object)
500Internal server errorapplication/json (object)

201 - object

Product Draft Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Product Draft
PropertyTypeRequiredDetails
app_idstringNo-
changesetobjectNo-
created_atstringNo-
idstringNo-
product_idstringNo-
publish_atstringNo-
updated_atstringNo-
Product Draft Changeset
PropertyTypeRequiredDetails
attributesstring[]No-
categoriesobject[]No-
collectionsstring[]No-
descriptionstringNo-
html_descriptionstringNo-
html_short_descriptionstringNo-
imagesobject[]No-
meta_descriptionstringNo-
meta_titlestringNo-
namestringNo-
short_descriptionstringNo-
tagsobject[]No-
{
  "data": {
    "app_id": "string",
    "changeset": {
      "attributes": [
        "string"
      ],
      "categories": [
        {
          "id": null,
          "is_main_category": null,
          "order": null
        }
      ],
      "collections": [
        "string"
      ],
      "description": "string",
      "html_description": "string",
      "html_short_description": "string",
      "images": [
        {
          "id": null,
          "priority": null
        }
      ],
      "meta_description": "string",
      "meta_title": "string",
      "name": "string",
      "short_description": "string",
      "tags": [
        {
          "key": null,
          "order": null
        }
      ]
    },
    "created_at": "string",
    "id": "string",
    "product_id": "string",
    "publish_at": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

409 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/draft
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Product Drafts
  • OpenAPI summary: Create Product Draft

Create Product Draft

# Create Product Draft Creates a new draft changeset for a product. Only one draft can exist per product at a time. Optionally schedules automatic publication at a future time.
POST /api/v1/{team_slug}/{app_slug}/products/{product_id}/draft
Purpose

Creates a new draft changeset for a product.

Required inputs

app_slug path team_slug path product_id path

Primary response

201 ยท Draft created successfully

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/products/{product_id}/draft

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/products/{product_id}/draft` - Summary: Create Product Draft - Description: Creates a new draft changeset for a product. Only one draft can exist per product at a time. Optionally schedules automatic publication at a future time. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/products/{product_id}/draft` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | product_id | path | Yes | string | Product ID | ## Request body - Required: Yes - Description: Draft changeset and optional publish_at - Content: application/json (object) ### Create Product Draft Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `changeset` | object | Yes | - | | `publish_at` | string | No | - | #### Product Draft Changeset | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | string[] | No | - | | `categories` | object[] | No | - | | `collections` | string[] | No | - | | `description` | string | No | - | | `html_description` | string | No | - | | `html_short_description` | string | No | - | | `images` | object[] | No | - | | `meta_description` | string | No | - | | `meta_title` | string | No | - | | `name` | string | No | - | | `short_description` | string | No | - | | `tags` | object[] | No | - | #### Draft Category Ref | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `is_main_category` | boolean | No | - | | `order` | integer | No | - | #### Draft Image Ref | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `priority` | integer | No | - | #### Draft Tag Ref | Property | Type | Required | Details | | --- | --- | --- | --- | | `key` | string | No | - | | `order` | integer | No | - | **Generated example (synthetic):** ```json { "changeset": { "attributes": [ "string" ], "categories": [ { "id": "string", "is_main_category": false, "order": 0 } ], "collections": [ "string" ], "description": "string", "html_description": "string", "html_short_description": "string", "images": [ { "id": "string", "priority": 0 } ], "meta_description": "string", "meta_title": "string", "name": "string", "short_description": "string", "tags": [ { "key": "string", "order": 0 } ] }, "publish_at": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 201 | Draft created successfully | application/json (object) | | 400 | Invalid request (e.g. validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 409 | A draft already exists for this product | application/json (object) | | 500 | Internal server error | application/json (object) | ### 201 - object #### Product Draft Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | 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 | No | - | ##### Product Draft | Property | Type | Required | Details | | --- | --- | --- | --- | | `app_id` | string | No | - | | `changeset` | object | No | - | | `created_at` | string | No | - | | `id` | string | No | - | | `product_id` | string | No | - | | `publish_at` | string | No | - | | `updated_at` | string | No | - | ##### Product Draft Changeset | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | string[] | No | - | | `categories` | object[] | No | - | | `collections` | string[] | No | - | | `description` | string | No | - | | `html_description` | string | No | - | | `html_short_description` | string | No | - | | `images` | object[] | No | - | | `meta_description` | string | No | - | | `meta_title` | string | No | - | | `name` | string | No | - | | `short_description` | string | No | - | | `tags` | object[] | No | - |
Generated example (synthetic) ```json { "data": { "app_id": "string", "changeset": { "attributes": [ "string" ], "categories": [ { "id": null, "is_main_category": null, "order": null } ], "collections": [ "string" ], "description": "string", "html_description": "string", "html_short_description": "string", "images": [ { "id": null, "priority": null } ], "meta_description": "string", "meta_title": "string", "name": "string", "short_description": "string", "tags": [ { "key": null, "order": null } ] }, "created_at": "string", "id": "string", "product_id": "string", "publish_at": "string", "updated_at": "string" }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 409 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/products/{product_id}/draft` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/products/{product_id}/draft` - OpenAPI tag: Product Drafts - OpenAPI summary: Create Product Draft