Get Product Draft

Retrieve the unpublished overlay for a product, or the live product when none exists.

When has_draft is true, the body is the overlay — buyers still see the live product returned by Get Product. When has_draft is false, the body is that live product, so a draft read always has a starting point. checkout_url is always the live checkout. preview_url is a fresh signed checkout preview — see Draft preview. Nested variants include unpublished overlay variants that do not appear on Get Product, omit archived overlay variants, and include always-present upsells ([] when none). A file attached by a draft write has download_url: null until the draft is published — see Downloadable files.

draft_version is present even when has_draft is false. draft_updated_at is null when there is no overlay. Send draft_version on every draft write. See Status and has_draft.

To change the overlay, see Update Product Draft. To drop it, see Discard Product Draft. Nested overlay variants are listed at Get Product Draft Variants.

Request

GET /products/{id}/draft

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Product UUID

Query Parameters

Parameter	Type	Required	Default	Description
include	string	No	—	Comma-separated tokens. custom_fields and waitlist_custom_fields expand overlay checkout / waitlist field definitions — see Custom Fields. styles, settings, and media expand overlay checkout appearance — see Checkout appearance. Unknown tokens are ignored. Omitted keys stay null.

Example Request

curl -X GET "https://cart.easy.tools/api/v1/products/0632bef5-c308-42cd-9cba-89a7a4f722bb/draft" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Expand overlay checkout appearance:

curl -X GET "https://cart.easy.tools/api/v1/products/0632bef5-c308-42cd-9cba-89a7a4f722bb/draft?include=styles,settings,media" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Expand overlay checkout and waitlist custom fields:

curl -X GET "https://cart.easy.tools/api/v1/products/0632bef5-c308-42cd-9cba-89a7a4f722bb/draft?include=custom_fields,waitlist_custom_fields" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response

Success Response (200)

Returns the overlay when one exists, or the live product when it does not. Shared product fields match Get Product.

No Overlay

{
  "id": "0632bef5-c308-42cd-9cba-89a7a4f722bb",
  "status": "published",
  "name": "Premium Coffee Beans",
  "description": "High-quality arabica coffee beans from Colombia",
  "slug": "premium-coffee-beans",
  "image_url": "https://example.com/images/coffee-beans.jpg",
  "checkout_url": "https://cart.easy.tools/checkout/0632bef5-c308-42cd-9cba-89a7a4f722bb",
  "currency": "usd",
  "file": {
    "name": "My ebook.pdf",
    "url": "https://mysite.com/ebook.pdf",
    "download_url": "https://cart.easy.tools/api/v1/product-files/9c1e7f42-3b8a-4d6e-9f10-2a5c7d3e8b41/download?expires=1749384000&signature=abc123"
  },
  "files": [
    {
      "name": "My ebook.pdf",
      "url": "https://mysite.com/ebook.pdf",
      "download_url": "https://cart.easy.tools/api/v1/product-files/9c1e7f42-3b8a-4d6e-9f10-2a5c7d3e8b41/download?expires=1749384000&signature=abc123"
    },
    {
      "name": "Bonus chapter.pdf",
      "url": "https://mysite.com/bonus-chapter.pdf",
      "download_url": "https://cart.easy.tools/api/v1/product-files/4f7a2d18-6c93-4e5b-8a21-0d9e3f6b7c52/download?expires=1749384000&signature=abc123"
    }
  ],
  "active_from": "2026-01-01T00:00:00+00:00",
  "active_until": "2026-12-31T23:59:59+00:00",
  "show_active_until_counter": true,
  "redirect_url": "https://mysite.com/thank-you",
  "redirect_time": 5,
  "add_redirect_params": true,
  "webhook_url": "https://mysite.com/webhook",
  "terms_url": "https://mysite.com/terms",
  "policy_url": "https://mysite.com/privacy",
  "contact_email": "support@mysite.com",
  "refund_days": 14,
  "delegable": false,
  "show_discount_field": true,
  "hide_tax_id_field": false,
  "require_tax_id": false,
  "photo_zoomable": true,
  "show_confetti": true,
  "generate_qr_code": false,
  "show_delegation": false,
  "delegation_label": null,
  "delegable_if_multiple": false,
  "has_shipping": false,
  "delivery_enabled": false,
  "delivery_service": null,
  "delivery_address_optional": true,
  "delivery_options": null,
  "shipping_phone_required": false,
  "phone_tooltip": null,
  "mandatory_consent": null,
  "optional_consent": null,
  "digital_consent": null,
  "newsletter_consent": null,
  "newsletter_consent_required": false,
  "newsletter_discount": null,
  "invoice_remarks": null,
  "vat_rate": null,
  "gtu_code": null,
  "flat_rate": null,
  "exempt_tax_kind": null,
  "tax_category": null,
  "dashboard_header": null,
  "long_description": null,
  "cta_text": null,
  "cta_url": null,
  "contact_phone": null,
  "contact_website_url": null,
  "contact_additional_info": null,
  "footer_text": "",
  "waitlist_enabled": false,
  "waitlist_require_first_name": false,
  "waitlist_require_last_name": false,
  "qr_code_info": null,
  "credits": null,
  "reset_credits": false,
  "variants": [
    {
      "id": "d91c65aa-b221-4aa4-b626-cf0d8a198749",
      "status": "published",
      "type": "one_time",
      "recurring_options": null,
      "name": "250g Package",
      "amount": 1999,
      "currency": "usd",
      "checkout_url": "https://cart.easy.tools/checkout/premium-coffee?plan=price_123",
      "custom_id": "SKU-250G",
      "is_hidden": false,
      "trial_period_days": null,
      "active_cycles": null,
      "cancel_early": false,
      "keep_access_after_expiring": false,
      "allow_multiple_subscriptions": false,
      "active_days": 365,
      "quantity": 100,
      "has_quantity": true,
      "old_price": 29,
      "active_from": "2026-01-01T00:00:00+00:00",
      "active_until": "2026-12-31T23:59:59+00:00",
      "access_until": null,
      "show_active_until_counter": true,
      "tax_behavior": "exclusive",
      "refund_days": 14,
      "redirect_url": "https://mysite.com/thank-you",
      "redirect_time": 5,
      "file": {
        "name": "Product Guide.pdf",
        "url": "https://mysite.com/files/guide.pdf",
        "download_url": "https://cart.easy.tools/api/v1/product-files/b8d4e6a2-51c7-4f39-9e0b-3a7c2d18f5e6/download?expires=1749384000&signature=abc123"
      },
      "files": [
        {
          "name": "Product Guide.pdf",
          "url": "https://mysite.com/files/guide.pdf",
          "download_url": "https://cart.easy.tools/api/v1/product-files/b8d4e6a2-51c7-4f39-9e0b-3a7c2d18f5e6/download?expires=1749384000&signature=abc123"
        },
        {
          "name": "Quick Start.pdf",
          "url": "https://mysite.com/files/quick-start.pdf",
          "download_url": "https://cart.easy.tools/api/v1/product-files/2e9b5c71-8d40-4a6f-b312-7f5a9c04d8e3/download?expires=1749384000&signature=abc123"
        }
      ],
      "invoice_remarks": "Thank you for your purchase!",
      "has_shipping": false,
      "delivery_enabled": false,
      "delivery_service": null,
      "delivery_address_optional": true,
      "delivery_options": null,
      "shipping_phone_required": false,
      "phone_tooltip": null,
      "mandatory_consent": null,
      "optional_consent": null,
      "digital_consent": null,
      "newsletter_consent": null,
      "newsletter_consent_required": false,
      "newsletter_discount": null,
      "vat_rate": null,
      "gtu_code": null,
      "flat_rate": null,
      "exempt_tax_kind": null,
      "tax_category": null,
      "dashboard_header": null,
      "long_description": null,
      "cta_text": null,
      "cta_url": null,
      "credits": null,
      "show_net_price": false,
      "pay_what_you_want": null,
      "purchase_button_text": null,
      "upsells": [],
      "custom_fields": null
    },
    {
      "id": "e903c6d6-163e-4080-a99a-4ee5a1e4f17a",
      "status": "published",
      "type": "recurring",
      "recurring_options": {
        "interval": "month",
        "interval_count": 1
      },
      "name": "Monthly Subscription - 250g",
      "amount": 1799,
      "currency": "usd",
      "checkout_url": null,
      "custom_id": null,
      "is_hidden": false,
      "trial_period_days": 14,
      "active_cycles": 12,
      "cancel_early": true,
      "keep_access_after_expiring": false,
      "allow_multiple_subscriptions": false,
      "active_days": null,
      "quantity": null,
      "has_quantity": false,
      "old_price": null,
      "active_from": null,
      "active_until": null,
      "access_until": null,
      "show_active_until_counter": null,
      "tax_behavior": "exclusive",
      "refund_days": null,
      "redirect_url": null,
      "redirect_time": null,
      "file": null,
      "files": [],
      "invoice_remarks": null,
      "has_shipping": false,
      "delivery_enabled": false,
      "delivery_service": null,
      "delivery_address_optional": true,
      "delivery_options": null,
      "shipping_phone_required": false,
      "phone_tooltip": null,
      "mandatory_consent": null,
      "optional_consent": null,
      "digital_consent": null,
      "newsletter_consent": null,
      "newsletter_consent_required": false,
      "newsletter_discount": null,
      "vat_rate": null,
      "gtu_code": null,
      "flat_rate": null,
      "exempt_tax_kind": null,
      "tax_category": null,
      "dashboard_header": null,
      "long_description": null,
      "cta_text": null,
      "cta_url": null,
      "credits": null,
      "show_net_price": false,
      "pay_what_you_want": null,
      "purchase_button_text": null,
      "upsells": [],
      "custom_fields": null
    }
  ],
  "custom_fields": null,
  "waitlist_custom_fields": null,
  "styles": null,
  "settings": null,
  "media": null,
  "has_draft": false,
  "draft_version": 7,
  "draft_updated_at": null,
  "preview_url": "https://cart.easy.tools/checkout-preview/0632bef5-c308-42cd-9cba-89a7a4f722bb?expires=1749384000&signature=abc123"
}

With Overlay

This product is not on sale (status: draft) and still has an overlay. name and variants are the overlay; checkout_url still points at live checkout.

{
  "id": "61197fd4-74ff-4b1c-9d21-33b42a10e091",
  "status": "draft",
  "name": "Organic Tea Selection - winter",
  "description": null,
  "slug": "organic-tea-selection",
  "image_url": null,
  "checkout_url": "https://cart.easy.tools/checkout/61197fd4-74ff-4b1c-9d21-33b42a10e091",
  "currency": "eur",
  "file": null,
  "files": [],
  "active_from": null,
  "active_until": null,
  "show_active_until_counter": null,
  "redirect_url": null,
  "redirect_time": null,
  "add_redirect_params": null,
  "webhook_url": null,
  "terms_url": null,
  "policy_url": null,
  "contact_email": null,
  "refund_days": null,
  "delegable": false,
  "show_discount_field": true,
  "hide_tax_id_field": false,
  "require_tax_id": false,
  "photo_zoomable": false,
  "show_confetti": false,
  "generate_qr_code": false,
  "show_delegation": false,
  "delegation_label": null,
  "delegable_if_multiple": false,
  "has_shipping": false,
  "delivery_enabled": false,
  "delivery_service": null,
  "delivery_address_optional": true,
  "delivery_options": null,
  "shipping_phone_required": false,
  "phone_tooltip": null,
  "mandatory_consent": null,
  "optional_consent": null,
  "digital_consent": null,
  "newsletter_consent": null,
  "newsletter_consent_required": false,
  "newsletter_discount": null,
  "invoice_remarks": null,
  "vat_rate": null,
  "gtu_code": null,
  "flat_rate": null,
  "exempt_tax_kind": null,
  "tax_category": null,
  "dashboard_header": null,
  "long_description": null,
  "cta_text": null,
  "cta_url": null,
  "contact_phone": null,
  "contact_website_url": null,
  "contact_additional_info": null,
  "footer_text": "",
  "waitlist_enabled": false,
  "waitlist_require_first_name": false,
  "waitlist_require_last_name": false,
  "qr_code_info": null,
  "credits": null,
  "reset_credits": false,
  "variants": [
    {
      "id": "c2f91a04-8e3b-4a17-b6d5-1e9c0a7f4b28",
      "status": "published",
      "type": "one_time",
      "recurring_options": null,
      "name": "Sampler Tin",
      "amount": 1299,
      "currency": "eur",
      "checkout_url": "https://cart.easy.tools/checkout/61197fd4-74ff-4b1c-9d21-33b42a10e091?plan=price_789",
      "custom_id": null,
      "is_hidden": false,
      "trial_period_days": null,
      "active_cycles": null,
      "cancel_early": false,
      "keep_access_after_expiring": false,
      "allow_multiple_subscriptions": false,
      "active_days": null,
      "quantity": null,
      "has_quantity": false,
      "old_price": null,
      "active_from": null,
      "active_until": null,
      "access_until": null,
      "show_active_until_counter": null,
      "tax_behavior": "exclusive",
      "refund_days": null,
      "redirect_url": null,
      "redirect_time": null,
      "file": null,
      "files": [],
      "invoice_remarks": null,
      "has_shipping": false,
      "delivery_enabled": false,
      "delivery_service": null,
      "delivery_address_optional": true,
      "delivery_options": null,
      "shipping_phone_required": false,
      "phone_tooltip": null,
      "mandatory_consent": null,
      "optional_consent": null,
      "digital_consent": null,
      "newsletter_consent": null,
      "newsletter_consent_required": false,
      "newsletter_discount": null,
      "vat_rate": null,
      "gtu_code": null,
      "flat_rate": null,
      "exempt_tax_kind": null,
      "tax_category": null,
      "dashboard_header": null,
      "long_description": null,
      "cta_text": null,
      "cta_url": null,
      "credits": null,
      "show_net_price": false,
      "pay_what_you_want": null,
      "purchase_button_text": null,
      "upsells": [],
      "custom_fields": null
    },
    {
      "id": "a4c8e21f-7b05-4d93-9e16-5f8a0c3d2b71",
      "status": "published",
      "type": "one_time",
      "recurring_options": null,
      "name": "Winter Gift Box",
      "amount": 3999,
      "currency": "eur",
      "checkout_url": "https://cart.easy.tools/checkout/61197fd4-74ff-4b1c-9d21-33b42a10e091?plan=price_790",
      "custom_id": null,
      "is_hidden": false,
      "trial_period_days": null,
      "active_cycles": null,
      "cancel_early": false,
      "keep_access_after_expiring": false,
      "allow_multiple_subscriptions": false,
      "active_days": null,
      "quantity": null,
      "has_quantity": false,
      "old_price": null,
      "active_from": null,
      "active_until": null,
      "access_until": null,
      "show_active_until_counter": null,
      "tax_behavior": "exclusive",
      "refund_days": null,
      "redirect_url": null,
      "redirect_time": null,
      "file": null,
      "files": [],
      "invoice_remarks": null,
      "has_shipping": false,
      "delivery_enabled": false,
      "delivery_service": null,
      "delivery_address_optional": true,
      "delivery_options": null,
      "shipping_phone_required": false,
      "phone_tooltip": null,
      "mandatory_consent": null,
      "optional_consent": null,
      "digital_consent": null,
      "newsletter_consent": null,
      "newsletter_consent_required": false,
      "newsletter_discount": null,
      "vat_rate": null,
      "gtu_code": null,
      "flat_rate": null,
      "exempt_tax_kind": null,
      "tax_category": null,
      "dashboard_header": null,
      "long_description": null,
      "cta_text": null,
      "cta_url": null,
      "credits": null,
      "show_net_price": false,
      "pay_what_you_want": null,
      "purchase_button_text": null,
      "upsells": [],
      "custom_fields": null
    }
  ],
  "custom_fields": null,
  "waitlist_custom_fields": null,
  "styles": null,
  "settings": null,
  "media": null,
  "has_draft": true,
  "draft_version": 3,
  "draft_updated_at": "2026-09-10T13:54:37+00:00",
  "preview_url": "https://cart.easy.tools/checkout-preview/61197fd4-74ff-4b1c-9d21-33b42a10e091?expires=1749384000&signature=abc123"
}

Response Fields

Shared fields — including has_draft — are listed on Get Product. Draft reads add:

Field	Type	Nullable	Description
draft_version	integer	No	Version of the unpublished overlay. Present even when has_draft is false.
draft_updated_at	string	Yes	When the overlay was last saved (ISO 8601). null when has_draft is false.
preview_url	string	No	Temporary signed checkout preview. Always reminted. Expires after about one hour. Distinct from live checkout_url. See Draft preview.

Error Responses

Bad Request (400)

{
  "message": "Invalid product ID"
}

Product Not Found (404)

Returned when the UUID does not exist, belongs to another store, or points at an archived product. Only draft and published products can be retrieved.

{
  "message": "Product with ID 0632bef5-c308-42cd-9cba-89a7a4f722bb not found"
}