SmakeSmake API Docs
EndpointsVariants

Show a variant

Open in ClaudeOpen in ChatGPT
GET
/variants/{id}

Returns a single variant including its current customizations.

AuthorizationbearerAuth

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*integer

Query Parameters

expand?string

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"

Response Body

application/json

application/json

Request example
curl -X GET "https://example.com/variants/0" \  -H "Accept: application/json"
{  "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"  }}

List variants GET

Returns a paginated collection of variants. **Filtering** - `?filter[id]=1` or `?filter[id]=1,2,3` — one or more variant IDs - `?filter[sku]=TS-100-BLK-M` — by SKU - `?filter[since_id]=1` — IDs greater than the given ID **Expanding objects** — `?expand=product`, `?expand=customizations` — see [Basic Usage → Expanding Objects](/docs/checkout/2022-02-01/basic/expanding-objects).

Design a variant POST

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](/docs/checkout/2022-02-01/basic/polling) and [Webhooks](/docs/checkout/2022-02-01/basic/webhooks). Each customization targets a view area of the product and references either an existing logo/text or an inline media object.