SmakeSmake API Docs
EndpointsVariants

Design a variant

Open in ClaudeOpen in ChatGPT
POST
/variants/{id}/design

Applies customizations (logos, texts) to a variant. Designs are processed asynchronously — poll the variant or subscribe to the variant.completed / variant.failed webhook events to get the result — see Basic Usage → Polling and Webhooks.

Each customization targets a view area of the product and references either an existing logo/text or an inline media object.

AuthorizationbearerAuth

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token — how to obtain one is described under Setup → Authentication.

In: header

Path Parameters

id*integer

Header Parameters

Accept*"application/json"

The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).

Default"application/json"

Value in

  • "application/json"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

Request example
curl -X POST "https://example.com/variants/0/design" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -d '{    "customizations": [      {}    ]  }'
{  "data": {    "id": 0,    "sku": "string",    "name": "string",    "state": "open",    "price": {      "amount": 0,      "currency": "string"    },    "customizations": [      {        "id": 0,        "hash": "string",        "view_area": "string",        "production_method": {          "id": 0,          "handle": "string",          "name": "string",          "description": "string"        }      }    ],    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Show a variant GET

Returns a single variant including its current customizations.

List orders GET

Returns a collection of created orders. **Filtering** — see [Basic Usage → Filtering](/docs/checkout/2022-02-01/basic/filtering) - `?filter[id]=1,2,3` — one or more order IDs - `?filter[state]=completed` / `cancelled` — by state - `?filter[external_identifier]=organic` — by your own identifier - `?filter[external_reference]=143000` — by your own reference - `?filter[since_id]=1` — IDs greater than the given ID - `?filter[created_at_min]=2025-09-27` / `created_at_max` — created in range - `?filter[updated_at_min]` / `updated_at_max` — updated in range **Expanding objects** ([Basic Usage → Expanding Objects](/docs/checkout/2022-02-01/basic/expanding-objects)) — `?expand=order_type`, `?expand=items.id_tags`, `?expand=items.variant`.