docs: add section on retrieve totals for cart items and shipping methods in storefront (#13513)
* docs: add section on retrieve totals for cart items and shipping methods in storefront * change return type * update OAS
This commit is contained in:
@@ -5,17 +5,6 @@ required:
|
||||
- cart
|
||||
- title
|
||||
- id
|
||||
- item_total
|
||||
- item_subtotal
|
||||
- item_tax_total
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
- requires_shipping
|
||||
- is_discountable
|
||||
- is_tax_inclusive
|
||||
@@ -298,44 +287,88 @@ properties:
|
||||
original_total:
|
||||
type: number
|
||||
title: original_total
|
||||
description: The item's total including taxes, excluding promotions.
|
||||
description: >-
|
||||
The item's total including taxes, excluding promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
original_subtotal:
|
||||
type: number
|
||||
title: original_subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: >-
|
||||
The item's total excluding taxes, including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
original_tax_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The total taxes of the item excluding promotions.
|
||||
description: >-
|
||||
The total taxes of the item excluding promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
item_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The item's total including taxes and promotions.
|
||||
description: >-
|
||||
The item's total including taxes and promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
item_subtotal:
|
||||
type: number
|
||||
title: item_subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: >-
|
||||
The item's total excluding taxes, including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
item_tax_total:
|
||||
type: number
|
||||
title: item_tax_total
|
||||
description: The total taxes of the item including promotions.
|
||||
description: >-
|
||||
The total taxes of the item including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
total:
|
||||
type: number
|
||||
title: total
|
||||
description: The item's total including taxes and promotions.
|
||||
description: >-
|
||||
The item's total including taxes and promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
subtotal:
|
||||
type: number
|
||||
title: subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: >-
|
||||
The item's total excluding taxes, including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
tax_total:
|
||||
type: number
|
||||
title: tax_total
|
||||
description: The total taxes of the item including promotions.
|
||||
description: >-
|
||||
The total taxes of the item including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
discount_total:
|
||||
type: number
|
||||
title: discount_total
|
||||
description: The total discount of the item.
|
||||
description: >-
|
||||
The total discount of the item. This field is only available if you expand
|
||||
the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
discount_tax_total:
|
||||
type: number
|
||||
title: discount_tax_total
|
||||
description: The total taxes applied on the discounted amount.
|
||||
description: >-
|
||||
The total taxes applied on the discounted amount. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
|
||||
@@ -9,14 +9,6 @@ required:
|
||||
- is_tax_inclusive
|
||||
- created_at
|
||||
- updated_at
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -221,36 +213,70 @@ properties:
|
||||
original_total:
|
||||
type: number
|
||||
title: original_total
|
||||
description: The shipping method's total including taxes, excluding promotions.
|
||||
description: >-
|
||||
The shipping method's total including taxes, excluding promotions. This
|
||||
field is only available if you expand the `shipping_methods.*` relation.
|
||||
Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
original_subtotal:
|
||||
type: number
|
||||
title: original_subtotal
|
||||
description: The shipping method's total excluding taxes, including promotions.
|
||||
description: >-
|
||||
The shipping method's total excluding taxes, including promotions. This
|
||||
field is only available if you expand the `shipping_methods.*` relation.
|
||||
Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
original_tax_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: >-
|
||||
The total taxes applied on the shipping method's amount including
|
||||
promotions.
|
||||
promotions. This field is only available if you expand the
|
||||
`shipping_methods.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
total:
|
||||
type: number
|
||||
title: total
|
||||
description: The shipping method's total amount including taxes and promotions.
|
||||
description: >-
|
||||
The shipping method's total amount including taxes and promotions. This
|
||||
field is only available if you expand the `shipping_methods.*` relation.
|
||||
Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
subtotal:
|
||||
type: number
|
||||
title: subtotal
|
||||
description: The shipping method's total amount excluding taxes, including promotions.
|
||||
description: >-
|
||||
The shipping method's total amount excluding taxes, including promotions.
|
||||
This field is only available if you expand the `shipping_methods.*`
|
||||
relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
tax_total:
|
||||
type: number
|
||||
title: tax_total
|
||||
description: >-
|
||||
The total taxes applied on the shipping method's amount including
|
||||
promotions.
|
||||
promotions. This field is only available if you expand the
|
||||
`shipping_methods.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
discount_total:
|
||||
type: number
|
||||
title: discount_total
|
||||
description: The total amount discounted.
|
||||
description: >-
|
||||
The total amount discounted. This field is only available if you expand
|
||||
the `shipping_methods.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
discount_tax_total:
|
||||
type: number
|
||||
title: discount_tax_total
|
||||
description: The taxes applied on the discounted amount.
|
||||
description: >-
|
||||
The taxes applied on the discounted amount. This field is only available
|
||||
if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
|
||||
@@ -76258,17 +76258,6 @@ components:
|
||||
- cart
|
||||
- title
|
||||
- id
|
||||
- item_total
|
||||
- item_subtotal
|
||||
- item_tax_total
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
- requires_shipping
|
||||
- is_discountable
|
||||
- is_tax_inclusive
|
||||
@@ -76551,47 +76540,47 @@ components:
|
||||
original_total:
|
||||
type: number
|
||||
title: original_total
|
||||
description: The item's total including taxes, excluding promotions.
|
||||
description: The item's total including taxes, excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
original_subtotal:
|
||||
type: number
|
||||
title: original_subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
original_tax_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The total taxes of the item excluding promotions.
|
||||
description: The total taxes of the item excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
item_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The item's total including taxes and promotions.
|
||||
description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
item_subtotal:
|
||||
type: number
|
||||
title: item_subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
item_tax_total:
|
||||
type: number
|
||||
title: item_tax_total
|
||||
description: The total taxes of the item including promotions.
|
||||
description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
total:
|
||||
type: number
|
||||
title: total
|
||||
description: The item's total including taxes and promotions.
|
||||
description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
subtotal:
|
||||
type: number
|
||||
title: subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
tax_total:
|
||||
type: number
|
||||
title: tax_total
|
||||
description: The total taxes of the item including promotions.
|
||||
description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
discount_total:
|
||||
type: number
|
||||
title: discount_total
|
||||
description: The total discount of the item.
|
||||
description: The total discount of the item. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
discount_tax_total:
|
||||
type: number
|
||||
title: discount_tax_total
|
||||
description: The total taxes applied on the discounted amount.
|
||||
description: The total taxes applied on the discounted amount. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
StoreCartPromotion:
|
||||
type: object
|
||||
description: The promotion's promotions.
|
||||
@@ -76668,14 +76657,6 @@ components:
|
||||
- is_tax_inclusive
|
||||
- created_at
|
||||
- updated_at
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -76877,35 +76858,35 @@ components:
|
||||
original_total:
|
||||
type: number
|
||||
title: original_total
|
||||
description: The shipping method's total including taxes, excluding promotions.
|
||||
description: The shipping method's total including taxes, excluding promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
original_subtotal:
|
||||
type: number
|
||||
title: original_subtotal
|
||||
description: The shipping method's total excluding taxes, including promotions.
|
||||
description: The shipping method's total excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
original_tax_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The total taxes applied on the shipping method's amount including promotions.
|
||||
description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
total:
|
||||
type: number
|
||||
title: total
|
||||
description: The shipping method's total amount including taxes and promotions.
|
||||
description: The shipping method's total amount including taxes and promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
subtotal:
|
||||
type: number
|
||||
title: subtotal
|
||||
description: The shipping method's total amount excluding taxes, including promotions.
|
||||
description: The shipping method's total amount excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
tax_total:
|
||||
type: number
|
||||
title: tax_total
|
||||
description: The total taxes applied on the shipping method's amount including promotions.
|
||||
description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
discount_total:
|
||||
type: number
|
||||
title: discount_total
|
||||
description: The total amount discounted.
|
||||
description: The total amount discounted. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
discount_tax_total:
|
||||
type: number
|
||||
title: discount_tax_total
|
||||
description: The taxes applied on the discounted amount.
|
||||
description: The taxes applied on the discounted amount. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
StoreCartShippingOption:
|
||||
type: object
|
||||
description: The shipping option's details.
|
||||
|
||||
@@ -5,17 +5,6 @@ required:
|
||||
- cart
|
||||
- title
|
||||
- id
|
||||
- item_total
|
||||
- item_subtotal
|
||||
- item_tax_total
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
- requires_shipping
|
||||
- is_discountable
|
||||
- is_tax_inclusive
|
||||
@@ -298,44 +287,88 @@ properties:
|
||||
original_total:
|
||||
type: number
|
||||
title: original_total
|
||||
description: The item's total including taxes, excluding promotions.
|
||||
description: >-
|
||||
The item's total including taxes, excluding promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
original_subtotal:
|
||||
type: number
|
||||
title: original_subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: >-
|
||||
The item's total excluding taxes, including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
original_tax_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The total taxes of the item excluding promotions.
|
||||
description: >-
|
||||
The total taxes of the item excluding promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
item_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The item's total including taxes and promotions.
|
||||
description: >-
|
||||
The item's total including taxes and promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
item_subtotal:
|
||||
type: number
|
||||
title: item_subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: >-
|
||||
The item's total excluding taxes, including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
item_tax_total:
|
||||
type: number
|
||||
title: item_tax_total
|
||||
description: The total taxes of the item including promotions.
|
||||
description: >-
|
||||
The total taxes of the item including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
total:
|
||||
type: number
|
||||
title: total
|
||||
description: The item's total including taxes and promotions.
|
||||
description: >-
|
||||
The item's total including taxes and promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
subtotal:
|
||||
type: number
|
||||
title: subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: >-
|
||||
The item's total excluding taxes, including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
tax_total:
|
||||
type: number
|
||||
title: tax_total
|
||||
description: The total taxes of the item including promotions.
|
||||
description: >-
|
||||
The total taxes of the item including promotions. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
discount_total:
|
||||
type: number
|
||||
title: discount_total
|
||||
description: The total discount of the item.
|
||||
description: >-
|
||||
The total discount of the item. This field is only available if you expand
|
||||
the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
discount_tax_total:
|
||||
type: number
|
||||
title: discount_tax_total
|
||||
description: The total taxes applied on the discounted amount.
|
||||
description: >-
|
||||
The total taxes applied on the discounted amount. This field is only
|
||||
available if you expand the `items.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
|
||||
guide.
|
||||
|
||||
@@ -9,14 +9,6 @@ required:
|
||||
- is_tax_inclusive
|
||||
- created_at
|
||||
- updated_at
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -221,36 +213,70 @@ properties:
|
||||
original_total:
|
||||
type: number
|
||||
title: original_total
|
||||
description: The shipping method's total including taxes, excluding promotions.
|
||||
description: >-
|
||||
The shipping method's total including taxes, excluding promotions. This
|
||||
field is only available if you expand the `shipping_methods.*` relation.
|
||||
Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
original_subtotal:
|
||||
type: number
|
||||
title: original_subtotal
|
||||
description: The shipping method's total excluding taxes, including promotions.
|
||||
description: >-
|
||||
The shipping method's total excluding taxes, including promotions. This
|
||||
field is only available if you expand the `shipping_methods.*` relation.
|
||||
Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
original_tax_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: >-
|
||||
The total taxes applied on the shipping method's amount including
|
||||
promotions.
|
||||
promotions. This field is only available if you expand the
|
||||
`shipping_methods.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
total:
|
||||
type: number
|
||||
title: total
|
||||
description: The shipping method's total amount including taxes and promotions.
|
||||
description: >-
|
||||
The shipping method's total amount including taxes and promotions. This
|
||||
field is only available if you expand the `shipping_methods.*` relation.
|
||||
Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
subtotal:
|
||||
type: number
|
||||
title: subtotal
|
||||
description: The shipping method's total amount excluding taxes, including promotions.
|
||||
description: >-
|
||||
The shipping method's total amount excluding taxes, including promotions.
|
||||
This field is only available if you expand the `shipping_methods.*`
|
||||
relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
tax_total:
|
||||
type: number
|
||||
title: tax_total
|
||||
description: >-
|
||||
The total taxes applied on the shipping method's amount including
|
||||
promotions.
|
||||
promotions. This field is only available if you expand the
|
||||
`shipping_methods.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
discount_total:
|
||||
type: number
|
||||
title: discount_total
|
||||
description: The total amount discounted.
|
||||
description: >-
|
||||
The total amount discounted. This field is only available if you expand
|
||||
the `shipping_methods.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
discount_tax_total:
|
||||
type: number
|
||||
title: discount_tax_total
|
||||
description: The taxes applied on the discounted amount.
|
||||
description: >-
|
||||
The taxes applied on the discounted amount. This field is only available
|
||||
if you expand the `shipping_methods.*` relation. Learn more in the [Cart
|
||||
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
|
||||
guide.
|
||||
|
||||
@@ -30519,17 +30519,6 @@ components:
|
||||
- cart
|
||||
- title
|
||||
- id
|
||||
- item_total
|
||||
- item_subtotal
|
||||
- item_tax_total
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
- requires_shipping
|
||||
- is_discountable
|
||||
- is_tax_inclusive
|
||||
@@ -30812,47 +30801,47 @@ components:
|
||||
original_total:
|
||||
type: number
|
||||
title: original_total
|
||||
description: The item's total including taxes, excluding promotions.
|
||||
description: The item's total including taxes, excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
original_subtotal:
|
||||
type: number
|
||||
title: original_subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
original_tax_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The total taxes of the item excluding promotions.
|
||||
description: The total taxes of the item excluding promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
item_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The item's total including taxes and promotions.
|
||||
description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
item_subtotal:
|
||||
type: number
|
||||
title: item_subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
item_tax_total:
|
||||
type: number
|
||||
title: item_tax_total
|
||||
description: The total taxes of the item including promotions.
|
||||
description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
total:
|
||||
type: number
|
||||
title: total
|
||||
description: The item's total including taxes and promotions.
|
||||
description: The item's total including taxes and promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
subtotal:
|
||||
type: number
|
||||
title: subtotal
|
||||
description: The item's total excluding taxes, including promotions.
|
||||
description: The item's total excluding taxes, including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
tax_total:
|
||||
type: number
|
||||
title: tax_total
|
||||
description: The total taxes of the item including promotions.
|
||||
description: The total taxes of the item including promotions. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
discount_total:
|
||||
type: number
|
||||
title: discount_total
|
||||
description: The total discount of the item.
|
||||
description: The total discount of the item. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
discount_tax_total:
|
||||
type: number
|
||||
title: discount_tax_total
|
||||
description: The total taxes applied on the discounted amount.
|
||||
description: The total taxes applied on the discounted amount. This field is only available if you expand the `items.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals) guide.
|
||||
StoreCartPromotion:
|
||||
type: object
|
||||
description: The promotion's promotions.
|
||||
@@ -30929,14 +30918,6 @@ components:
|
||||
- is_tax_inclusive
|
||||
- created_at
|
||||
- updated_at
|
||||
- original_total
|
||||
- original_subtotal
|
||||
- original_tax_total
|
||||
- total
|
||||
- subtotal
|
||||
- tax_total
|
||||
- discount_total
|
||||
- discount_tax_total
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -31138,35 +31119,35 @@ components:
|
||||
original_total:
|
||||
type: number
|
||||
title: original_total
|
||||
description: The shipping method's total including taxes, excluding promotions.
|
||||
description: The shipping method's total including taxes, excluding promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
original_subtotal:
|
||||
type: number
|
||||
title: original_subtotal
|
||||
description: The shipping method's total excluding taxes, including promotions.
|
||||
description: The shipping method's total excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
original_tax_total:
|
||||
type: number
|
||||
title: original_tax_total
|
||||
description: The total taxes applied on the shipping method's amount including promotions.
|
||||
description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
total:
|
||||
type: number
|
||||
title: total
|
||||
description: The shipping method's total amount including taxes and promotions.
|
||||
description: The shipping method's total amount including taxes and promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
subtotal:
|
||||
type: number
|
||||
title: subtotal
|
||||
description: The shipping method's total amount excluding taxes, including promotions.
|
||||
description: The shipping method's total amount excluding taxes, including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
tax_total:
|
||||
type: number
|
||||
title: tax_total
|
||||
description: The total taxes applied on the shipping method's amount including promotions.
|
||||
description: The total taxes applied on the shipping method's amount including promotions. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
discount_total:
|
||||
type: number
|
||||
title: discount_total
|
||||
description: The total amount discounted.
|
||||
description: The total amount discounted. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
discount_tax_total:
|
||||
type: number
|
||||
title: discount_tax_total
|
||||
description: The taxes applied on the discounted amount.
|
||||
description: The taxes applied on the discounted amount. This field is only available if you expand the `shipping_methods.*` relation. Learn more in the [Cart Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals) guide.
|
||||
StoreCartShippingOption:
|
||||
type: object
|
||||
description: The shipping option's details.
|
||||
|
||||
Reference in New Issue
Block a user