List variants

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.

AuthorizationbearerAuth

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Query Parameters

page?integer

Page number — see Basic Usage → Pagination.

Default1

per_page?integer

Rangevalue <= 100

Default25

filter[id]?string

filter[sku]?string

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`

Request example

curl -X GET "https://example.com/variants" \  -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"    }  ],  "meta": {    "current_page": 0,    "per_page": 0,    "total": 0  }}