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

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-10-03 07:48:54 +00:00
1 parent 97c193be1b
commit 21badd069d
894 files changed
+35649 -28168

No files matched your search

@@ -1,118 +0,0 @@
/**
* @schema StoreOrderShippingMethod
* type: object
* description: The shipping method's details.
* x-schemaName: StoreOrderShippingMethod
* required:
* - id
* - order_id
* - name
* - amount
* - is_tax_inclusive
* - shipping_option_id
* - data
* - metadata
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The shipping method's ID.
* order_id:
* type: string
* title: order_id
* description: The ID of the associated order.
* name:
* type: string
* title: name
* description: The shipping method's name.
* description:
* type: string
* title: description
* description: The shipping method's description.
* amount:
* type: number
* title: amount
* description: The shipping method's amount.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: Whether the shipping method's amount includes taxes.
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The ID of the associated shipping method.
* data:
* type: object
* description: The shipping method's data, useful for the provider handling its fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
* tax_lines:
* type: array
* description: The shipping method's tax lines.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethodTaxLine"
* adjustments:
* type: array
* description: The shipping method's adjustments.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethodAdjustment"
* original_total:
* type: number
* title: original_total
* description: The total of the shipping method including taxes, excluding promotions.
* original_subtotal:
* type: number
* title: original_subtotal
* description: The total of the shipping method excluding taxes, including promotions.
* original_tax_total:
* type: number
* title: original_tax_total
* description: The total taxes of the shipping method, excluding promotion.
* total:
* type: number
* title: total
* description: The total of the shipping method including taxes and promotions.
* detail:
* $ref: "#/components/schemas/BaseOrderShippingDetail"
* subtotal:
* type: number
* title: subtotal
* description: The shipping method's subtotal.
* tax_total:
* type: number
* title: tax_total
* description: The shipping method's tax total.
* discount_total:
* type: number
* title: discount_total
* description: The shipping method's discount total.
* discount_tax_total:
* type: number
* title: discount_tax_total
* description: The shipping method's discount tax total.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the shipping method was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the shipping method was updated.
*
*/