docs: generate OAS manually for 2.7.0 (#12158)
* original changes * changes * fixes for delete operations * generate oas
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,49 @@
|
||||
/**
|
||||
* @schema AdminAddDraftOrderItems
|
||||
* type: object
|
||||
* description: The details of the items to add to a draft order.
|
||||
* x-schemaName: AdminAddDraftOrderItems
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
* description: The items to add to the draft order.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The item's details
|
||||
* required:
|
||||
* - quantity
|
||||
* properties:
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The ID of the variant to add to the draft order.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The item's title.
|
||||
* unit_price:
|
||||
* type: number
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* compare_at_unit_price:
|
||||
* type: number
|
||||
* title: compare_at_unit_price
|
||||
* description: The original price of the item before a promotion or sale.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note viewed only by admin users about the item.
|
||||
* allow_backorder:
|
||||
* type: boolean
|
||||
* title: allow_backorder
|
||||
* description: Whether the item can be purchased if it's out of stock.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
/**
|
||||
* @schema AdminAddDraftOrderPromotions
|
||||
* type: object
|
||||
* description: The details of the promotions to add to a draft order.
|
||||
* x-schemaName: AdminAddDraftOrderPromotions
|
||||
* required:
|
||||
* - promo_codes
|
||||
* properties:
|
||||
* promo_codes:
|
||||
* type: array
|
||||
* description: The list promotion codes to add to the draft order.
|
||||
* items:
|
||||
* type: string
|
||||
* title: promo_codes
|
||||
* description: A promotion's code.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* @schema AdminAddDraftOrderShippingMethod
|
||||
* type: object
|
||||
* description: The details of the shipping method to add to a draft order.
|
||||
* x-schemaName: AdminAddDraftOrderShippingMethod
|
||||
* required:
|
||||
* - shipping_option_id
|
||||
* properties:
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The ID of the shipping option that this method is created from.
|
||||
* custom_amount:
|
||||
* type: number
|
||||
* title: custom_amount
|
||||
* description: A custom amount to be charged for this shipping method. If not provided, the shipping option's amount will be used.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The shipping method's description.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note viewed only by admin users about the shipping method.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema AdminCreateOrderCreditLines
|
||||
* type: object
|
||||
* description: The details of a credit line to add to an order.
|
||||
* x-schemaName: AdminCreateOrderCreditLines
|
||||
* required:
|
||||
* - amount
|
||||
* - reference
|
||||
* - reference_id
|
||||
* properties:
|
||||
* amount:
|
||||
* type: number
|
||||
* title: amount
|
||||
* description: The amount of the credit line.
|
||||
* example: 100
|
||||
* reference:
|
||||
* type: string
|
||||
* title: reference
|
||||
* description: The name of the table that the credit line is referencing.
|
||||
* example: order
|
||||
* reference_id:
|
||||
* type: string
|
||||
* title: reference_id
|
||||
* description: The ID of a record in the table that the credit line is referencing.
|
||||
* example: order_123
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The credit line's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -243,6 +243,13 @@
|
||||
* type: number
|
||||
* title: original_shipping_tax_total
|
||||
* description: The tax total of the draft order's shipping excluding promotions.
|
||||
* region:
|
||||
* $ref: "#/components/schemas/AdminRegion"
|
||||
* credit_lines:
|
||||
* type: array
|
||||
* description: The draft order's credit lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderCreditLine"
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -0,0 +1,634 @@
|
||||
/**
|
||||
* @schema AdminDraftOrderPreview
|
||||
* type: object
|
||||
* description: The draft order preview's details.
|
||||
* x-schemaName: AdminDraftOrderPreview
|
||||
* required:
|
||||
* - return_requested_total
|
||||
* - order_change
|
||||
* - status
|
||||
* - currency_code
|
||||
* - id
|
||||
* - version
|
||||
* - region_id
|
||||
* - customer_id
|
||||
* - sales_channel_id
|
||||
* - email
|
||||
* - payment_collections
|
||||
* - payment_status
|
||||
* - fulfillment_status
|
||||
* - summary
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - original_item_total
|
||||
* - original_item_subtotal
|
||||
* - original_item_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - gift_card_total
|
||||
* - gift_card_tax_total
|
||||
* - shipping_total
|
||||
* - shipping_subtotal
|
||||
* - shipping_tax_total
|
||||
* - original_shipping_total
|
||||
* - original_shipping_subtotal
|
||||
* - original_shipping_tax_total
|
||||
* properties:
|
||||
* return_requested_total:
|
||||
* type: number
|
||||
* title: return_requested_total
|
||||
* description: The total of the requested return.
|
||||
* order_change:
|
||||
* $ref: "#/components/schemas/AdminOrderChange"
|
||||
* items:
|
||||
* type: array
|
||||
* description: The order's items.
|
||||
* items:
|
||||
* allOf:
|
||||
* - type: object
|
||||
* description: An order's item.
|
||||
* x-schemaName: BaseOrderLineItem
|
||||
* required:
|
||||
* - id
|
||||
* - title
|
||||
* - subtitle
|
||||
* - thumbnail
|
||||
* - variant_id
|
||||
* - product_id
|
||||
* - product_title
|
||||
* - product_description
|
||||
* - product_subtitle
|
||||
* - product_type
|
||||
* - product_collection
|
||||
* - product_handle
|
||||
* - variant_sku
|
||||
* - variant_barcode
|
||||
* - variant_title
|
||||
* - variant_option_values
|
||||
* - requires_shipping
|
||||
* - is_discountable
|
||||
* - is_tax_inclusive
|
||||
* - unit_price
|
||||
* - quantity
|
||||
* - detail
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - metadata
|
||||
* - original_total
|
||||
* - original_subtotal
|
||||
* - original_tax_total
|
||||
* - item_total
|
||||
* - item_subtotal
|
||||
* - item_tax_total
|
||||
* - total
|
||||
* - subtotal
|
||||
* - tax_total
|
||||
* - discount_total
|
||||
* - discount_tax_total
|
||||
* - refundable_total
|
||||
* - refundable_total_per_unit
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The item's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The item's title.
|
||||
* subtitle:
|
||||
* type: string
|
||||
* title: subtitle
|
||||
* description: The item's subtitle.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The URL of the item's thumbnail.
|
||||
* variant:
|
||||
* $ref: "#/components/schemas/BaseProductVariant"
|
||||
* variant_id:
|
||||
* type: string
|
||||
* title: variant_id
|
||||
* description: The ID of the associated variant.
|
||||
* product:
|
||||
* $ref: "#/components/schemas/AdminProduct"
|
||||
* product_id:
|
||||
* type: string
|
||||
* title: product_id
|
||||
* description: The ID of the associated product.
|
||||
* product_title:
|
||||
* type: string
|
||||
* title: product_title
|
||||
* description: The title of the item's product.
|
||||
* product_description:
|
||||
* type: string
|
||||
* title: product_description
|
||||
* description: The description of the item's product.
|
||||
* product_subtitle:
|
||||
* type: string
|
||||
* title: product_subtitle
|
||||
* description: The subtitle of the item's product.
|
||||
* product_type:
|
||||
* type: string
|
||||
* title: product_type
|
||||
* description: The ID of type of the item's product.
|
||||
* product_collection:
|
||||
* type: string
|
||||
* title: product_collection
|
||||
* description: The ID of collection of the item's product.
|
||||
* product_handle:
|
||||
* type: string
|
||||
* title: product_handle
|
||||
* description: The handle of the item's product.
|
||||
* variant_sku:
|
||||
* type: string
|
||||
* title: variant_sku
|
||||
* description: The SKU of the item's variant.
|
||||
* variant_barcode:
|
||||
* type: string
|
||||
* title: variant_barcode
|
||||
* description: The barcode of the item's variant.
|
||||
* variant_title:
|
||||
* type: string
|
||||
* title: variant_title
|
||||
* description: The title of the item's variant.
|
||||
* variant_option_values:
|
||||
* type: object
|
||||
* 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:
|
||||
* type: boolean
|
||||
* title: requires_shipping
|
||||
* description: Whether the item requires shipping.
|
||||
* is_discountable:
|
||||
* type: boolean
|
||||
* title: is_discountable
|
||||
* description: Whether the item is discountable.
|
||||
* is_tax_inclusive:
|
||||
* type: boolean
|
||||
* title: is_tax_inclusive
|
||||
* description: Whether the item's price includes taxes.
|
||||
* compare_at_unit_price:
|
||||
* type: number
|
||||
* title: compare_at_unit_price
|
||||
* description: The original price of the item before a promotion or sale.
|
||||
* unit_price:
|
||||
* type: number
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* tax_lines:
|
||||
* type: array
|
||||
* description: The item's tax lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderLineItemTaxLine"
|
||||
* adjustments:
|
||||
* type: array
|
||||
* description: The item's adjustments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderLineItemAdjustment"
|
||||
* detail:
|
||||
* $ref: "#/components/schemas/BaseOrderItemDetail"
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The date the item was created.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the item was updated.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata, can hold custom key-value pairs.
|
||||
* original_total:
|
||||
* type: number
|
||||
* title: original_total
|
||||
* description: The item's total including taxes, excluding promotions.
|
||||
* original_subtotal:
|
||||
* type: number
|
||||
* title: original_subtotal
|
||||
* description: The item's total excluding taxes, including promotions.
|
||||
* original_tax_total:
|
||||
* type: number
|
||||
* title: original_tax_total
|
||||
* description: The tax total of the item excluding promotions.
|
||||
* item_total:
|
||||
* type: number
|
||||
* title: item_total
|
||||
* description: The item's total for a single unit including taxes and promotions.
|
||||
* item_subtotal:
|
||||
* type: number
|
||||
* title: item_subtotal
|
||||
* description: The item's total for a single unit excluding taxes, including promotions.
|
||||
* item_tax_total:
|
||||
* type: number
|
||||
* title: item_tax_total
|
||||
* description: The tax total for a single unit of the item including promotions.
|
||||
* total:
|
||||
* type: number
|
||||
* title: total
|
||||
* description: The item's total including taxes and promotions.
|
||||
* subtotal:
|
||||
* type: number
|
||||
* title: subtotal
|
||||
* description: The item's total excluding taxes, including promotions.
|
||||
* tax_total:
|
||||
* type: number
|
||||
* title: tax_total
|
||||
* description: The tax total of the item including promotions.
|
||||
* discount_total:
|
||||
* type: number
|
||||
* title: discount_total
|
||||
* description: The total of the item's discount / promotion.
|
||||
* discount_tax_total:
|
||||
* type: number
|
||||
* title: discount_tax_total
|
||||
* description: The tax total of the item's discount / promotion
|
||||
* refundable_total:
|
||||
* type: number
|
||||
* title: refundable_total
|
||||
* description: The total refundable amount of the item's total.
|
||||
* refundable_total_per_unit:
|
||||
* type: number
|
||||
* title: refundable_total_per_unit
|
||||
* description: The total refundable amount of the item's total for a single unit.
|
||||
* - type: object
|
||||
* description: An order's item.
|
||||
* properties:
|
||||
* actions:
|
||||
* type: array
|
||||
* description: The actions applied on an item.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The action's details.
|
||||
* x-schemaName: BaseOrderChangeAction
|
||||
* shipping_methods:
|
||||
* type: array
|
||||
* description: The order's shipping methods.
|
||||
* items:
|
||||
* allOf:
|
||||
* - type: object
|
||||
* description: The shipping method's details.
|
||||
* x-schemaName: BaseOrderShippingMethod
|
||||
* 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 order this shipping method belongs to.
|
||||
* 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 is tax inclusive.
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The ID of the shipping option this method was created from.
|
||||
* data:
|
||||
* type: object
|
||||
* 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:
|
||||
* 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:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_total
|
||||
* description: The shipping method's total including taxes, excluding promotions.
|
||||
* - type: number
|
||||
* title: original_total
|
||||
* description: The shipping method's total including taxes, excluding promotions.
|
||||
* original_subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's total excluding taxes, including promotions.
|
||||
* - type: number
|
||||
* title: original_subtotal
|
||||
* description: The shipping method's total excluding taxes, including promotions.
|
||||
* original_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: original_tax_total
|
||||
* description: The tax total of the shipping method excluding promotions.
|
||||
* - type: number
|
||||
* title: original_tax_total
|
||||
* description: The tax total of the shipping method excluding promotions.
|
||||
* total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: total
|
||||
* description: The shipping method's total including taxes and promotions.
|
||||
* - type: number
|
||||
* title: total
|
||||
* description: The shipping method's total including taxes and promotions.
|
||||
* subtotal:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: subtotal
|
||||
* description: The shipping method's total excluding taxes, including promotions.
|
||||
* - type: number
|
||||
* title: subtotal
|
||||
* description: The shipping method's total excluding taxes, including promotions.
|
||||
* tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: tax_total
|
||||
* description: The tax total of the shipping method including promotions.
|
||||
* - type: number
|
||||
* title: tax_total
|
||||
* description: The tax total of the shipping method including promotions.
|
||||
* discount_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: discount_total
|
||||
* description: The total of the shipping method's promotion.
|
||||
* - type: number
|
||||
* title: discount_total
|
||||
* description: The total of the shipping method's promotion.
|
||||
* discount_tax_total:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: discount_tax_total
|
||||
* description: The tax total of the shipping method's promotion.
|
||||
* - 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.
|
||||
* - type: object
|
||||
* description: The shipping method's details.
|
||||
* properties:
|
||||
* actions:
|
||||
* type: array
|
||||
* description: The actions applied on the shipping method.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The action's details.
|
||||
* x-schemaName: BaseOrderChangeAction
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The order's currency code.
|
||||
* version:
|
||||
* type: number
|
||||
* title: version
|
||||
* description: The order's version when this preview is applied.
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The order's ID.
|
||||
* region_id:
|
||||
* type: string
|
||||
* title: region_id
|
||||
* description: The ID of the order's associated region.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The ID of the customer that placed the order.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The ID of the sales channel that the order was placed in.
|
||||
* email:
|
||||
* type: string
|
||||
* title: email
|
||||
* description: The email of the customer that placed the order.
|
||||
* format: email
|
||||
* display_id:
|
||||
* type: number
|
||||
* title: display_id
|
||||
* description: The order's display ID.
|
||||
* shipping_address:
|
||||
* $ref: "#/components/schemas/AdminOrderAddress"
|
||||
* billing_address:
|
||||
* $ref: "#/components/schemas/AdminOrderAddress"
|
||||
* payment_collections:
|
||||
* type: array
|
||||
* description: The order's payment collections.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPaymentCollection"
|
||||
* payment_status:
|
||||
* type: string
|
||||
* description: The order's payment status.
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_paid
|
||||
* - awaiting
|
||||
* - authorized
|
||||
* - partially_authorized
|
||||
* - captured
|
||||
* - partially_captured
|
||||
* - partially_refunded
|
||||
* - refunded
|
||||
* - requires_action
|
||||
* fulfillments:
|
||||
* type: array
|
||||
* description: The order's fulfillments.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminOrderFulfillment"
|
||||
* fulfillment_status:
|
||||
* type: string
|
||||
* description: The order's fulfillment status.
|
||||
* enum:
|
||||
* - canceled
|
||||
* - not_fulfilled
|
||||
* - partially_fulfilled
|
||||
* - fulfilled
|
||||
* - partially_shipped
|
||||
* - shipped
|
||||
* - partially_delivered
|
||||
* - delivered
|
||||
* transactions:
|
||||
* type: array
|
||||
* description: The order's transactions.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderTransaction"
|
||||
* summary:
|
||||
* $ref: "#/components/schemas/BaseOrderSummary"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order's metadata, can hold custom key-value pairs.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The date the order was created.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The date the order was updated.
|
||||
* original_item_total:
|
||||
* type: number
|
||||
* title: original_item_total
|
||||
* description: The total of the order's items including taxes, excluding promotions.
|
||||
* original_item_subtotal:
|
||||
* type: number
|
||||
* title: original_item_subtotal
|
||||
* description: The total of the order's items excluding taxes, including promotions.
|
||||
* original_item_tax_total:
|
||||
* type: number
|
||||
* title: original_item_tax_total
|
||||
* description: The tax total of the order's items excluding promotions.
|
||||
* item_total:
|
||||
* type: number
|
||||
* title: item_total
|
||||
* description: The total of the order's items including taxes and promotions.
|
||||
* item_subtotal:
|
||||
* type: number
|
||||
* title: item_subtotal
|
||||
* description: The total of the order's items excluding taxes, including promotions.
|
||||
* item_tax_total:
|
||||
* type: number
|
||||
* title: item_tax_total
|
||||
* description: The tax total of the order's items including promotions.
|
||||
* original_total:
|
||||
* type: number
|
||||
* title: original_total
|
||||
* description: The order's total excluding promotions, including taxes.
|
||||
* original_subtotal:
|
||||
* type: number
|
||||
* title: original_subtotal
|
||||
* description: The order's total excluding taxes, including promotions.
|
||||
* original_tax_total:
|
||||
* type: number
|
||||
* title: original_tax_total
|
||||
* description: The order's tax total, excluding promotions.
|
||||
* total:
|
||||
* type: number
|
||||
* title: total
|
||||
* description: The order's total including taxes and promotions.
|
||||
* subtotal:
|
||||
* type: number
|
||||
* title: subtotal
|
||||
* description: The order's total excluding taxes, including promotions.
|
||||
* tax_total:
|
||||
* type: number
|
||||
* title: tax_total
|
||||
* description: The order's tax total including promotions.
|
||||
* discount_total:
|
||||
* type: number
|
||||
* title: discount_total
|
||||
* description: The order's discount or promotions total.
|
||||
* discount_tax_total:
|
||||
* type: number
|
||||
* title: discount_tax_total
|
||||
* description: The tax total of order's discount or promotion.
|
||||
* gift_card_total:
|
||||
* type: number
|
||||
* title: gift_card_total
|
||||
* description: The order's gift card total.
|
||||
* gift_card_tax_total:
|
||||
* type: number
|
||||
* title: gift_card_tax_total
|
||||
* description: The tax total of the order's gift card.
|
||||
* shipping_total:
|
||||
* type: number
|
||||
* title: shipping_total
|
||||
* description: The order's shipping total including taxes and promotions.
|
||||
* shipping_subtotal:
|
||||
* type: number
|
||||
* title: shipping_subtotal
|
||||
* description: The order's shipping total excluding taxes, including promotions.
|
||||
* shipping_tax_total:
|
||||
* type: number
|
||||
* title: shipping_tax_total
|
||||
* description: The tax total of the order's shipping.
|
||||
* original_shipping_total:
|
||||
* type: number
|
||||
* title: original_shipping_total
|
||||
* description: The order's shipping total including taxes, excluding promotions.
|
||||
* original_shipping_subtotal:
|
||||
* type: number
|
||||
* title: original_shipping_subtotal
|
||||
* description: The order's shipping total excluding taxes, including promotions.
|
||||
* original_shipping_tax_total:
|
||||
* type: number
|
||||
* title: original_shipping_tax_total
|
||||
* description: The tax total of the order's shipping excluding promotions.
|
||||
* customer:
|
||||
* $ref: "#/components/schemas/AdminCustomer"
|
||||
* sales_channel:
|
||||
* $ref: "#/components/schemas/AdminSalesChannel"
|
||||
* status:
|
||||
* type: string
|
||||
* title: status
|
||||
* description: The order's status.
|
||||
* region:
|
||||
* $ref: "#/components/schemas/AdminRegion"
|
||||
* credit_lines:
|
||||
* type: array
|
||||
* description: The order preview's credit lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderCreditLine"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminDraftOrderPreviewResponse
|
||||
* type: object
|
||||
* description: The details of the preview on the draft order.
|
||||
* x-schemaName: AdminDraftOrderPreviewResponse
|
||||
* required:
|
||||
* - draft_order_preview
|
||||
* properties:
|
||||
* draft_order_preview:
|
||||
* $ref: "#/components/schemas/AdminDraftOrderPreview"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -242,6 +242,13 @@
|
||||
* type: string
|
||||
* title: status
|
||||
* description: The order's status.
|
||||
* region:
|
||||
* $ref: "#/components/schemas/AdminRegion"
|
||||
* credit_lines:
|
||||
* type: array
|
||||
* description: The order's credit lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderCreditLine"
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -622,6 +622,13 @@
|
||||
* type: string
|
||||
* title: status
|
||||
* description: The order's status.
|
||||
* region:
|
||||
* $ref: "#/components/schemas/AdminRegion"
|
||||
* credit_lines:
|
||||
* type: array
|
||||
* description: The order preview's credit lines.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderCreditLine"
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
/**
|
||||
* @schema AdminPlugin
|
||||
* type: object
|
||||
* description: The plugin's details.
|
||||
* x-schemaName: AdminPlugin
|
||||
* required:
|
||||
* - name
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The plugin's name.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminPluginsListResponse
|
||||
* type: object
|
||||
* description: The list of plugins.
|
||||
* x-schemaName: AdminPluginsListResponse
|
||||
* required:
|
||||
* - plugins
|
||||
* properties:
|
||||
* plugins:
|
||||
* type: array
|
||||
* description: The list of plugins.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminPlugin"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
/**
|
||||
* @schema AdminRemoveDraftOrderPromotions
|
||||
* type: object
|
||||
* description: The promotion codes to remove from the draft order.
|
||||
* x-schemaName: AdminRemoveDraftOrderPromotions
|
||||
* required:
|
||||
* - promo_codes
|
||||
* properties:
|
||||
* promo_codes:
|
||||
* type: array
|
||||
* description: The promotion codes to remove from the draft order.
|
||||
* items:
|
||||
* type: string
|
||||
* title: promo_codes
|
||||
* description: A promotion code to remove from the draft order.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -108,6 +108,14 @@
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The draft order's metadata, can hold custom key-value pairs.
|
||||
* customer_id:
|
||||
* type: string
|
||||
* title: customer_id
|
||||
* description: The ID of the customer associated with the draft order.
|
||||
* sales_channel_id:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: The ID of the sales channel associated with the draft order.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* @schema AdminUpdateDraftOrderActionShippingMethod
|
||||
* type: object
|
||||
* description: The updates to make on a changed shipping method.
|
||||
* x-schemaName: AdminUpdateDraftOrderActionShippingMethod
|
||||
* required:
|
||||
* - shipping_option_id
|
||||
* properties:
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The ID of the associated shipping option.
|
||||
* custom_amount:
|
||||
* type: number
|
||||
* title: custom_amount
|
||||
* description: The custom amount of the shipping method. If not provided, the shipping option's amount will be used.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The shipping method's description.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note viewed only by admin users about the shipping method.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
/**
|
||||
* @schema AdminUpdateDraftOrderItem
|
||||
* type: object
|
||||
* description: The updates to make on a draft order's item.
|
||||
* x-schemaName: AdminUpdateDraftOrderItem
|
||||
* required:
|
||||
* - quantity
|
||||
* properties:
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The item's quantity.
|
||||
* unit_price:
|
||||
* type: number
|
||||
* title: unit_price
|
||||
* description: The item's unit price.
|
||||
* compare_at_unit_price:
|
||||
* type: number
|
||||
* title: compare_at_unit_price
|
||||
* description: The original price of the item before a promotion or sale.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note viewed only by admin users about the item.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* @schema AdminUpdateDraftOrderShippingMethod
|
||||
* type: object
|
||||
* description: The updates to make on a draft order's shipping method.
|
||||
* x-schemaName: AdminUpdateDraftOrderShippingMethod
|
||||
* properties:
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The ID of the associated shipping option.
|
||||
* custom_amount:
|
||||
* type: number
|
||||
* title: custom_amount
|
||||
* description: The custom amount of the shipping method. If not provided, the shipping option's amount will be used.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note viewed only by admin users about the shipping method.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -99,6 +99,80 @@
|
||||
* summary:
|
||||
* type: object
|
||||
* description: The order's summary.
|
||||
* properties:
|
||||
* pending_difference:
|
||||
* type: number
|
||||
* title: pending_difference
|
||||
* description: The remaining amount to be paid or refunded.
|
||||
* current_order_total:
|
||||
* type: number
|
||||
* title: current_order_total
|
||||
* description: The order's current total.
|
||||
* original_order_total:
|
||||
* type: number
|
||||
* title: original_order_total
|
||||
* description: The order's total before any changes.
|
||||
* transaction_total:
|
||||
* type: number
|
||||
* title: transaction_total
|
||||
* description: The total of the transactions (payments and refunds) made on the order.
|
||||
* paid_total:
|
||||
* type: number
|
||||
* title: paid_total
|
||||
* description: The total paid amount.
|
||||
* refunded_total:
|
||||
* type: number
|
||||
* title: refunded_total
|
||||
* description: The total refunded amount.
|
||||
* credit_line_total:
|
||||
* type: number
|
||||
* title: credit_line_total
|
||||
* description: The total credit line amount.
|
||||
* accounting_total:
|
||||
* type: number
|
||||
* title: accounting_total
|
||||
* description: The total amount for accounting purposes.
|
||||
* raw_pending_difference:
|
||||
* type: object
|
||||
* description: The summary's raw pending difference.
|
||||
* raw_current_order_total:
|
||||
* type: object
|
||||
* description: The summary's raw current order total.
|
||||
* raw_original_order_total:
|
||||
* type: object
|
||||
* description: The summary's raw original order total.
|
||||
* raw_transaction_total:
|
||||
* type: object
|
||||
* description: The summary's raw transaction total.
|
||||
* raw_paid_total:
|
||||
* type: object
|
||||
* description: The summary's raw paid total.
|
||||
* raw_refunded_total:
|
||||
* type: object
|
||||
* description: The summary's raw refunded total.
|
||||
* raw_credit_line_total:
|
||||
* type: object
|
||||
* description: The summary's raw credit line total.
|
||||
* raw_accounting_total:
|
||||
* type: object
|
||||
* description: The summary's raw accounting total.
|
||||
* required:
|
||||
* - pending_difference
|
||||
* - current_order_total
|
||||
* - original_order_total
|
||||
* - transaction_total
|
||||
* - paid_total
|
||||
* - refunded_total
|
||||
* - credit_line_total
|
||||
* - accounting_total
|
||||
* - raw_pending_difference
|
||||
* - raw_current_order_total
|
||||
* - raw_original_order_total
|
||||
* - raw_transaction_total
|
||||
* - raw_paid_total
|
||||
* - raw_refunded_total
|
||||
* - raw_credit_line_total
|
||||
* - raw_accounting_total
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The order's metadata, can hold custom key-value pairs.
|
||||
@@ -218,6 +292,10 @@
|
||||
* description: The order's credit lines, useful to add additional payment amounts for an order.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderCreditLine"
|
||||
* is_draft_order:
|
||||
* type: boolean
|
||||
* title: is_draft_order
|
||||
* description: Whether the order is a draft order.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@
|
||||
* - title
|
||||
* - requires_shipping
|
||||
* - is_discountable
|
||||
* - is_giftcard
|
||||
* - is_tax_inclusive
|
||||
* - unit_price
|
||||
* - quantity
|
||||
@@ -198,6 +199,10 @@
|
||||
* type: string
|
||||
* title: product_type_id
|
||||
* description: The ID of the associated product's type.
|
||||
* is_giftcard:
|
||||
* type: boolean
|
||||
* title: is_giftcard
|
||||
* description: Whether the item is a gift card.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
/**
|
||||
* @schema StoreCartRemovePromotion
|
||||
* type: object
|
||||
* description: The promotion code to remove from the cart.
|
||||
* x-schemaName: StoreCartRemovePromotion
|
||||
* required:
|
||||
* - promo_codes
|
||||
* properties:
|
||||
* promo_codes:
|
||||
* type: array
|
||||
* description: The promotion code to remove from the cart.
|
||||
* items:
|
||||
* type: string
|
||||
* title: promo_codes
|
||||
* description: A promotion code to remove from the cart.
|
||||
*
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user