Schema
Modifier (Order)
Represents a modifier that has been applied against an order line item.
Overview
Properties
uuid
string
The unique identifier.
Format
uuid
source_modifier_uuid
string | null
The UUID of the original (catalog) modifier that was used to create this instance. For ad-hoc modifiers, this field will be `null`.
Format
uuid
Nullable
Yes
name
string
The name of the modifier at the time the order was placed.
Example
Extra Cheese
Min length
1
Max length
255
qty
number
The quantity that the customer requested.
Minimum
1
unit_price
reference
The value of a single unit of the modifier.
References Money.
sub_total
reference
The unit price of the modifier, multiplied by the quantity.
References Money.
total
reference
The total value of the modifier (this will be the same as `sub_total`).
References Money.
Used by
Raw YAML
Download source
title: Modifier (Order)
type: object
properties:
uuid:
type: string
format: uuid
description: The unique identifier.
source_modifier_uuid:
type:
- string
- 'null'
description: |-
The UUID of the original (catalog) modifier that was used to create this instance.
For ad-hoc modifiers, this field will be `null`.
format: uuid
name:
type: string
minLength: 1
maxLength: 255
example: Extra Cheese
description: The name of the modifier at the time the order was placed.
qty:
type: number
minimum: 1
description: The quantity that the customer requested.
unit_price:
$ref: ./Money.yaml
description: The value of a single unit of the modifier.
sub_total:
$ref: ./Money.yaml
description: 'The unit price of the modifier, multiplied by the quantity.'
total:
$ref: ./Money.yaml
description: The total value of the modifier (this will be the same as `sub_total`).
description: Represents a modifier that has been applied against an order line item.
x-tags:
- Orders