Skip to main content
GET
/
v1
/
variant_options
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/variant_options/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "473b201d-cb20-4459-bea4-ec18632214ec",
  "object": "variant_option",
  "display_type": "radio",
  "metadata": {},
  "name": "Color",
  "position": 0,
  "values": [],
  "product": "86a0d8b7-56dd-4a98-8570-9a025f071340",
  "created_at": 1767909787,
  "updated_at": 1767909787
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
display_type
string

The display type of the variant option – one of "radio" or "dropdown".

​
name
string

The variant option's name – i.e. Size, Color, etc.

​
position
integer | null

The ordering position of this variant option when displayed to customers.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
product

Expandable – The associated product ID.

​
values
array

A list of values for this variant option. (These are inferred from the values set on variants.)

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.