RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Admin / POS

product_option

An option axis on a product (Size, Colour, …).

Defines option names for a product (Size, Colour, …). Values live on product_option_value; variants pick those values.

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The product_option object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

7 fields on product_option. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Option id.

Type
id: string

name

string

Option axis name (e.g. "Size").

Type
name: string

position

number

Sort order among options.

Type
position: number

isActive

boolean

Whether the option is active.

Type
isActive: boolean

values

array of product_option_value

Allowed values for this option.

Type
values: product_option_value[]

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp.

Type
updatedAt: string

Related