Skip to content

Commit 460d095

Browse files
committed
update OAS
1 parent 08f7a42 commit 460d095

8 files changed

Lines changed: 251 additions & 190 deletions

File tree

www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml

Lines changed: 55 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,6 @@ required:
55
- cart
66
- title
77
- id
8-
- item_total
9-
- item_subtotal
10-
- item_tax_total
11-
- original_total
12-
- original_subtotal
13-
- original_tax_total
14-
- total
15-
- subtotal
16-
- tax_total
17-
- discount_total
18-
- discount_tax_total
198
- requires_shipping
209
- is_discountable
2110
- is_tax_inclusive
@@ -298,44 +287,88 @@ properties:
298287
original_total:
299288
type: number
300289
title: original_total
301-
description: The item's total including taxes, excluding promotions.
290+
description: >-
291+
The item's total including taxes, excluding promotions. This field is only
292+
available if you expand the `items.*` relation. Learn more in the [Cart
293+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
294+
guide.
302295
original_subtotal:
303296
type: number
304297
title: original_subtotal
305-
description: The item's total excluding taxes, including promotions.
298+
description: >-
299+
The item's total excluding taxes, including promotions. This field is only
300+
available if you expand the `items.*` relation. Learn more in the [Cart
301+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
302+
guide.
306303
original_tax_total:
307304
type: number
308305
title: original_tax_total
309-
description: The total taxes of the item excluding promotions.
306+
description: >-
307+
The total taxes of the item excluding promotions. This field is only
308+
available if you expand the `items.*` relation. Learn more in the [Cart
309+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
310+
guide.
310311
item_total:
311312
type: number
312313
title: original_tax_total
313-
description: The item's total including taxes and promotions.
314+
description: >-
315+
The item's total including taxes and promotions. This field is only
316+
available if you expand the `items.*` relation. Learn more in the [Cart
317+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
318+
guide.
314319
item_subtotal:
315320
type: number
316321
title: item_subtotal
317-
description: The item's total excluding taxes, including promotions.
322+
description: >-
323+
The item's total excluding taxes, including promotions. This field is only
324+
available if you expand the `items.*` relation. Learn more in the [Cart
325+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
326+
guide.
318327
item_tax_total:
319328
type: number
320329
title: item_tax_total
321-
description: The total taxes of the item including promotions.
330+
description: >-
331+
The total taxes of the item including promotions. This field is only
332+
available if you expand the `items.*` relation. Learn more in the [Cart
333+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
334+
guide.
322335
total:
323336
type: number
324337
title: total
325-
description: The item's total including taxes and promotions.
338+
description: >-
339+
The item's total including taxes and promotions. This field is only
340+
available if you expand the `items.*` relation. Learn more in the [Cart
341+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
342+
guide.
326343
subtotal:
327344
type: number
328345
title: subtotal
329-
description: The item's total excluding taxes, including promotions.
346+
description: >-
347+
The item's total excluding taxes, including promotions. This field is only
348+
available if you expand the `items.*` relation. Learn more in the [Cart
349+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
350+
guide.
330351
tax_total:
331352
type: number
332353
title: tax_total
333-
description: The total taxes of the item including promotions.
354+
description: >-
355+
The total taxes of the item including promotions. This field is only
356+
available if you expand the `items.*` relation. Learn more in the [Cart
357+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
358+
guide.
334359
discount_total:
335360
type: number
336361
title: discount_total
337-
description: The total discount of the item.
362+
description: >-
363+
The total discount of the item. This field is only available if you expand
364+
the `items.*` relation. Learn more in the [Cart
365+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
366+
guide.
338367
discount_tax_total:
339368
type: number
340369
title: discount_tax_total
341-
description: The total taxes applied on the discounted amount.
370+
description: >-
371+
The total taxes applied on the discounted amount. This field is only
372+
available if you expand the `items.*` relation. Learn more in the [Cart
373+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-cart-item-totals)
374+
guide.

www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,6 @@ required:
99
- is_tax_inclusive
1010
- created_at
1111
- updated_at
12-
- original_total
13-
- original_subtotal
14-
- original_tax_total
15-
- total
16-
- subtotal
17-
- tax_total
18-
- discount_total
19-
- discount_tax_total
2012
properties:
2113
id:
2214
type: string
@@ -221,36 +213,70 @@ properties:
221213
original_total:
222214
type: number
223215
title: original_total
224-
description: The shipping method's total including taxes, excluding promotions.
216+
description: >-
217+
The shipping method's total including taxes, excluding promotions. This
218+
field is only available if you expand the `shipping_methods.*` relation.
219+
Learn more in the [Cart
220+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
221+
guide.
225222
original_subtotal:
226223
type: number
227224
title: original_subtotal
228-
description: The shipping method's total excluding taxes, including promotions.
225+
description: >-
226+
The shipping method's total excluding taxes, including promotions. This
227+
field is only available if you expand the `shipping_methods.*` relation.
228+
Learn more in the [Cart
229+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
230+
guide.
229231
original_tax_total:
230232
type: number
231233
title: original_tax_total
232234
description: >-
233235
The total taxes applied on the shipping method's amount including
234-
promotions.
236+
promotions. This field is only available if you expand the
237+
`shipping_methods.*` relation. Learn more in the [Cart
238+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
239+
guide.
235240
total:
236241
type: number
237242
title: total
238-
description: The shipping method's total amount including taxes and promotions.
243+
description: >-
244+
The shipping method's total amount including taxes and promotions. This
245+
field is only available if you expand the `shipping_methods.*` relation.
246+
Learn more in the [Cart
247+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
248+
guide.
239249
subtotal:
240250
type: number
241251
title: subtotal
242-
description: The shipping method's total amount excluding taxes, including promotions.
252+
description: >-
253+
The shipping method's total amount excluding taxes, including promotions.
254+
This field is only available if you expand the `shipping_methods.*`
255+
relation. Learn more in the [Cart
256+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
257+
guide.
243258
tax_total:
244259
type: number
245260
title: tax_total
246261
description: >-
247262
The total taxes applied on the shipping method's amount including
248-
promotions.
263+
promotions. This field is only available if you expand the
264+
`shipping_methods.*` relation. Learn more in the [Cart
265+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
266+
guide.
249267
discount_total:
250268
type: number
251269
title: discount_total
252-
description: The total amount discounted.
270+
description: >-
271+
The total amount discounted. This field is only available if you expand
272+
the `shipping_methods.*` relation. Learn more in the [Cart
273+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
274+
guide.
253275
discount_tax_total:
254276
type: number
255277
title: discount_tax_total
256-
description: The taxes applied on the discounted amount.
278+
description: >-
279+
The taxes applied on the discounted amount. This field is only available
280+
if you expand the `shipping_methods.*` relation. Learn more in the [Cart
281+
Totals](https://docs.medusajs.com/resources/storefront-development/cart/totals#retrieve-and-show-shipping-method-totals)
282+
guide.

www/apps/api-reference/specs/admin/openapi.full.yaml

Lines changed: 19 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -76258,17 +76258,6 @@ components:
7625876258
- cart
7625976259
- title
7626076260
- id
76261-
- item_total
76262-
- item_subtotal
76263-
- item_tax_total
76264-
- original_total
76265-
- original_subtotal
76266-
- original_tax_total
76267-
- total
76268-
- subtotal
76269-
- tax_total
76270-
- discount_total
76271-
- discount_tax_total
7627276261
- requires_shipping
7627376262
- is_discountable
7627476263
- is_tax_inclusive
@@ -76551,47 +76540,47 @@ components:
7655176540
original_total:
7655276541
type: number
7655376542
title: original_total
76554-
description: The item's total including taxes, excluding promotions.
76543+
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.
7655576544
original_subtotal:
7655676545
type: number
7655776546
title: original_subtotal
76558-
description: The item's total excluding taxes, including promotions.
76547+
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.
7655976548
original_tax_total:
7656076549
type: number
7656176550
title: original_tax_total
76562-
description: The total taxes of the item excluding promotions.
76551+
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.
7656376552
item_total:
7656476553
type: number
7656576554
title: original_tax_total
76566-
description: The item's total including taxes and promotions.
76555+
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.
7656776556
item_subtotal:
7656876557
type: number
7656976558
title: item_subtotal
76570-
description: The item's total excluding taxes, including promotions.
76559+
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.
7657176560
item_tax_total:
7657276561
type: number
7657376562
title: item_tax_total
76574-
description: The total taxes of the item including promotions.
76563+
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.
7657576564
total:
7657676565
type: number
7657776566
title: total
76578-
description: The item's total including taxes and promotions.
76567+
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.
7657976568
subtotal:
7658076569
type: number
7658176570
title: subtotal
76582-
description: The item's total excluding taxes, including promotions.
76571+
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.
7658376572
tax_total:
7658476573
type: number
7658576574
title: tax_total
76586-
description: The total taxes of the item including promotions.
76575+
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.
7658776576
discount_total:
7658876577
type: number
7658976578
title: discount_total
76590-
description: The total discount of the item.
76579+
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.
7659176580
discount_tax_total:
7659276581
type: number
7659376582
title: discount_tax_total
76594-
description: The total taxes applied on the discounted amount.
76583+
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.
7659576584
StoreCartPromotion:
7659676585
type: object
7659776586
description: The promotion's promotions.
@@ -76668,14 +76657,6 @@ components:
7666876657
- is_tax_inclusive
7666976658
- created_at
7667076659
- updated_at
76671-
- original_total
76672-
- original_subtotal
76673-
- original_tax_total
76674-
- total
76675-
- subtotal
76676-
- tax_total
76677-
- discount_total
76678-
- discount_tax_total
7667976660
properties:
7668076661
id:
7668176662
type: string
@@ -76877,35 +76858,35 @@ components:
7687776858
original_total:
7687876859
type: number
7687976860
title: original_total
76880-
description: The shipping method's total including taxes, excluding promotions.
76861+
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.
7688176862
original_subtotal:
7688276863
type: number
7688376864
title: original_subtotal
76884-
description: The shipping method's total excluding taxes, including promotions.
76865+
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.
7688576866
original_tax_total:
7688676867
type: number
7688776868
title: original_tax_total
76888-
description: The total taxes applied on the shipping method's amount including promotions.
76869+
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.
7688976870
total:
7689076871
type: number
7689176872
title: total
76892-
description: The shipping method's total amount including taxes and promotions.
76873+
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.
7689376874
subtotal:
7689476875
type: number
7689576876
title: subtotal
76896-
description: The shipping method's total amount excluding taxes, including promotions.
76877+
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.
7689776878
tax_total:
7689876879
type: number
7689976880
title: tax_total
76900-
description: The total taxes applied on the shipping method's amount including promotions.
76881+
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.
7690176882
discount_total:
7690276883
type: number
7690376884
title: discount_total
76904-
description: The total amount discounted.
76885+
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.
7690576886
discount_tax_total:
7690676887
type: number
7690776888
title: discount_tax_total
76908-
description: The taxes applied on the discounted amount.
76889+
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.
7690976890
StoreCartShippingOption:
7691076891
type: object
7691176892
description: The shipping option's details.

0 commit comments

Comments
 (0)