chore(docs): Updated API Reference (v2) (#8929)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot] authored and GitHub committed 2024-09-02 07:45:24 +00:00
1 parent 2c034774f0
commit d6dcda5b8f
355 files changed
+66808 -5101

No files matched your search

@@ -1,7 +1,7 @@
/**
* @schema StoreCart
* type: object
* description: The cart's details.
* description: The cart's parent.
* x-schemaName: StoreCart
* required:
* - id
@@ -32,322 +32,322 @@
* id:
* type: string
* title: id
* description: The cart's ID.
* description: The parent's ID.
* region:
* $ref: "#/components/schemas/BaseRegion"
* region_id:
* type: string
* title: region_id
* description: The cart's region id.
* description: The parent's region id.
* customer_id:
* type: string
* title: customer_id
* description: The cart's customer id.
* description: The parent's customer id.
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The cart's sales channel id.
* description: The parent's sales channel id.
* email:
* type: string
* title: email
* description: The cart's email.
* description: The parent's email.
* format: email
* currency_code:
* type: string
* title: currency_code
* description: The cart's currency code.
* description: The parent's currency code.
* shipping_address:
* $ref: "#/components/schemas/BaseCartAddress"
* billing_address:
* $ref: "#/components/schemas/BaseCartAddress"
* items:
* type: array
* description: The cart's items.
* description: The parent's items.
* items:
* $ref: "#/components/schemas/BaseCartLineItem"
* shipping_methods:
* type: array
* description: The cart's shipping methods.
* description: The parent's shipping methods.
* items:
* $ref: "#/components/schemas/BaseCartShippingMethod"
* payment_collection:
* $ref: "#/components/schemas/BasePaymentCollection"
* metadata:
* type: object
* description: The cart's metadata.
* description: The parent's metadata.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The cart's created at.
* description: The parent's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The cart's updated at.
* description: The parent's updated at.
* original_item_total:
* oneOf:
* - type: string
* title: original_item_total
* description: The cart's original item total.
* description: The parent's original item total.
* - type: number
* title: original_item_total
* description: The cart's original item total.
* description: The parent's original item total.
* - type: string
* title: original_item_total
* description: The cart's original item total.
* description: The parent's original item total.
* - $ref: "#/components/schemas/IBigNumber"
* original_item_subtotal:
* oneOf:
* - type: string
* title: original_item_subtotal
* description: The cart's original item subtotal.
* description: The parent's original item subtotal.
* - type: number
* title: original_item_subtotal
* description: The cart's original item subtotal.
* description: The parent's original item subtotal.
* - type: string
* title: original_item_subtotal
* description: The cart's original item subtotal.
* description: The parent's original item subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_item_tax_total:
* oneOf:
* - type: string
* title: original_item_tax_total
* description: The cart's original item tax total.
* description: The parent's original item tax total.
* - type: number
* title: original_item_tax_total
* description: The cart's original item tax total.
* description: The parent's original item tax total.
* - type: string
* title: original_item_tax_total
* description: The cart's original item tax total.
* description: The parent's original item tax total.
* - $ref: "#/components/schemas/IBigNumber"
* item_total:
* oneOf:
* - type: string
* title: item_total
* description: The cart's item total.
* description: The parent's item total.
* - type: number
* title: item_total
* description: The cart's item total.
* description: The parent's item total.
* - type: string
* title: item_total
* description: The cart's item total.
* description: The parent's item total.
* - $ref: "#/components/schemas/IBigNumber"
* item_subtotal:
* oneOf:
* - type: string
* title: item_subtotal
* description: The cart's item subtotal.
* description: The parent's item subtotal.
* - type: number
* title: item_subtotal
* description: The cart's item subtotal.
* description: The parent's item subtotal.
* - type: string
* title: item_subtotal
* description: The cart's item subtotal.
* description: The parent's item subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* item_tax_total:
* oneOf:
* - type: string
* title: item_tax_total
* description: The cart's item tax total.
* description: The parent's item tax total.
* - type: number
* title: item_tax_total
* description: The cart's item tax total.
* description: The parent's item tax total.
* - type: string
* title: item_tax_total
* description: The cart's item tax total.
* description: The parent's item tax total.
* - $ref: "#/components/schemas/IBigNumber"
* original_total:
* oneOf:
* - type: string
* title: original_total
* description: The cart's original total.
* description: The parent's original total.
* - type: number
* title: original_total
* description: The cart's original total.
* description: The parent's original total.
* - type: string
* title: original_total
* description: The cart's original total.
* description: The parent's original total.
* - $ref: "#/components/schemas/IBigNumber"
* original_subtotal:
* oneOf:
* - type: string
* title: original_subtotal
* description: The cart's original subtotal.
* description: The parent's original subtotal.
* - type: number
* title: original_subtotal
* description: The cart's original subtotal.
* description: The parent's original subtotal.
* - type: string
* title: original_subtotal
* description: The cart's original subtotal.
* description: The parent's original subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_tax_total:
* oneOf:
* - type: string
* title: original_tax_total
* description: The cart's original tax total.
* description: The parent's original tax total.
* - type: number
* title: original_tax_total
* description: The cart's original tax total.
* description: The parent's original tax total.
* - type: string
* title: original_tax_total
* description: The cart's original tax total.
* description: The parent's original tax total.
* - $ref: "#/components/schemas/IBigNumber"
* total:
* oneOf:
* - type: string
* title: total
* description: The cart's total.
* description: The parent's total.
* - type: number
* title: total
* description: The cart's total.
* description: The parent's total.
* - type: string
* title: total
* description: The cart's total.
* description: The parent's total.
* - $ref: "#/components/schemas/IBigNumber"
* subtotal:
* oneOf:
* - type: string
* title: subtotal
* description: The cart's subtotal.
* description: The parent's subtotal.
* - type: number
* title: subtotal
* description: The cart's subtotal.
* description: The parent's subtotal.
* - type: string
* title: subtotal
* description: The cart's subtotal.
* description: The parent's subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* tax_total:
* oneOf:
* - type: string
* title: tax_total
* description: The cart's tax total.
* description: The parent's tax total.
* - type: number
* title: tax_total
* description: The cart's tax total.
* description: The parent's tax total.
* - type: string
* title: tax_total
* description: The cart's tax total.
* description: The parent's tax total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_total:
* oneOf:
* - type: string
* title: discount_total
* description: The cart's discount total.
* description: The parent's discount total.
* - type: number
* title: discount_total
* description: The cart's discount total.
* description: The parent's discount total.
* - type: string
* title: discount_total
* description: The cart's discount total.
* description: The parent's discount total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_tax_total:
* oneOf:
* - type: string
* title: discount_tax_total
* description: The cart's discount tax total.
* description: The parent's discount tax total.
* - type: number
* title: discount_tax_total
* description: The cart's discount tax total.
* description: The parent's discount tax total.
* - type: string
* title: discount_tax_total
* description: The cart's discount tax total.
* description: The parent's discount tax total.
* - $ref: "#/components/schemas/IBigNumber"
* gift_card_total:
* oneOf:
* - type: string
* title: gift_card_total
* description: The cart's gift card total.
* description: The parent's gift card total.
* - type: number
* title: gift_card_total
* description: The cart's gift card total.
* description: The parent's gift card total.
* - type: string
* title: gift_card_total
* description: The cart's gift card total.
* description: The parent's gift card total.
* - $ref: "#/components/schemas/IBigNumber"
* gift_card_tax_total:
* oneOf:
* - type: string
* title: gift_card_tax_total
* description: The cart's gift card tax total.
* description: The parent's gift card tax total.
* - type: number
* title: gift_card_tax_total
* description: The cart's gift card tax total.
* description: The parent's gift card tax total.
* - type: string
* title: gift_card_tax_total
* description: The cart's gift card tax total.
* description: The parent's gift card tax total.
* - $ref: "#/components/schemas/IBigNumber"
* shipping_total:
* oneOf:
* - type: string
* title: shipping_total
* description: The cart's shipping total.
* description: The parent's shipping total.
* - type: number
* title: shipping_total
* description: The cart's shipping total.
* description: The parent's shipping total.
* - type: string
* title: shipping_total
* description: The cart's shipping total.
* description: The parent's shipping total.
* - $ref: "#/components/schemas/IBigNumber"
* shipping_subtotal:
* oneOf:
* - type: string
* title: shipping_subtotal
* description: The cart's shipping subtotal.
* description: The parent's shipping subtotal.
* - type: number
* title: shipping_subtotal
* description: The cart's shipping subtotal.
* description: The parent's shipping subtotal.
* - type: string
* title: shipping_subtotal
* description: The cart's shipping subtotal.
* description: The parent's shipping subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* shipping_tax_total:
* oneOf:
* - type: string
* title: shipping_tax_total
* description: The cart's shipping tax total.
* description: The parent's shipping tax total.
* - type: number
* title: shipping_tax_total
* description: The cart's shipping tax total.
* description: The parent's shipping tax total.
* - type: string
* title: shipping_tax_total
* description: The cart's shipping tax total.
* description: The parent's shipping tax total.
* - $ref: "#/components/schemas/IBigNumber"
* original_shipping_total:
* oneOf:
* - type: string
* title: original_shipping_total
* description: The cart's original shipping total.
* description: The parent's original shipping total.
* - type: number
* title: original_shipping_total
* description: The cart's original shipping total.
* description: The parent's original shipping total.
* - type: string
* title: original_shipping_total
* description: The cart's original shipping total.
* description: The parent's original shipping total.
* - $ref: "#/components/schemas/IBigNumber"
* original_shipping_subtotal:
* oneOf:
* - type: string
* title: original_shipping_subtotal
* description: The cart's original shipping subtotal.
* description: The parent's original shipping subtotal.
* - type: number
* title: original_shipping_subtotal
* description: The cart's original shipping subtotal.
* description: The parent's original shipping subtotal.
* - type: string
* title: original_shipping_subtotal
* description: The cart's original shipping subtotal.
* description: The parent's original shipping subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_shipping_tax_total:
* oneOf:
* - type: string
* title: original_shipping_tax_total
* description: The cart's original shipping tax total.
* description: The parent's original shipping tax total.
* - type: number
* title: original_shipping_tax_total
* description: The cart's original shipping tax total.
* description: The parent's original shipping tax total.
* - type: string
* title: original_shipping_tax_total
* description: The cart's original shipping tax total.
* description: The parent's original shipping tax total.
* - $ref: "#/components/schemas/IBigNumber"
*
*/