Get Product Draft

Retrieves the draft changeset and metadata for a specific product, including the scheduled publication time if set.

GET/api/v1/{team_slug}/{app_slug}/products/{product_id}/draft

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

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

Retrieves the draft changeset and metadata for a specific product, including the scheduled publication time if set.

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: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/draft
Summary: Get Product Draft
Description: Retrieves the draft changeset and metadata for a specific product, including the scheduled publication time if set.
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

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 bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses

Status	Description	Content
200	Draft retrieved successfully	application/json (object)
401	Unauthorized access	application/json (object)
404	No draft found for this product	application/json (object)
500	Internal server error	application/json (object)

200 - 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	-

{
  "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
}

401 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

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

404 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "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):

{
  "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: GET
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: Get Product Draft