fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
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
|