asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

oas: [6/n] improve oas schemas (#9122)

Browse Source 
Improve oas schemas [6/n]
This commit is contained in:
Shahed Nasser
2024-09-13 07:23:09 +00:00
committed by GitHub
parent a7684b45f6
commit 2c8ae6073e
8 changed files with 166 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/schemas/AdminNotificationListResponse.ts
+5 -5
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminNotificationListResponse * @schema AdminNotificationListResponse
* type: object * type: object
* description: SUMMARY * description: The paginated list of notifications.
* x-schemaName: AdminNotificationListResponse * x-schemaName: AdminNotificationListResponse
* required: * required:
* - limit * - limit
@@ -12,18 +12,18 @@
* limit: * limit:
* type: number * type: number
* title: limit * title: limit
* description: The notification's limit. * description: The maximum number of items returned.
* offset: * offset:
* type: number * type: number
* title: offset * title: offset
* description: The notification's offset. * description: The number of items skipped before retrieving the returned items.
* count: * count:
* type: number * type: number
* title: count * title: count
* description: The notification's count. * description: The total count of items.
* notifications: * notifications:
* type: array * type: array
* description: The notification's notifications. * description: The list of notifications.
* items: * items:
* $ref: "#/components/schemas/AdminNotification" * $ref: "#/components/schemas/AdminNotification"
* *
www/utils/generated/oas-output/schemas/AdminNotificationResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminNotificationResponse * @schema AdminNotificationResponse
* type: object * type: object
* description: SUMMARY * description: The notification's details.
* x-schemaName: AdminNotificationResponse * x-schemaName: AdminNotificationResponse
* required: * required:
* - notification * - notification
www/utils/generated/oas-output/schemas/AdminOrder.ts
+29 -29
View File
@@ -72,19 +72,19 @@
* region_id: * region_id:
* type: string * type: string
* title: region_id * title: region_id
* description: The order's region id. * description: The ID of the region associated with the order.
* customer_id: * customer_id:
* type: string * type: string
* title: customer_id * title: customer_id
* description: The order's customer id. * description: The ID of the customer that placed the order.
* sales_channel_id: * sales_channel_id:
* type: string * type: string
* title: sales_channel_id * title: sales_channel_id
* description: The order's sales channel id. * description: The ID of the sales channel the order is placed in.
* email: * email:
* type: string * type: string
* title: email * title: email
* description: The order's email. * description: The email of the customer that placed the order.
* format: email * format: email
* currency_code: * currency_code:
* type: string * type: string
@@ -93,7 +93,7 @@
* display_id: * display_id:
* type: number * type: number
* title: display_id * title: display_id
* description: The order's display id. * description: The order's display ID.
* items: * items:
* type: array * type: array
* description: The order's items. * description: The order's items.
@@ -139,73 +139,73 @@
* $ref: "#/components/schemas/BaseOrderSummary" * $ref: "#/components/schemas/BaseOrderSummary"
* metadata: * metadata:
* type: object * type: object
* description: The order's metadata. * description: The order's metadata, can hold custom key-value pairs.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The order's created at. * description: The date the order was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The order's updated at. * description: The date the order was updated.
* original_item_total: * original_item_total:
* type: number * type: number
* title: original_item_total * title: original_item_total
* description: The order's original item total. * description: The total of the order's items including taxes, excluding promotions.
* original_item_subtotal: * original_item_subtotal:
* type: number * type: number
* title: original_item_subtotal * title: original_item_subtotal
* description: The order's original item subtotal. * description: The total of the order's items excluding taxes, including promotions.
* original_item_tax_total: * original_item_tax_total:
* type: number * type: number
* title: original_item_tax_total * title: original_item_tax_total
* description: The order's original item tax total. * description: The tax total of the order's items excluding promotions.
* item_total: * item_total:
* type: number * type: number
* title: item_total * title: item_total
* description: The order's item total. * description: The total of the order's items including taxes and promotions.
* item_subtotal: * item_subtotal:
* type: number * type: number
* title: item_subtotal * title: item_subtotal
* description: The order's item subtotal. * description: The total of the order's items excluding taxes, including promotions.
* item_tax_total: * item_tax_total:
* type: number * type: number
* title: item_tax_total * title: item_tax_total
* description: The order's item tax total. * description: The tax total of the order's items including promotions.
* original_total: * original_total:
* type: number * type: number
* title: original_total * title: original_total
* description: The order's original total. * description: The order's total excluding promotions, including taxes.
* original_subtotal: * original_subtotal:
* type: number * type: number
* title: original_subtotal * title: original_subtotal
* description: The order's original subtotal. * description: The order's total excluding taxes, including promotions.
* original_tax_total: * original_tax_total:
* type: number * type: number
* title: original_tax_total * title: original_tax_total
* description: The order's original tax total. * description: The order's tax total, excluding promotions.
* total: * total:
* type: number * type: number
* title: total * title: total
* description: The order's total. * description: The order's total including taxes and promotions.
* subtotal: * subtotal:
* type: number * type: number
* title: subtotal * title: subtotal
* description: The order's subtotal. * description: The order's total excluding taxes, including promotions.
* tax_total: * tax_total:
* type: number * type: number
* title: tax_total * title: tax_total
* description: The order's tax total. * description: The order's tax total including promotions.
* discount_total: * discount_total:
* type: number * type: number
* title: discount_total * title: discount_total
* description: The order's discount total. * description: The order's discount or promotions total.
* discount_tax_total: * discount_tax_total:
* type: number * type: number
* title: discount_tax_total * title: discount_tax_total
* description: The order's discount tax total. * description: The tax total of order's discount or promotion.
* gift_card_total: * gift_card_total:
* type: number * type: number
* title: gift_card_total * title: gift_card_total
@@ -213,31 +213,31 @@
* gift_card_tax_total: * gift_card_tax_total:
* type: number * type: number
* title: gift_card_tax_total * title: gift_card_tax_total
* description: The order's gift card tax total. * description: The tax total of the order's gift card.
* shipping_total: * shipping_total:
* type: number * type: number
* title: shipping_total * title: shipping_total
* description: The order's shipping total. * description: The order's shipping total including taxes and promotions.
* shipping_subtotal: * shipping_subtotal:
* type: number * type: number
* title: shipping_subtotal * title: shipping_subtotal
* description: The order's shipping subtotal. * description: The order's shipping total excluding taxes, including promotions.
* shipping_tax_total: * shipping_tax_total:
* type: number * type: number
* title: shipping_tax_total * title: shipping_tax_total
* description: The order's shipping tax total. * description: The tax total of the order's shipping.
* original_shipping_total: * original_shipping_total:
* type: number * type: number
* title: original_shipping_total * title: original_shipping_total
* description: The order's original shipping total. * description: The order's shipping total including taxes, excluding promotions.
* original_shipping_subtotal: * original_shipping_subtotal:
* type: number * type: number
* title: original_shipping_subtotal * title: original_shipping_subtotal
* description: The order's original shipping subtotal. * description: The order's shipping total excluding taxes, including promotions.
* original_shipping_tax_total: * original_shipping_tax_total:
* type: number * type: number
* title: original_shipping_tax_total * title: original_shipping_tax_total
* description: The order's original shipping tax total. * description: The tax total of the order's shipping excluding promotions.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminOrderAddress.ts
+19 -18
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminOrderAddress * @schema AdminOrderAddress
* type: object * type: object
* description: The order's billing address. * description: An order address.
* x-schemaName: AdminOrderAddress * x-schemaName: AdminOrderAddress
* required: * required:
* - id * - id
@@ -9,69 +9,70 @@
* - created_at * - created_at
* - updated_at * - updated_at
* properties: * properties:
* country:
* $ref: "#/components/schemas/AdminRegionCountry"
* id: * id:
* type: string * type: string
* title: id * title: id
* description: The billing address's ID. * description: The address's ID.
* customer_id: * customer_id:
* type: string * type: string
* title: customer_id * title: customer_id
* description: The billing address's customer id. * description: The ID of the customer this address belongs to.
* first_name: * first_name:
* type: string * type: string
* title: first_name * title: first_name
* description: The billing address's first name. * description: The address's first name.
* last_name: * last_name:
* type: string * type: string
* title: last_name * title: last_name
* description: The billing address's last name. * description: The address's last name.
* phone: * phone:
* type: string * type: string
* title: phone * title: phone
* description: The billing address's phone. * description: The address's phone.
* company: * company:
* type: string * type: string
* title: company * title: company
* description: The billing address's company. * description: The address's company.
* address_1: * address_1:
* type: string * type: string
* title: address_1 * title: address_1
* description: The billing address's address 1. * description: The address's first line.
* address_2: * address_2:
* type: string * type: string
* title: address_2 * title: address_2
* description: The billing address's address 2. * description: The address's second line.
* city: * city:
* type: string * type: string
* title: city * title: city
* description: The billing address's city. * description: The address's city.
* country_code: * country_code:
* type: string * type: string
* title: country_code * title: country_code
* description: The billing address's country code. * description: The address's country code.
* example: us
* country:
* $ref: "#/components/schemas/AdminRegionCountry"
* province: * province:
* type: string * type: string
* title: province * title: province
* description: The billing address's province. * description: The address's province.
* postal_code: * postal_code:
* type: string * type: string
* title: postal_code * title: postal_code
* description: The billing address's postal code. * description: The address's postal code.
* metadata: * metadata:
* type: object * type: object
* description: The billing address's metadata. * description: The address's metadata, can hold custom key-value pairs.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The billing address's created at. * description: The date the address was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The billing address's updated at. * description: The date the address was updated.
* *
*/ */
www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts
+2 -2
View File
@@ -1,14 +1,14 @@
/** /**
* @schema AdminOrderChangesResponse * @schema AdminOrderChangesResponse
* type: object * type: object
* description: SUMMARY * description: The details of an order's changes.
* x-schemaName: AdminOrderChangesResponse * x-schemaName: AdminOrderChangesResponse
* required: * required:
* - order_changes * - order_changes
* properties: * properties:
* order_changes: * order_changes:
* type: array * type: array
* description: The order's order changes. * description: An order's changes.
* items: * items:
* $ref: "#/components/schemas/BaseOrderChange" * $ref: "#/components/schemas/BaseOrderChange"
* *
www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminOrderEditPreviewResponse * @schema AdminOrderEditPreviewResponse
* type: object * type: object
* description: SUMMARY * description: The preview of an order edit.
* x-schemaName: AdminOrderEditPreviewResponse * x-schemaName: AdminOrderEditPreviewResponse
* required: * required:
* - order_preview * - order_preview
www/utils/generated/oas-output/schemas/AdminOrderEditResponse.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminOrderEditResponse * @schema AdminOrderEditResponse
* type: object * type: object
* description: SUMMARY * description: An order edit's details.
* x-schemaName: AdminOrderEditResponse * x-schemaName: AdminOrderEditResponse
* required: * required:
* - order_change * - order_change
www/utils/generated/oas-output/schemas/AdminOrderPreview.ts
+108 -138
View File
@@ -1,7 +1,7 @@
/** /**
* @schema AdminOrderPreview * @schema AdminOrderPreview
* type: object * type: object
* description: The return's order preview. * description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
* x-schemaName: AdminOrderPreview * x-schemaName: AdminOrderPreview
* required: * required:
* - return_requested_total * - return_requested_total
@@ -46,16 +46,16 @@
* return_requested_total: * return_requested_total:
* type: number * type: number
* title: return_requested_total * title: return_requested_total
* description: The order preview's return requested total. * description: The total of the requested return.
* order_change: * order_change:
* $ref: "#/components/schemas/BaseOrderChange" * $ref: "#/components/schemas/BaseOrderChange"
* items: * items:
* type: array * type: array
* description: The order preview's items. * description: The order's items.
* items: * items:
* allOf: * allOf:
* - type: object * - type: object
* description: The item's items. * description: An order's item.
* x-schemaName: BaseOrderLineItem * x-schemaName: BaseOrderLineItem
* required: * required:
* - id * - id
@@ -112,74 +112,74 @@
* thumbnail: * thumbnail:
* type: string * type: string
* title: thumbnail * title: thumbnail
* description: The item's thumbnail. * description: The URL of the item's thumbnail.
* variant: * variant:
* $ref: "#/components/schemas/BaseProductVariant" * $ref: "#/components/schemas/BaseProductVariant"
* variant_id: * variant_id:
* type: string * type: string
* title: variant_id * title: variant_id
* description: The item's variant id. * description: The ID of the associated variant.
* product: * product:
* $ref: "#/components/schemas/BaseProduct" * $ref: "#/components/schemas/BaseProduct"
* product_id: * product_id:
* type: string * type: string
* title: product_id * title: product_id
* description: The item's product id. * description: The ID of the associated product.
* product_title: * product_title:
* type: string * type: string
* title: product_title * title: product_title
* description: The item's product title. * description: The title of the item's product.
* product_description: * product_description:
* type: string * type: string
* title: product_description * title: product_description
* description: The item's product description. * description: The description of the item's product.
* product_subtitle: * product_subtitle:
* type: string * type: string
* title: product_subtitle * title: product_subtitle
* description: The item's product subtitle. * description: The subtitle of the item's product.
* product_type: * product_type:
* type: string * type: string
* title: product_type * title: product_type
* description: The item's product type. * description: The ID of type of the item's product.
* product_collection: * product_collection:
* type: string * type: string
* title: product_collection * title: product_collection
* description: The item's product collection. * description: The ID of collection of the item's product.
* product_handle: * product_handle:
* type: string * type: string
* title: product_handle * title: product_handle
* description: The item's product handle. * description: The handle of the item's product.
* variant_sku: * variant_sku:
* type: string * type: string
* title: variant_sku * title: variant_sku
* description: The item's variant sku. * description: The SKU of the item's variant.
* variant_barcode: * variant_barcode:
* type: string * type: string
* title: variant_barcode * title: variant_barcode
* description: The item's variant barcode. * description: The barcode of the item's variant.
* variant_title: * variant_title:
* type: string * type: string
* title: variant_title * title: variant_title
* description: The item's variant title. * description: The title of the item's variant.
* variant_option_values: * variant_option_values:
* type: object * type: object
* description: The item's variant option values. * description: The option values of the item's variant as key-value pairs. The key is the title of an option, and the value is the option's value.
* requires_shipping: * requires_shipping:
* type: boolean * type: boolean
* title: requires_shipping * title: requires_shipping
* description: The item's requires shipping. * description: Whether the item requires shipping.
* is_discountable: * is_discountable:
* type: boolean * type: boolean
* title: is_discountable * title: is_discountable
* description: The item's is discountable. * description: Whether the item is discountable.
* is_tax_inclusive: * is_tax_inclusive:
* type: boolean * type: boolean
* title: is_tax_inclusive * title: is_tax_inclusive
* description: The item's is tax inclusive. * description: Whether the item's price includes taxes.
* compare_at_unit_price: * compare_at_unit_price:
* type: number * type: number
* title: compare_at_unit_price * title: The original price of the item before a promotion or sale.
* description: The item's compare at unit price. * description: The
* unit_price: * unit_price:
* type: number * type: number
* title: unit_price * title: unit_price
@@ -204,84 +204,84 @@
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The item's created at. * description: The date the item was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The item's updated at. * description: The date the item was updated.
* metadata: * metadata:
* type: object * type: object
* description: The item's metadata. * description: The item's metadata, can hold custom key-value pairs.
* original_total: * original_total:
* type: number * type: number
* title: original_total * title: original_total
* description: The item's original total. * description: The item's total including taxes, excluding promotions.
* original_subtotal: * original_subtotal:
* type: number * type: number
* title: original_subtotal * title: original_subtotal
* description: The item's original subtotal. * description: The item's total excluding taxes, including promotions.
* original_tax_total: * original_tax_total:
* type: number * type: number
* title: original_tax_total * title: original_tax_total
* description: The item's original tax total. * description: The tax total of the item excluding promotions.
* item_total: * item_total:
* type: number * type: number
* title: item_total * title: item_total
* description: The item's item total. * description: The item's total for a single unit including taxes and promotions.
* item_subtotal: * item_subtotal:
* type: number * type: number
* title: item_subtotal * title: item_subtotal
* description: The item's item subtotal. * description: The item's total for a single unit excluding taxes, including promotions.
* item_tax_total: * item_tax_total:
* type: number * type: number
* title: item_tax_total * title: item_tax_total
* description: The item's item tax total. * description: The tax total for a single unit of the item including promotions.
* total: * total:
* type: number * type: number
* title: total * title: total
* description: The item's total. * description: The item's total including taxes and promotions.
* subtotal: * subtotal:
* type: number * type: number
* title: subtotal * title: subtotal
* description: The item's subtotal. * description: The item's total excluding taxes, including promotions.
* tax_total: * tax_total:
* type: number * type: number
* title: tax_total * title: tax_total
* description: The item's tax total. * description: The tax total of the item including promotions.
* discount_total: * discount_total:
* type: number * type: number
* title: discount_total * title: discount_total
* description: The item's discount total. * description: The total of the item's discount / promotion.
* discount_tax_total: * discount_tax_total:
* type: number * type: number
* title: discount_tax_total * title: discount_tax_total
* description: The item's discount tax total. * description: The tax total of the item's discount / promotion
* refundable_total: * refundable_total:
* type: number * type: number
* title: refundable_total * title: refundable_total
* description: The item's refundable total. * description: The total refundable amount of the item's total.
* refundable_total_per_unit: * refundable_total_per_unit:
* type: number * type: number
* title: refundable_total_per_unit * title: refundable_total_per_unit
* description: The item's refundable total per unit. * description: The total refundable amount of the item's total for a single unit.
* - type: object * - type: object
* description: The item's items. * description: An order's item.
* properties: * properties:
* actions: * actions:
* type: array * type: array
* description: The item's actions. * description: The actions applied on an item.
* items: * items:
* type: object * type: object
* description: The action's actions. * description: The action's details.
* x-schemaName: BaseOrderChangeAction * x-schemaName: BaseOrderChangeAction
* shipping_methods: * shipping_methods:
* type: array * type: array
* description: The order preview's shipping methods. * description: The order's shipping methods.
* items: * items:
* allOf: * allOf:
* - type: object * - type: object
* description: The shipping method's shipping methods. * description: The shipping method's details.
* x-schemaName: BaseOrderShippingMethod * x-schemaName: BaseOrderShippingMethod
* required: * required:
* - id * - id
@@ -310,7 +310,7 @@
* order_id: * order_id:
* type: string * type: string
* title: order_id * title: order_id
* description: The shipping method's order id. * description: The ID of the order this shipping method belongs to.
* name: * name:
* type: string * type: string
* title: name * title: name
@@ -326,17 +326,19 @@
* is_tax_inclusive: * is_tax_inclusive:
* type: boolean * type: boolean
* title: is_tax_inclusive * title: is_tax_inclusive
* description: The shipping method's is tax inclusive. * description: Whether the shipping method's amount is tax inclusive.
* shipping_option_id: * shipping_option_id:
* type: string * type: string
* title: shipping_option_id * title: shipping_option_id
* description: The shipping method's shipping option id. * description: The ID of the shipping option this method was created from.
* data: * data:
* type: object * type: object
* description: The shipping method's data. * description: The data relevant for the fulfillment provider to process this shipment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property
* metadata: * metadata:
* type: object * type: object
* description: The shipping method's metadata. * description: The shipping method's metadata, can hold custom key-value pairs.
* tax_lines: * tax_lines:
* type: array * type: array
* description: The shipping method's tax lines. * description: The shipping method's tax lines.
@@ -351,163 +353,131 @@
* oneOf: * oneOf:
* - type: string * - type: string
* title: original_total * title: original_total
* description: The shipping method's original total. * description: The shipping method's total including taxes, excluding promotions.
* - type: number * - type: number
* title: original_total * title: original_total
* description: The shipping method's original total. * description: The shipping method's total including taxes, excluding promotions.
* - type: string
* title: original_total
* description: The shipping method's original total.
* - $ref: "#/components/schemas/IBigNumber"
* original_subtotal: * original_subtotal:
* oneOf: * oneOf:
* - type: string * - type: string
* title: original_subtotal * title: original_subtotal
* description: The shipping method's original subtotal. * description: The shipping method's total excluding taxes, including promotions.
* - type: number * - type: number
* title: original_subtotal * title: original_subtotal
* description: The shipping method's original subtotal. * description: The shipping method's total excluding taxes, including promotions.
* - type: string
* title: original_subtotal
* description: The shipping method's original subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_tax_total: * original_tax_total:
* oneOf: * oneOf:
* - type: string * - type: string
* title: original_tax_total * title: original_tax_total
* description: The shipping method's original tax total. * description: The tax total of the shipping method excluding promotions.
* - type: number * - type: number
* title: original_tax_total * title: original_tax_total
* description: The shipping method's original tax total. * description: The tax total of the shipping method excluding promotions.
* - type: string
* title: original_tax_total
* description: The shipping method's original tax total.
* - $ref: "#/components/schemas/IBigNumber"
* total: * total:
* oneOf: * oneOf:
* - type: string * - type: string
* title: total * title: total
* description: The shipping method's total. * description: The shipping method's total including taxes and promotions.
* - type: number * - type: number
* title: total * title: total
* description: The shipping method's total. * description: The shipping method's total including taxes and promotions.
* - type: string
* title: total
* description: The shipping method's total.
* - $ref: "#/components/schemas/IBigNumber"
* subtotal: * subtotal:
* oneOf: * oneOf:
* - type: string * - type: string
* title: subtotal * title: subtotal
* description: The shipping method's subtotal. * description: The shipping method's total excluding taxes, including promotions.
* - type: number * - type: number
* title: subtotal * title: subtotal
* description: The shipping method's subtotal. * description: The shipping method's total excluding taxes, including promotions.
* - type: string
* title: subtotal
* description: The shipping method's subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* tax_total: * tax_total:
* oneOf: * oneOf:
* - type: string * - type: string
* title: tax_total * title: tax_total
* description: The shipping method's tax total. * description: The tax total of the shipping method including promotions.
* - type: number * - type: number
* title: tax_total * title: tax_total
* description: The shipping method's tax total. * description: The tax total of the shipping method including promotions.
* - type: string
* title: tax_total
* description: The shipping method's tax total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_total: * discount_total:
* oneOf: * oneOf:
* - type: string * - type: string
* title: discount_total * title: discount_total
* description: The shipping method's discount total. * description: The total of the shipping method's promotion.
* - type: number * - type: number
* title: discount_total * title: discount_total
* description: The shipping method's discount total. * description: The total of the shipping method's promotion.
* - type: string
* title: discount_total
* description: The shipping method's discount total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_tax_total: * discount_tax_total:
* oneOf: * oneOf:
* - type: string * - type: string
* title: discount_tax_total * title: discount_tax_total
* description: The shipping method's discount tax total. * description: The tax total of the shipping method's promotion.
* - type: number * - type: number
* title: discount_tax_total * title: discount_tax_total
* description: The shipping method's discount tax total. * description: The shipping method's discount tax total.
* - type: string
* title: discount_tax_total
* description: The shipping method's discount tax total.
* - $ref: "#/components/schemas/IBigNumber"
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The shipping method's created at. * description: The date the shipping method was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The shipping method's updated at. * description: The date the shipping method was updated.
* - type: object * - type: object
* description: The shipping method's shipping methods. * description: The shipping method's details.
* properties: * properties:
* actions: * actions:
* type: array * type: array
* description: The shipping method's actions. * description: The actions applied on the shipping method.
* items: * items:
* type: object * type: object
* description: The action's actions. * description: The action's details.
* x-schemaName: BaseOrderChangeAction * x-schemaName: BaseOrderChangeAction
* currency_code: * currency_code:
* type: string * type: string
* title: currency_code * title: currency_code
* description: The order preview's currency code. * description: The order's currency code.
* version: * version:
* type: number * type: number
* title: version * title: version
* description: The order preview's version. * description: The order's version when this preview is applied.
* id: * id:
* type: string * type: string
* title: id * title: id
* description: The order preview's ID. * description: The order's ID.
* region_id: * region_id:
* type: string * type: string
* title: region_id * title: region_id
* description: The order preview's region id. * description: The ID of the order's associated region.
* customer_id: * customer_id:
* type: string * type: string
* title: customer_id * title: customer_id
* description: The order preview's customer id. * description: The ID of the customer that placed the order.
* sales_channel_id: * sales_channel_id:
* type: string * type: string
* title: sales_channel_id * title: sales_channel_id
* description: The order preview's sales channel id. * description: The ID of the sales channel that the order was placed in.
* email: * email:
* type: string * type: string
* title: email * title: email
* description: The order preview's email. * description: The email of the customer that placed the order.
* format: email * format: email
* display_id: * display_id:
* type: number * type: number
* title: display_id * title: display_id
* description: The order preview's display id. * description: The order's display ID.
* shipping_address: * shipping_address:
* $ref: "#/components/schemas/AdminOrderAddress" * $ref: "#/components/schemas/AdminOrderAddress"
* billing_address: * billing_address:
* $ref: "#/components/schemas/AdminOrderAddress" * $ref: "#/components/schemas/AdminOrderAddress"
* payment_collections: * payment_collections:
* type: array * type: array
* description: The order preview's payment collections. * description: The order's payment collections.
* items: * items:
* $ref: "#/components/schemas/AdminPaymentCollection" * $ref: "#/components/schemas/AdminPaymentCollection"
* payment_status: * payment_status:
* type: string * type: string
* description: The order preview's payment status. * description: The order's payment status.
* enum: * enum:
* - canceled * - canceled
* - not_paid * - not_paid
@@ -521,12 +491,12 @@
* - requires_action * - requires_action
* fulfillments: * fulfillments:
* type: array * type: array
* description: The order preview's fulfillments. * description: The order's fulfillments.
* items: * items:
* $ref: "#/components/schemas/BaseOrderFulfillment" * $ref: "#/components/schemas/BaseOrderFulfillment"
* fulfillment_status: * fulfillment_status:
* type: string * type: string
* description: The order preview's fulfillment status. * description: The order's fulfillment status.
* enum: * enum:
* - canceled * - canceled
* - not_fulfilled * - not_fulfilled
@@ -538,112 +508,112 @@
* - delivered * - delivered
* transactions: * transactions:
* type: array * type: array
* description: The order preview's transactions. * description: The order's transactions.
* items: * items:
* $ref: "#/components/schemas/BaseOrderTransaction" * $ref: "#/components/schemas/BaseOrderTransaction"
* summary: * summary:
* $ref: "#/components/schemas/BaseOrderSummary" * $ref: "#/components/schemas/BaseOrderSummary"
* metadata: * metadata:
* type: object * type: object
* description: The order preview's metadata. * description: The order's metadata, can hold custom key-value pairs.
* created_at: * created_at:
* type: string * type: string
* format: date-time * format: date-time
* title: created_at * title: created_at
* description: The order preview's created at. * description: The date the order was created.
* updated_at: * updated_at:
* type: string * type: string
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The order preview's updated at. * description: The date the order was updated.
* original_item_total: * original_item_total:
* type: number * type: number
* title: original_item_total * title: original_item_total
* description: The order preview's original item total. * description: The total of the order's items including taxes, excluding promotions.
* original_item_subtotal: * original_item_subtotal:
* type: number * type: number
* title: original_item_subtotal * title: original_item_subtotal
* description: The order preview's original item subtotal. * description: The total of the order's items excluding taxes, including promotions.
* original_item_tax_total: * original_item_tax_total:
* type: number * type: number
* title: original_item_tax_total * title: original_item_tax_total
* description: The order preview's original item tax total. * description: The tax total of the order's items excluding promotions.
* item_total: * item_total:
* type: number * type: number
* title: item_total * title: item_total
* description: The order preview's item total. * description: The total of the order's items including taxes and promotions.
* item_subtotal: * item_subtotal:
* type: number * type: number
* title: item_subtotal * title: item_subtotal
* description: The order preview's item subtotal. * description: The total of the order's items excluding taxes, including promotions.
* item_tax_total: * item_tax_total:
* type: number * type: number
* title: item_tax_total * title: item_tax_total
* description: The order preview's item tax total. * description: The tax total of the order's items including promotions.
* original_total: * original_total:
* type: number * type: number
* title: original_total * title: original_total
* description: The order preview's original total. * description: The order's total excluding promotions, including taxes.
* original_subtotal: * original_subtotal:
* type: number * type: number
* title: original_subtotal * title: original_subtotal
* description: The order preview's original subtotal. * description: The order's total excluding taxes, including promotions.
* original_tax_total: * original_tax_total:
* type: number * type: number
* title: original_tax_total * title: original_tax_total
* description: The order preview's original tax total. * description: The order's tax total, excluding promotions.
* total: * total:
* type: number * type: number
* title: total * title: total
* description: The order preview's total. * description: The order's total including taxes and promotions.
* subtotal: * subtotal:
* type: number * type: number
* title: subtotal * title: subtotal
* description: The order preview's subtotal. * description: The order's total excluding taxes, including promotions.
* tax_total: * tax_total:
* type: number * type: number
* title: tax_total * title: tax_total
* description: The order preview's tax total. * description: The order's tax total including promotions.
* discount_total: * discount_total:
* type: number * type: number
* title: discount_total * title: discount_total
* description: The order preview's discount total. * description: The order's discount or promotions total.
* discount_tax_total: * discount_tax_total:
* type: number * type: number
* title: discount_tax_total * title: discount_tax_total
* description: The order preview's discount tax total. * description: The tax total of order's discount or promotion.
* gift_card_total: * gift_card_total:
* type: number * type: number
* title: gift_card_total * title: gift_card_total
* description: The order preview's gift card total. * description: The order's gift card total.
* gift_card_tax_total: * gift_card_tax_total:
* type: number * type: number
* title: gift_card_tax_total * title: gift_card_tax_total
* description: The order preview's gift card tax total. * description: The tax total of the order's gift card.
* shipping_total: * shipping_total:
* type: number * type: number
* title: shipping_total * title: shipping_total
* description: The order preview's shipping total. * description: The order's shipping total including taxes and promotions.
* shipping_subtotal: * shipping_subtotal:
* type: number * type: number
* title: shipping_subtotal * title: shipping_subtotal
* description: The order preview's shipping subtotal. * description: The order's shipping total excluding taxes, including promotions.
* shipping_tax_total: * shipping_tax_total:
* type: number * type: number
* title: shipping_tax_total * title: shipping_tax_total
* description: The order preview's shipping tax total. * description: The tax total of the order's shipping.
* original_shipping_total: * original_shipping_total:
* type: number * type: number
* title: original_shipping_total * title: original_shipping_total
* description: The order preview's original shipping total. * description: The order's shipping total including taxes, excluding promotions.
* original_shipping_subtotal: * original_shipping_subtotal:
* type: number * type: number
* title: original_shipping_subtotal * title: original_shipping_subtotal
* description: The order preview's original shipping subtotal. * description: The order's shipping total excluding taxes, including promotions.
* original_shipping_tax_total: * original_shipping_tax_total:
* type: number * type: number
* title: original_shipping_tax_total * title: original_shipping_tax_total
* description: The order preview's original shipping tax total. * description: The tax total of the order's shipping excluding promotions.
* customer: * customer:
* $ref: "#/components/schemas/AdminCustomer" * $ref: "#/components/schemas/AdminCustomer"
* sales_channel: * sales_channel: