Skip to main content

option_object

idinteger

Record ID

typestring

Option type

Possible values: [text, multiline_text, check_box, radio_button]

statusstring

active - option is active archived - option is disabled hidden - option is hidden

Possible values: [active, archived, hidden]

title_rustring

Option name (RU)

title_enstring

Option name (EN)

comment_rustring

Option comment (RU)

comment_enstringnullable

Option comment (EN)

is_requiredboolean

Whether the option is required

Default value: false
is_price_modifier_hiddenboolean

Whether price modifiers are hidden

Default value: false
positioninteger

Option position ASC

Default value: 0
has_splitted_productsboolean

Whether splitted products exist

Default value: false
variants object[]
  • Array [
  • idinteger

    Record ID

    title_rustring

    Variant name (RU)

    title_enstring

    Variant name (EN)

    pricenumber

    Variant price

    discount_typestring

    fixed - absolute value percent - percent value

    Possible values: [fixed, percent]

    impact_typestring

    increase - increase price decrease - decrease price

    Possible values: [increase, decrease]

    is_defaultboolean

    Whether the variant is selected by default

    Default value: false
    statusstring

    active - variant is active archived - variant is disabled hidden - variant is hidden

    Possible values: [active, archived, hidden]

    positioninteger

    Variant position ASC

    Default value: 0
    in_stock_products_countinteger

    Quantity of splitted products in stock

    Default value: 0
    sold_products_countinteger

    Quantity of sold splitted products

    Default value: 0
  • ]
  • option_object
    {
    "id": 0,
    "type": "text",
    "status": "active",
    "title_ru": "string",
    "title_en": "string",
    "comment_ru": "string",
    "comment_en": "string",
    "is_required": false,
    "is_price_modifier_hidden": false,
    "position": 0,
    "has_splitted_products": false,
    "variants": [
    {
    "id": 0,
    "title_ru": "string",
    "title_en": "string",
    "price": 0,
    "discount_type": "fixed",
    "impact_type": "increase",
    "is_default": false,
    "status": "active",
    "position": 0,
    "in_stock_products_count": 0,
    "sold_products_count": 0
    }
    ]
    }