658339767b
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
47 lines
1.4 KiB
YAML
47 lines
1.4 KiB
YAML
title: Shipping Option Requirement
|
|
description: >-
|
|
A shipping option requirement defines conditions that a Cart must satisfy for
|
|
the Shipping Option to be available for usage in the Cart.
|
|
type: object
|
|
required:
|
|
- amount
|
|
- deleted_at
|
|
- id
|
|
- shipping_option_id
|
|
- type
|
|
properties:
|
|
id:
|
|
description: The shipping option requirement's ID
|
|
type: string
|
|
example: sor_01G1G5V29AB4CTNDRFSRWSRKWD
|
|
shipping_option_id:
|
|
description: The ID of the shipping option that the requirements belong to.
|
|
type: string
|
|
example: so_01G1G5V27GYX4QXNARRQCW1N8T
|
|
shipping_option:
|
|
description: The details of the shipping option that the requirements belong to.
|
|
x-expandable: shipping_option
|
|
nullable: true
|
|
type: object
|
|
type:
|
|
description: >-
|
|
The type of the requirement, this defines how the value will be compared
|
|
to the Cart's total. `min_subtotal` requirements define the minimum
|
|
subtotal that is needed for the Shipping Option to be available, while the
|
|
`max_subtotal` defines the maximum subtotal that the Cart can have for the
|
|
Shipping Option to be available.
|
|
type: string
|
|
enum:
|
|
- min_subtotal
|
|
- max_subtotal
|
|
example: min_subtotal
|
|
amount:
|
|
description: The amount to compare the Cart subtotal to.
|
|
type: integer
|
|
example: 100
|
|
deleted_at:
|
|
description: The date with timezone at which the resource was deleted.
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|