The item modifier object

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "store_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "value": "199.99"
}

A charge added alongside a product's price, such as a bottle deposit.

string

required

Unique identifier for the record.

created_at

string<date-time>

required

When the record was created.

name

string

required

Human-readable item modifier name.

price_tag_label

enum<string> | null

required

Optional shelf-tag classification for bottle deposits or container redemption value.

Available options:

BOTTLE_DEPOSIT,

CRV

store_id

string

required

ID of the store the item modifier belongs to.

Pattern: ^[0-9]+$

tax_behavior

enum<string>

required

Whether the modifier is excluded from tax or inherits the product tax behavior.

Available options:

EXCLUDE,

INHERIT_FROM_STORE_PRODUCT

type

enum<string>

required

Business purpose of the item modifier.

Available options:

bottle_deposit,

custom,

food_modifier

updated_at

string<date-time>

required

When the record was last changed.

value

string

required

Monetary value of the modifier as a decimal string in major/minor currency units.

Pattern: ^[0-9]+(\.[0-9]+)?$

Example:

"199.99"

API

AI tools