diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}/get.sh new file mode 100644 index 0000000000..4d7144d71d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/exchanges/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits/post.sh new file mode 100644 index 0000000000..eec0749c3a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/order-edits' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "order_id": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}/delete.sh new file mode 100644 index 0000000000..ed511894ba --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/order-edits/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_confirm/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_confirm/post.sh new file mode 100644 index 0000000000..7ace65c4b0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_confirm/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/order-edits/{id}/confirm' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items/post.sh new file mode 100644 index 0000000000..8c938f2636 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/order-edits/{id}/items' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/delete.sh new file mode 100644 index 0000000000..2b3de1670f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/post.sh new file mode 100644 index 0000000000..fb5e00735f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_items_{action_id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method/post.sh new file mode 100644 index 0000000000..1387c4fcec --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "shipping_option_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/delete.sh new file mode 100644 index 0000000000..c2bdc3a123 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/post.sh new file mode 100644 index 0000000000..2d2fd50088 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml index f463a9ee83..477ff17bd7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml @@ -6,6 +6,6 @@ required: - claim properties: order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml claim: $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml index 74bbc37b56..3b7c3d283c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml @@ -9,6 +9,6 @@ properties: return: $ref: ./AdminReturn.yaml order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml claim: $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml index ff9659b347..296a46bca0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml @@ -6,6 +6,6 @@ required: - return properties: order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml return: $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml index 6776dd01d0..4178d2079e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml @@ -6,6 +6,6 @@ required: - exchange properties: order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml exchange: $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml index 400aec0e26..16b834277c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml @@ -9,6 +9,6 @@ properties: return: $ref: ./AdminReturn.yaml order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml exchange: $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml index f0db225699..d357aa7c5f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml @@ -6,6 +6,6 @@ required: - return properties: order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml return: $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditPreviewResponse.yaml new file mode 100644 index 0000000000..09feaf500f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditPreviewResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderEditPreviewResponse +required: + - order_preview +properties: + order_preview: + $ref: ./OrderPreview.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml similarity index 82% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml index d058255237..e48200586c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: AdminPostExhangesItemsActionReqSchema +x-schemaName: AdminPostExchangesItemsActionReqSchema properties: quantity: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml new file mode 100644 index 0000000000..e1298622f0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsAddItemsReqSchema +properties: + items: + type: array + description: The order edit's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + allow_backorder: + type: boolean + title: allow_backorder + description: The item's allow backorder. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml new file mode 100644 index 0000000000..b366dab18e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The order edit's quantity. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml new file mode 100644 index 0000000000..592ffc30b3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml @@ -0,0 +1,22 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsReqSchema +required: + - order_id + - metadata +properties: + order_id: + type: string + title: order_id + description: The order edit's order id. + description: + type: string + title: description + description: The order edit's description. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml new file mode 100644 index 0000000000..ce424d8297 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsShippingActionReqSchema +properties: + custom_price: + type: number + title: custom_price + description: The order edit's custom price. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml new file mode 100644 index 0000000000..91e223dc84 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml @@ -0,0 +1,25 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsShippingReqSchema +required: + - shipping_option_id +properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The order edit's shipping option id. + custom_price: + type: number + title: custom_price + description: The order edit's custom price. + description: + type: string + title: description + description: The order edit's description. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml index f138b6e974..8c90e11018 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -1,936 +1,3 @@ type: object -description: The exchange's order preview. +description: The transaction's order. x-schemaName: Order -required: - - id - - version - - status - - currency_code - - 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 - - raw_original_item_total - - raw_original_item_subtotal - - raw_original_item_tax_total - - raw_item_total - - raw_item_subtotal - - raw_item_tax_total - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - - raw_gift_card_total - - raw_gift_card_tax_total - - raw_shipping_total - - raw_shipping_subtotal - - raw_shipping_tax_total - - raw_original_shipping_total - - raw_original_shipping_subtotal - - raw_original_shipping_tax_total -properties: - id: - type: string - title: id - description: The order preview's ID. - version: - type: number - title: version - description: The order preview's version. - order_change: - $ref: ./OrderChange.yaml - status: - type: string - enum: - - canceled - - requires_action - - pending - - completed - - draft - - archived - region_id: - type: string - title: region_id - description: The order preview's region id. - customer_id: - type: string - title: customer_id - description: The order preview's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The order preview's sales channel id. - email: - type: string - title: email - description: The order preview's email. - format: email - currency_code: - type: string - title: currency_code - description: The order preview's currency code. - shipping_address: - $ref: ./OrderAddress.yaml - billing_address: - $ref: ./OrderAddress.yaml - items: - type: array - description: The order preview's items. - items: - $ref: ./OrderLineItem.yaml - shipping_methods: - type: array - description: The order preview's shipping methods. - items: - $ref: ./OrderShippingMethod.yaml - transactions: - type: array - description: The order preview's transactions. - items: - $ref: ./OrderTransaction.yaml - summary: - type: object - description: The order preview's summary. - required: - - total - - subtotal - - total_tax - - ordered_total - - fulfilled_total - - returned_total - - return_request_total - - write_off_total - - projected_total - - net_total - - net_subtotal - - net_total_tax - - balance - - paid_total - - refunded_total - properties: - total: - oneOf: - - type: string - title: total - description: The summary's total. - - type: number - title: total - description: The summary's total. - - type: string - title: total - description: The summary's total. - - type: object - description: The summary's total. - x-schemaName: IBigNumber - subtotal: - oneOf: - - type: string - title: subtotal - description: The summary's subtotal. - - type: number - title: subtotal - description: The summary's subtotal. - - type: string - title: subtotal - description: The summary's subtotal. - - type: object - description: The summary's subtotal. - x-schemaName: IBigNumber - total_tax: - oneOf: - - type: string - title: total_tax - description: The summary's total tax. - - type: number - title: total_tax - description: The summary's total tax. - - type: string - title: total_tax - description: The summary's total tax. - - type: object - description: The summary's total tax. - x-schemaName: IBigNumber - ordered_total: - oneOf: - - type: string - title: ordered_total - description: The summary's ordered total. - - type: number - title: ordered_total - description: The summary's ordered total. - - type: string - title: ordered_total - description: The summary's ordered total. - - type: object - description: The summary's ordered total. - x-schemaName: IBigNumber - fulfilled_total: - oneOf: - - type: string - title: fulfilled_total - description: The summary's fulfilled total. - - type: number - title: fulfilled_total - description: The summary's fulfilled total. - - type: string - title: fulfilled_total - description: The summary's fulfilled total. - - type: object - description: The summary's fulfilled total. - x-schemaName: IBigNumber - returned_total: - oneOf: - - type: string - title: returned_total - description: The summary's returned total. - - type: number - title: returned_total - description: The summary's returned total. - - type: string - title: returned_total - description: The summary's returned total. - - type: object - description: The summary's returned total. - x-schemaName: IBigNumber - return_request_total: - oneOf: - - type: string - title: return_request_total - description: The summary's return request total. - - type: number - title: return_request_total - description: The summary's return request total. - - type: string - title: return_request_total - description: The summary's return request total. - - type: object - description: The summary's return request total. - x-schemaName: IBigNumber - write_off_total: - oneOf: - - type: string - title: write_off_total - description: The summary's write off total. - - type: number - title: write_off_total - description: The summary's write off total. - - type: string - title: write_off_total - description: The summary's write off total. - - type: object - description: The summary's write off total. - x-schemaName: IBigNumber - projected_total: - oneOf: - - type: string - title: projected_total - description: The summary's projected total. - - type: number - title: projected_total - description: The summary's projected total. - - type: string - title: projected_total - description: The summary's projected total. - - type: object - description: The summary's projected total. - x-schemaName: IBigNumber - net_total: - oneOf: - - type: string - title: net_total - description: The summary's net total. - - type: number - title: net_total - description: The summary's net total. - - type: string - title: net_total - description: The summary's net total. - - type: object - description: The summary's net total. - x-schemaName: IBigNumber - net_subtotal: - oneOf: - - type: string - title: net_subtotal - description: The summary's net subtotal. - - type: number - title: net_subtotal - description: The summary's net subtotal. - - type: string - title: net_subtotal - description: The summary's net subtotal. - - type: object - description: The summary's net subtotal. - x-schemaName: IBigNumber - net_total_tax: - oneOf: - - type: string - title: net_total_tax - description: The summary's net total tax. - - type: number - title: net_total_tax - description: The summary's net total tax. - - type: string - title: net_total_tax - description: The summary's net total tax. - - type: object - description: The summary's net total tax. - x-schemaName: IBigNumber - balance: - oneOf: - - type: string - title: balance - description: The summary's balance. - - type: number - title: balance - description: The summary's balance. - - type: string - title: balance - description: The summary's balance. - - type: object - description: The summary's balance. - x-schemaName: IBigNumber - paid_total: - oneOf: - - type: string - title: paid_total - description: The summary's paid total. - - type: number - title: paid_total - description: The summary's paid total. - - type: string - title: paid_total - description: The summary's paid total. - - type: object - description: The summary's paid total. - x-schemaName: IBigNumber - refunded_total: - oneOf: - - type: string - title: refunded_total - description: The summary's refunded total. - - type: number - title: refunded_total - description: The summary's refunded total. - - type: string - title: refunded_total - description: The summary's refunded total. - - type: object - description: The summary's refunded total. - x-schemaName: IBigNumber - metadata: - type: object - description: The order preview's metadata. - canceled_at: - oneOf: - - type: string - title: canceled_at - description: The order preview's canceled at. - - type: string - title: canceled_at - description: The order preview's canceled at. - format: date-time - created_at: - type: string - format: date-time - title: created_at - description: The order preview's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The order preview's updated at. - original_item_total: - oneOf: - - type: string - title: original_item_total - description: The order preview's original item total. - - type: number - title: original_item_total - description: The order preview's original item total. - - type: string - title: original_item_total - description: The order preview's original item total. - - $ref: ./IBigNumber.yaml - original_item_subtotal: - oneOf: - - type: string - title: original_item_subtotal - description: The order preview's original item subtotal. - - type: number - title: original_item_subtotal - description: The order preview's original item subtotal. - - type: string - title: original_item_subtotal - description: The order preview's original item subtotal. - - $ref: ./IBigNumber.yaml - original_item_tax_total: - oneOf: - - type: string - title: original_item_tax_total - description: The order preview's original item tax total. - - type: number - title: original_item_tax_total - description: The order preview's original item tax total. - - type: string - title: original_item_tax_total - description: The order preview's original item tax total. - - $ref: ./IBigNumber.yaml - item_total: - oneOf: - - type: string - title: item_total - description: The order preview's item total. - - type: number - title: item_total - description: The order preview's item total. - - type: string - title: item_total - description: The order preview's item total. - - $ref: ./IBigNumber.yaml - item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The order preview's item subtotal. - - type: number - title: item_subtotal - description: The order preview's item subtotal. - - type: string - title: item_subtotal - description: The order preview's item subtotal. - - $ref: ./IBigNumber.yaml - item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The order preview's item tax total. - - type: number - title: item_tax_total - description: The order preview's item tax total. - - type: string - title: item_tax_total - description: The order preview's item tax total. - - $ref: ./IBigNumber.yaml - original_total: - oneOf: - - type: string - title: original_total - description: The order preview's original total. - - type: number - title: original_total - description: The order preview's original total. - - type: string - title: original_total - description: The order preview's original total. - - $ref: ./IBigNumber.yaml - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The order preview's original subtotal. - - type: number - title: original_subtotal - description: The order preview's original subtotal. - - type: string - title: original_subtotal - description: The order preview's original subtotal. - - $ref: ./IBigNumber.yaml - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The order preview's original tax total. - - type: number - title: original_tax_total - description: The order preview's original tax total. - - type: string - title: original_tax_total - description: The order preview's original tax total. - - $ref: ./IBigNumber.yaml - total: - oneOf: - - type: string - title: total - description: The order preview's total. - - type: number - title: total - description: The order preview's total. - - type: string - title: total - description: The order preview's total. - - $ref: ./IBigNumber.yaml - subtotal: - oneOf: - - type: string - title: subtotal - description: The order preview's subtotal. - - type: number - title: subtotal - description: The order preview's subtotal. - - type: string - title: subtotal - description: The order preview's subtotal. - - $ref: ./IBigNumber.yaml - tax_total: - oneOf: - - type: string - title: tax_total - description: The order preview's tax total. - - type: number - title: tax_total - description: The order preview's tax total. - - type: string - title: tax_total - description: The order preview's tax total. - - $ref: ./IBigNumber.yaml - discount_total: - oneOf: - - type: string - title: discount_total - description: The order preview's discount total. - - type: number - title: discount_total - description: The order preview's discount total. - - type: string - title: discount_total - description: The order preview's discount total. - - $ref: ./IBigNumber.yaml - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The order preview's discount tax total. - - type: number - title: discount_tax_total - description: The order preview's discount tax total. - - type: string - title: discount_tax_total - description: The order preview's discount tax total. - - $ref: ./IBigNumber.yaml - gift_card_total: - oneOf: - - type: string - title: gift_card_total - description: The order preview's gift card total. - - type: number - title: gift_card_total - description: The order preview's gift card total. - - type: string - title: gift_card_total - description: The order preview's gift card total. - - $ref: ./IBigNumber.yaml - gift_card_tax_total: - oneOf: - - type: string - title: gift_card_tax_total - description: The order preview's gift card tax total. - - type: number - title: gift_card_tax_total - description: The order preview's gift card tax total. - - type: string - title: gift_card_tax_total - description: The order preview's gift card tax total. - - $ref: ./IBigNumber.yaml - shipping_total: - oneOf: - - type: string - title: shipping_total - description: The order preview's shipping total. - - type: number - title: shipping_total - description: The order preview's shipping total. - - type: string - title: shipping_total - description: The order preview's shipping total. - - $ref: ./IBigNumber.yaml - shipping_subtotal: - oneOf: - - type: string - title: shipping_subtotal - description: The order preview's shipping subtotal. - - type: number - title: shipping_subtotal - description: The order preview's shipping subtotal. - - type: string - title: shipping_subtotal - description: The order preview's shipping subtotal. - - $ref: ./IBigNumber.yaml - shipping_tax_total: - oneOf: - - type: string - title: shipping_tax_total - description: The order preview's shipping tax total. - - type: number - title: shipping_tax_total - description: The order preview's shipping tax total. - - type: string - title: shipping_tax_total - description: The order preview's shipping tax total. - - $ref: ./IBigNumber.yaml - original_shipping_total: - oneOf: - - type: string - title: original_shipping_total - description: The order preview's original shipping total. - - type: number - title: original_shipping_total - description: The order preview's original shipping total. - - type: string - title: original_shipping_total - description: The order preview's original shipping total. - - $ref: ./IBigNumber.yaml - original_shipping_subtotal: - oneOf: - - type: string - title: original_shipping_subtotal - description: The order preview's original shipping subtotal. - - type: number - title: original_shipping_subtotal - description: The order preview's original shipping subtotal. - - type: string - title: original_shipping_subtotal - description: The order preview's original shipping subtotal. - - $ref: ./IBigNumber.yaml - original_shipping_tax_total: - oneOf: - - type: string - title: original_shipping_tax_total - description: The order preview's original shipping tax total. - - type: number - title: original_shipping_tax_total - description: The order preview's original shipping tax total. - - type: string - title: original_shipping_tax_total - description: The order preview's original shipping tax total. - - $ref: ./IBigNumber.yaml - raw_original_item_total: - type: object - description: The order preview's raw original item total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original item total's value. - - type: number - title: value - description: The raw original item total's value. - raw_original_item_subtotal: - type: object - description: The order preview's raw original item subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original item subtotal's value. - - type: number - title: value - description: The raw original item subtotal's value. - raw_original_item_tax_total: - type: object - description: The order preview's raw original item tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original item tax total's value. - - type: number - title: value - description: The raw original item tax total's value. - raw_item_total: - type: object - description: The order preview's raw item total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw item total's value. - - type: number - title: value - description: The raw item total's value. - raw_item_subtotal: - type: object - description: The order preview's raw item subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw item subtotal's value. - - type: number - title: value - description: The raw item subtotal's value. - raw_item_tax_total: - type: object - description: The order preview's raw item tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw item tax total's value. - - type: number - title: value - description: The raw item tax total's value. - raw_original_total: - type: object - description: The order preview's raw original total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original total's value. - - type: number - title: value - description: The raw original total's value. - raw_original_subtotal: - type: object - description: The order preview's raw original subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original subtotal's value. - - type: number - title: value - description: The raw original subtotal's value. - raw_original_tax_total: - type: object - description: The order preview's raw original tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original tax total's value. - - type: number - title: value - description: The raw original tax total's value. - raw_total: - type: object - description: The order preview's raw total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw total's value. - - type: number - title: value - description: The raw total's value. - raw_subtotal: - type: object - description: The order preview's raw subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw subtotal's value. - - type: number - title: value - description: The raw subtotal's value. - raw_tax_total: - type: object - description: The order preview's raw tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw tax total's value. - - type: number - title: value - description: The raw tax total's value. - raw_discount_total: - type: object - description: The order preview's raw discount total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw discount total's value. - - type: number - title: value - description: The raw discount total's value. - raw_discount_tax_total: - type: object - description: The order preview's raw discount tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw discount tax total's value. - - type: number - title: value - description: The raw discount tax total's value. - raw_gift_card_total: - type: object - description: The order preview's raw gift card total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw gift card total's value. - - type: number - title: value - description: The raw gift card total's value. - raw_gift_card_tax_total: - type: object - description: The order preview's raw gift card tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw gift card tax total's value. - - type: number - title: value - description: The raw gift card tax total's value. - raw_shipping_total: - type: object - description: The order preview's raw shipping total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw shipping total's value. - - type: number - title: value - description: The raw shipping total's value. - raw_shipping_subtotal: - type: object - description: The order preview's raw shipping subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw shipping subtotal's value. - - type: number - title: value - description: The raw shipping subtotal's value. - raw_shipping_tax_total: - type: object - description: The order preview's raw shipping tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw shipping tax total's value. - - type: number - title: value - description: The raw shipping tax total's value. - raw_original_shipping_total: - type: object - description: The order preview's raw original shipping total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original shipping total's value. - - type: number - title: value - description: The raw original shipping total's value. - raw_original_shipping_subtotal: - type: object - description: The order preview's raw original shipping subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original shipping subtotal's value. - - type: number - title: value - description: The raw original shipping subtotal's value. - raw_original_shipping_tax_total: - type: object - description: The order preview's raw original shipping tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original shipping tax total's value. - - type: number - title: value - description: The raw original shipping tax total's value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml deleted file mode 100644 index 971b9caf80..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml +++ /dev/null @@ -1,359 +0,0 @@ -type: object -description: The item's items. -x-schemaName: OrderLineItem -required: - - id - - title - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - - raw_unit_price - - quantity - - raw_quantity - - detail - - created_at - - updated_at - - 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 - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_item_total - - raw_item_subtotal - - raw_item_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - - raw_refundable_total - - raw_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 item's thumbnail. - variant_id: - type: string - title: variant_id - description: The item's variant id. - product_id: - type: string - title: product_id - description: The item's product id. - product_title: - type: string - title: product_title - description: The item's product title. - product_description: - type: string - title: product_description - description: The item's product description. - product_subtitle: - type: string - title: product_subtitle - description: The item's product subtitle. - product_type: - type: string - title: product_type - description: The item's product type. - product_collection: - type: string - title: product_collection - description: The item's product collection. - product_handle: - type: string - title: product_handle - description: The item's product handle. - variant_sku: - type: string - title: variant_sku - description: The item's variant sku. - variant_barcode: - type: string - title: variant_barcode - description: The item's variant barcode. - variant_title: - type: string - title: variant_title - description: The item's variant title. - variant_option_values: - type: object - description: The item's variant option values. - requires_shipping: - type: boolean - title: requires_shipping - description: The item's requires shipping. - is_discountable: - type: boolean - title: is_discountable - description: The item's is discountable. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The item's is tax inclusive. - compare_at_unit_price: - type: number - title: compare_at_unit_price - description: The item's compare at unit price. - raw_compare_at_unit_price: - type: object - description: The item's raw compare at unit price. - unit_price: - type: number - title: unit_price - description: The item's unit price. - raw_unit_price: - type: object - description: The item's raw unit price. - quantity: - type: number - title: quantity - description: The item's quantity. - raw_quantity: - type: object - description: The item's raw quantity. - tax_lines: - type: array - description: The item's tax lines. - items: - $ref: ./OrderLineItemTaxLine.yaml - adjustments: - type: array - description: The item's adjustments. - items: - $ref: ./OrderLineItemAdjustment.yaml - detail: - $ref: ./OrderItem.yaml - created_at: - type: string - title: created_at - description: The item's created at. - format: date-time - updated_at: - type: string - title: updated_at - description: The item's updated at. - format: date-time - metadata: - type: object - description: The item's metadata. - original_total: - oneOf: - - type: string - title: original_total - description: The item's original total. - - type: number - title: original_total - description: The item's original total. - - type: string - title: original_total - description: The item's original total. - - $ref: ./IBigNumber.yaml - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The item's original subtotal. - - type: number - title: original_subtotal - description: The item's original subtotal. - - type: string - title: original_subtotal - description: The item's original subtotal. - - $ref: ./IBigNumber.yaml - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The item's original tax total. - - type: number - title: original_tax_total - description: The item's original tax total. - - type: string - title: original_tax_total - description: The item's original tax total. - - $ref: ./IBigNumber.yaml - item_total: - oneOf: - - type: string - title: item_total - description: The item's item total. - - type: number - title: item_total - description: The item's item total. - - type: string - title: item_total - description: The item's item total. - - $ref: ./IBigNumber.yaml - item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The item's item subtotal. - - type: number - title: item_subtotal - description: The item's item subtotal. - - type: string - title: item_subtotal - description: The item's item subtotal. - - $ref: ./IBigNumber.yaml - item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The item's item tax total. - - type: number - title: item_tax_total - description: The item's item tax total. - - type: string - title: item_tax_total - description: The item's item tax total. - - $ref: ./IBigNumber.yaml - total: - oneOf: - - type: string - title: total - description: The item's total. - - type: number - title: total - description: The item's total. - - type: string - title: total - description: The item's total. - - $ref: ./IBigNumber.yaml - subtotal: - oneOf: - - type: string - title: subtotal - description: The item's subtotal. - - type: number - title: subtotal - description: The item's subtotal. - - type: string - title: subtotal - description: The item's subtotal. - - $ref: ./IBigNumber.yaml - tax_total: - oneOf: - - type: string - title: tax_total - description: The item's tax total. - - type: number - title: tax_total - description: The item's tax total. - - type: string - title: tax_total - description: The item's tax total. - - $ref: ./IBigNumber.yaml - discount_total: - oneOf: - - type: string - title: discount_total - description: The item's discount total. - - type: number - title: discount_total - description: The item's discount total. - - type: string - title: discount_total - description: The item's discount total. - - $ref: ./IBigNumber.yaml - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The item's discount tax total. - - type: number - title: discount_tax_total - description: The item's discount tax total. - - type: string - title: discount_tax_total - description: The item's discount tax total. - - $ref: ./IBigNumber.yaml - refundable_total: - oneOf: - - type: string - title: refundable_total - description: The item's refundable total. - - type: number - title: refundable_total - description: The item's refundable total. - - type: string - title: refundable_total - description: The item's refundable total. - - $ref: ./IBigNumber.yaml - refundable_total_per_unit: - oneOf: - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: number - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - $ref: ./IBigNumber.yaml - raw_original_total: - type: object - description: The item's raw original total. - raw_original_subtotal: - type: object - description: The item's raw original subtotal. - raw_original_tax_total: - type: object - description: The item's raw original tax total. - raw_item_total: - type: object - description: The item's raw item total. - raw_item_subtotal: - type: object - description: The item's raw item subtotal. - raw_item_tax_total: - type: object - description: The item's raw item tax total. - raw_total: - type: object - description: The item's raw total. - raw_subtotal: - type: object - description: The item's raw subtotal. - raw_tax_total: - type: object - description: The item's raw tax total. - raw_discount_total: - type: object - description: The item's raw discount total. - raw_discount_tax_total: - type: object - description: The item's raw discount tax total. - raw_refundable_total: - type: object - description: The item's raw refundable total. - raw_refundable_total_per_unit: - type: object - description: The item's raw refundable total per unit. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml new file mode 100644 index 0000000000..3753f8ac74 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml @@ -0,0 +1,1530 @@ +type: object +description: The exchange's order preview. +x-schemaName: OrderPreview +required: + - order_change + - status + - currency_code + - id + - version + - 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 + - raw_original_item_total + - raw_original_item_subtotal + - raw_original_item_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_gift_card_total + - raw_gift_card_tax_total + - raw_shipping_total + - raw_shipping_subtotal + - raw_shipping_tax_total + - raw_original_shipping_total + - raw_original_shipping_subtotal + - raw_original_shipping_tax_total +properties: + order_change: + $ref: ./OrderChange.yaml + items: + type: array + description: The order preview's items. + items: + allOf: + - type: object + description: The item's items. + x-schemaName: OrderLineItem + required: + - id + - title + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - raw_unit_price + - quantity + - raw_quantity + - detail + - created_at + - updated_at + - 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 + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_refundable_total + - raw_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 item's thumbnail. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + raw_unit_price: + type: object + description: The item's raw unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./OrderLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./OrderLineItemAdjustment.yaml + detail: + $ref: ./OrderItem.yaml + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: ./IBigNumber.yaml + refundable_total: + oneOf: + - type: string + title: refundable_total + description: The item's refundable total. + - type: number + title: refundable_total + description: The item's refundable total. + - type: string + title: refundable_total + description: The item's refundable total. + - $ref: ./IBigNumber.yaml + refundable_total_per_unit: + oneOf: + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - $ref: ./IBigNumber.yaml + raw_original_total: + type: object + description: The item's raw original total. + raw_original_subtotal: + type: object + description: The item's raw original subtotal. + raw_original_tax_total: + type: object + description: The item's raw original tax total. + raw_item_total: + type: object + description: The item's raw item total. + raw_item_subtotal: + type: object + description: The item's raw item subtotal. + raw_item_tax_total: + type: object + description: The item's raw item tax total. + raw_total: + type: object + description: The item's raw total. + raw_subtotal: + type: object + description: The item's raw subtotal. + raw_tax_total: + type: object + description: The item's raw tax total. + raw_discount_total: + type: object + description: The item's raw discount total. + raw_discount_tax_total: + type: object + description: The item's raw discount tax total. + raw_refundable_total: + type: object + description: The item's raw refundable total. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + - type: object + description: The item's items. + properties: + actions: + type: array + description: The item's actions. + items: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + allOf: + - type: object + description: The shipping method's shipping methods. + x-schemaName: OrderShippingMethod + required: + - id + - order_id + - name + - amount + - raw_amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: ./IBigNumber.yaml + raw_amount: + type: object + description: The shipping method's raw amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./OrderShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./OrderShippingMethodAdjustment.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: 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: ./IBigNumber.yaml + raw_original_total: + type: object + description: The shipping method's raw original total. + raw_original_subtotal: + type: object + description: The shipping method's raw original subtotal. + raw_original_tax_total: + type: object + description: The shipping method's raw original tax total. + raw_total: + type: object + description: The shipping method's raw total. + raw_subtotal: + type: object + description: The shipping method's raw subtotal. + raw_tax_total: + type: object + description: The shipping method's raw tax total. + raw_discount_total: + type: object + description: The shipping method's raw discount total. + raw_discount_tax_total: + type: object + description: The shipping method's raw discount tax total. + - type: object + description: The shipping method's shipping methods. + properties: + actions: + type: array + description: The shipping method's actions. + items: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + status: + type: string + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + shipping_address: + $ref: ./OrderAddress.yaml + billing_address: + $ref: ./OrderAddress.yaml + transactions: + type: array + description: The order preview's transactions. + items: + $ref: ./OrderTransaction.yaml + summary: + type: object + description: The order preview's summary. + required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total + properties: + total: + oneOf: + - type: string + title: total + description: The summary's total. + - type: number + title: total + description: The summary's total. + - type: string + title: total + description: The summary's total. + - type: object + description: The summary's total. + x-schemaName: IBigNumber + subtotal: + oneOf: + - type: string + title: subtotal + description: The summary's subtotal. + - type: number + title: subtotal + description: The summary's subtotal. + - type: string + title: subtotal + description: The summary's subtotal. + - type: object + description: The summary's subtotal. + x-schemaName: IBigNumber + total_tax: + oneOf: + - type: string + title: total_tax + description: The summary's total tax. + - type: number + title: total_tax + description: The summary's total tax. + - type: string + title: total_tax + description: The summary's total tax. + - type: object + description: The summary's total tax. + x-schemaName: IBigNumber + ordered_total: + oneOf: + - type: string + title: ordered_total + description: The summary's ordered total. + - type: number + title: ordered_total + description: The summary's ordered total. + - type: string + title: ordered_total + description: The summary's ordered total. + - type: object + description: The summary's ordered total. + x-schemaName: IBigNumber + fulfilled_total: + oneOf: + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: number + title: fulfilled_total + description: The summary's fulfilled total. + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: object + description: The summary's fulfilled total. + x-schemaName: IBigNumber + returned_total: + oneOf: + - type: string + title: returned_total + description: The summary's returned total. + - type: number + title: returned_total + description: The summary's returned total. + - type: string + title: returned_total + description: The summary's returned total. + - type: object + description: The summary's returned total. + x-schemaName: IBigNumber + return_request_total: + oneOf: + - type: string + title: return_request_total + description: The summary's return request total. + - type: number + title: return_request_total + description: The summary's return request total. + - type: string + title: return_request_total + description: The summary's return request total. + - type: object + description: The summary's return request total. + x-schemaName: IBigNumber + write_off_total: + oneOf: + - type: string + title: write_off_total + description: The summary's write off total. + - type: number + title: write_off_total + description: The summary's write off total. + - type: string + title: write_off_total + description: The summary's write off total. + - type: object + description: The summary's write off total. + x-schemaName: IBigNumber + projected_total: + oneOf: + - type: string + title: projected_total + description: The summary's projected total. + - type: number + title: projected_total + description: The summary's projected total. + - type: string + title: projected_total + description: The summary's projected total. + - type: object + description: The summary's projected total. + x-schemaName: IBigNumber + net_total: + oneOf: + - type: string + title: net_total + description: The summary's net total. + - type: number + title: net_total + description: The summary's net total. + - type: string + title: net_total + description: The summary's net total. + - type: object + description: The summary's net total. + x-schemaName: IBigNumber + net_subtotal: + oneOf: + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: number + title: net_subtotal + description: The summary's net subtotal. + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: object + description: The summary's net subtotal. + x-schemaName: IBigNumber + net_total_tax: + oneOf: + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: number + title: net_total_tax + description: The summary's net total tax. + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: object + description: The summary's net total tax. + x-schemaName: IBigNumber + balance: + oneOf: + - type: string + title: balance + description: The summary's balance. + - type: number + title: balance + description: The summary's balance. + - type: string + title: balance + description: The summary's balance. + - type: object + description: The summary's balance. + x-schemaName: IBigNumber + paid_total: + oneOf: + - type: string + title: paid_total + description: The summary's paid total. + - type: number + title: paid_total + description: The summary's paid total. + - type: string + title: paid_total + description: The summary's paid total. + - type: object + description: The summary's paid total. + x-schemaName: IBigNumber + refunded_total: + oneOf: + - type: string + title: refunded_total + description: The summary's refunded total. + - type: number + title: refunded_total + description: The summary's refunded total. + - type: string + title: refunded_total + description: The summary's refunded total. + - type: object + description: The summary's refunded total. + x-schemaName: IBigNumber + metadata: + type: object + description: The order preview's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The order preview's original item total. + - type: number + title: original_item_total + description: The order preview's original item total. + - type: string + title: original_item_total + description: The order preview's original item total. + - $ref: ./IBigNumber.yaml + original_item_subtotal: + oneOf: + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - $ref: ./IBigNumber.yaml + original_item_tax_total: + oneOf: + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - type: number + title: original_item_tax_total + description: The order preview's original item tax total. + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The order preview's item total. + - type: number + title: item_total + description: The order preview's item total. + - type: string + title: item_total + description: The order preview's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - type: number + title: item_subtotal + description: The order preview's item subtotal. + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The order preview's item tax total. + - type: number + title: item_tax_total + description: The order preview's item tax total. + - type: string + title: item_tax_total + description: The order preview's item tax total. + - $ref: ./IBigNumber.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The order preview's original total. + - type: number + title: original_total + description: The order preview's original total. + - type: string + title: original_total + description: The order preview's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - type: number + title: original_subtotal + description: The order preview's original subtotal. + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The order preview's original tax total. + - type: number + title: original_tax_total + description: The order preview's original tax total. + - type: string + title: original_tax_total + description: The order preview's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The order preview's total. + - type: number + title: total + description: The order preview's total. + - type: string + title: total + description: The order preview's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The order preview's subtotal. + - type: number + title: subtotal + description: The order preview's subtotal. + - type: string + title: subtotal + description: The order preview's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The order preview's tax total. + - type: number + title: tax_total + description: The order preview's tax total. + - type: string + title: tax_total + description: The order preview's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The order preview's discount total. + - type: number + title: discount_total + description: The order preview's discount total. + - type: string + title: discount_total + description: The order preview's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - type: number + title: discount_tax_total + description: The order preview's discount tax total. + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - $ref: ./IBigNumber.yaml + gift_card_total: + oneOf: + - type: string + title: gift_card_total + description: The order preview's gift card total. + - type: number + title: gift_card_total + description: The order preview's gift card total. + - type: string + title: gift_card_total + description: The order preview's gift card total. + - $ref: ./IBigNumber.yaml + gift_card_tax_total: + oneOf: + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - $ref: ./IBigNumber.yaml + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The order preview's shipping total. + - type: number + title: shipping_total + description: The order preview's shipping total. + - type: string + title: shipping_total + description: The order preview's shipping total. + - $ref: ./IBigNumber.yaml + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - $ref: ./IBigNumber.yaml + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - $ref: ./IBigNumber.yaml + original_shipping_total: + oneOf: + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - type: number + title: original_shipping_total + description: The order preview's original shipping total. + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - $ref: ./IBigNumber.yaml + original_shipping_subtotal: + oneOf: + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - $ref: ./IBigNumber.yaml + original_shipping_tax_total: + oneOf: + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - $ref: ./IBigNumber.yaml + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order preview's canceled at. + - type: string + title: canceled_at + description: The order preview's canceled at. + format: date-time + raw_original_item_total: + type: object + description: The order preview's raw original item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item total's value. + - type: number + title: value + description: The raw original item total's value. + raw_original_item_subtotal: + type: object + description: The order preview's raw original item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item subtotal's value. + - type: number + title: value + description: The raw original item subtotal's value. + raw_original_item_tax_total: + type: object + description: The order preview's raw original item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item tax total's value. + - type: number + title: value + description: The raw original item tax total's value. + raw_item_total: + type: object + description: The order preview's raw item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item total's value. + - type: number + title: value + description: The raw item total's value. + raw_item_subtotal: + type: object + description: The order preview's raw item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item subtotal's value. + - type: number + title: value + description: The raw item subtotal's value. + raw_item_tax_total: + type: object + description: The order preview's raw item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item tax total's value. + - type: number + title: value + description: The raw item tax total's value. + raw_original_total: + type: object + description: The order preview's raw original total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original total's value. + - type: number + title: value + description: The raw original total's value. + raw_original_subtotal: + type: object + description: The order preview's raw original subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original subtotal's value. + - type: number + title: value + description: The raw original subtotal's value. + raw_original_tax_total: + type: object + description: The order preview's raw original tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original tax total's value. + - type: number + title: value + description: The raw original tax total's value. + raw_total: + type: object + description: The order preview's raw total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw total's value. + - type: number + title: value + description: The raw total's value. + raw_subtotal: + type: object + description: The order preview's raw subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw subtotal's value. + - type: number + title: value + description: The raw subtotal's value. + raw_tax_total: + type: object + description: The order preview's raw tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw tax total's value. + - type: number + title: value + description: The raw tax total's value. + raw_discount_total: + type: object + description: The order preview's raw discount total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount total's value. + - type: number + title: value + description: The raw discount total's value. + raw_discount_tax_total: + type: object + description: The order preview's raw discount tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount tax total's value. + - type: number + title: value + description: The raw discount tax total's value. + raw_gift_card_total: + type: object + description: The order preview's raw gift card total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card total's value. + - type: number + title: value + description: The raw gift card total's value. + raw_gift_card_tax_total: + type: object + description: The order preview's raw gift card tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card tax total's value. + - type: number + title: value + description: The raw gift card tax total's value. + raw_shipping_total: + type: object + description: The order preview's raw shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping total's value. + - type: number + title: value + description: The raw shipping total's value. + raw_shipping_subtotal: + type: object + description: The order preview's raw shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping subtotal's value. + - type: number + title: value + description: The raw shipping subtotal's value. + raw_shipping_tax_total: + type: object + description: The order preview's raw shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping tax total's value. + - type: number + title: value + description: The raw shipping tax total's value. + raw_original_shipping_total: + type: object + description: The order preview's raw original shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping total's value. + - type: number + title: value + description: The raw original shipping total's value. + raw_original_shipping_subtotal: + type: object + description: The order preview's raw original shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping subtotal's value. + - type: number + title: value + description: The raw original shipping subtotal's value. + raw_original_shipping_tax_total: + type: object + description: The order preview's raw original shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping tax total's value. + - type: number + title: value + description: The raw original shipping tax total's value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml deleted file mode 100644 index 27f2932fb3..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml +++ /dev/null @@ -1,214 +0,0 @@ -type: object -description: The shipping method's shipping methods. -x-schemaName: OrderShippingMethod -required: - - id - - order_id - - name - - amount - - raw_amount - - is_tax_inclusive - - created_at - - updated_at - - original_total - - original_subtotal - - original_tax_total - - total - - subtotal - - tax_total - - discount_total - - discount_tax_total - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total -properties: - id: - type: string - title: id - description: The shipping method's ID. - order_id: - type: string - title: order_id - description: The shipping method's order id. - name: - type: string - title: name - description: The shipping method's name. - description: - type: string - title: description - description: The shipping method's description. - amount: - oneOf: - - type: string - title: amount - description: The shipping method's amount. - - type: number - title: amount - description: The shipping method's amount. - - type: string - title: amount - description: The shipping method's amount. - - $ref: ./IBigNumber.yaml - raw_amount: - type: object - description: The shipping method's raw amount. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The shipping method's is tax inclusive. - shipping_option_id: - type: string - title: shipping_option_id - description: The shipping method's shipping option id. - data: - type: object - description: The shipping method's data. - metadata: - type: object - description: The shipping method's metadata. - tax_lines: - type: array - description: The shipping method's tax lines. - items: - $ref: ./OrderShippingMethodTaxLine.yaml - adjustments: - type: array - description: The shipping method's adjustments. - items: - $ref: ./OrderShippingMethodAdjustment.yaml - created_at: - type: string - format: date-time - title: created_at - description: The shipping method's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The shipping method's updated at. - original_total: - oneOf: - - type: string - title: original_total - description: The shipping method's original total. - - type: number - title: original_total - description: The shipping method's original total. - - type: string - title: original_total - description: The shipping method's original total. - - $ref: ./IBigNumber.yaml - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The shipping method's original subtotal. - - type: number - title: original_subtotal - description: The shipping method's original subtotal. - - type: string - title: original_subtotal - description: The shipping method's original subtotal. - - $ref: ./IBigNumber.yaml - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The shipping method's original tax total. - - type: number - title: original_tax_total - description: The shipping method's original tax total. - - type: string - title: original_tax_total - description: The shipping method's original tax total. - - $ref: ./IBigNumber.yaml - total: - oneOf: - - type: string - title: total - description: The shipping method's total. - - type: number - title: total - description: The shipping method's total. - - type: string - title: total - description: The shipping method's total. - - $ref: ./IBigNumber.yaml - subtotal: - oneOf: - - type: string - title: subtotal - description: The shipping method's subtotal. - - type: number - title: subtotal - description: The shipping method's subtotal. - - type: string - title: subtotal - description: The shipping method's subtotal. - - $ref: ./IBigNumber.yaml - tax_total: - oneOf: - - type: string - title: tax_total - description: The shipping method's tax total. - - type: number - title: tax_total - description: The shipping method's tax total. - - type: string - title: tax_total - description: The shipping method's tax total. - - $ref: ./IBigNumber.yaml - discount_total: - oneOf: - - type: string - title: discount_total - description: The shipping method's discount total. - - type: number - title: discount_total - description: The shipping method's discount total. - - type: string - title: discount_total - description: The shipping method's discount total. - - $ref: ./IBigNumber.yaml - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The shipping method's discount tax total. - - type: number - title: 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: ./IBigNumber.yaml - raw_original_total: - type: object - description: The shipping method's raw original total. - raw_original_subtotal: - type: object - description: The shipping method's raw original subtotal. - raw_original_tax_total: - type: object - description: The shipping method's raw original tax total. - raw_total: - type: object - description: The shipping method's raw total. - raw_subtotal: - type: object - description: The shipping method's raw subtotal. - raw_tax_total: - type: object - description: The shipping method's raw tax total. - raw_discount_total: - type: object - description: The shipping method's raw discount total. - raw_discount_tax_total: - type: object - description: The shipping method's raw discount tax total. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index c8670d5663..1945be146d 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -64,6 +64,7 @@ tags: - name: Notifications x-associatedSchema: $ref: '#/components/schemas/AdminNotification' + - name: Order Edits - name: Orders x-associatedSchema: $ref: '#/components/schemas/AdminOrder' @@ -1689,18 +1690,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -6421,18 +6416,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -6530,18 +6519,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -6607,11 +6590,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /admin/exchanges/{id}/cancel: - post: - operationId: PostExchangesIdCancel - summary: Add Cancels to Exchange - description: Add a list of cancels to a exchange. + /admin/exchanges/{id}: + get: + operationId: GetExchangesId + summary: Get a Exchange + description: Retrieve a exchange by its ID. You can expand the exchange's relations or select the fields that should be returned. x-authenticated: true parameters: - name: id @@ -6670,6 +6653,90 @@ paths: - api_token: [] - cookie_auth: [] - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/exchanges/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminExchangeResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/exchanges/{id}/cancel: + post: + operationId: PostExchangesIdCancel + summary: Add Cancels to Exchange + description: Add a list of cancels to a exchange. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: @@ -6725,18 +6792,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -6827,18 +6888,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -6928,18 +6983,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7019,18 +7068,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7125,18 +7168,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7226,18 +7263,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7317,18 +7348,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7419,18 +7444,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7463,7 +7482,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostExhangesItemsActionReqSchema' + $ref: '#/components/schemas/AdminPostExchangesItemsActionReqSchema' x-codeSamples: - lang: Shell label: cURL @@ -7520,18 +7539,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7611,18 +7624,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7717,18 +7724,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7818,18 +7819,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7909,18 +7904,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7977,6 +7966,10 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: confirmExchangeRequestWorkflow + requestBody: + content: + application/json: + schema: {} delete: operationId: DeleteExchangesIdRequest summary: Remove Requests from Exchange @@ -7999,18 +7992,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -11721,6 +11708,894 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/order-edits: + post: + operationId: PostOrderEdits + summary: Create Order Edit + description: Create a order edit. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrderEditsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/order-edits' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "order_id": "{value}", + "metadata": {} + }' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/order-edits/{id}: + delete: + operationId: DeleteOrderEditsId + summary: Delete a Order Edit + description: Delete a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/order-edits/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The order edit's ID. + object: + type: string + title: object + description: The order edit's object. + deleted: + type: boolean + title: deleted + description: The order edit's deleted. + parent: + type: object + description: The order edit's parent. + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/order-edits/{id}/confirm: + post: + operationId: PostOrderEditsIdConfirm + summary: Add Confirms to Order Edit + description: Add a list of confirms to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/order-edits/{id}/confirm' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderEditPreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: confirmOrderEditRequestWorkflow + /admin/order-edits/{id}/items: + post: + operationId: PostOrderEditsIdItems + summary: Add Items to Order Edit + description: Add a list of items to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrderEditsAddItemsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/order-edits/{id}/items' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderEditPreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: orderEditAddNewItemWorkflow + /admin/order-edits/{id}/items/{action_id}: + post: + operationId: PostOrderEditsIdItemsAction_id + summary: Add Items to Order Edit + description: Add a list of items to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The order edit's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrderEditsItemsActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderEditPreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: updateOrderEditAddItemWorkflow + delete: + operationId: DeleteOrderEditsIdItemsAction_id + summary: Remove Items from Order Edit + description: Remove a list of items from a order edit. This doesn't delete the Item, only the association between the Item and the order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The order edit's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderEditPreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: removeItemOrderEditActionWorkflow + /admin/order-edits/{id}/shipping-method: + post: + operationId: PostOrderEditsIdShippingMethod + summary: Add Shipping Methods to Order Edit + description: Add a list of shipping methods to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrderEditsShippingReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "shipping_option_id": "{value}" + }' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderEditPreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: createOrderEditShippingMethodWorkflow + /admin/order-edits/{id}/shipping-method/{action_id}: + post: + operationId: PostOrderEditsIdShippingMethodAction_id + summary: Add Shipping Methods to Order Edit + description: Add a list of shipping methods to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The order edit's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrderEditsShippingActionReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderEditPreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: updateOrderEditShippingMethodWorkflow + delete: + operationId: DeleteOrderEditsIdShippingMethodAction_id + summary: Remove Shipping Methods from Order Edit + description: Remove a list of shipping methods from a order edit. This doesn't delete the Shipping Method, only the association between the Shipping Method and the order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The order edit's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderEditPreviewResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: removeOrderEditShippingMethodWorkflow /admin/orders: get: operationId: GetOrders @@ -16623,18 +17498,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -36616,18 +37485,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -36728,18 +37591,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -36842,18 +37699,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -36931,18 +37782,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -37041,18 +37886,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. required: false schema: type: string title: fields - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -48445,7 +49284,7 @@ components: - claim properties: order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimRequestResponse: @@ -48460,7 +49299,7 @@ components: return: $ref: '#/components/schemas/AdminReturn' order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimResponse: @@ -48481,7 +49320,7 @@ components: - return properties: order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' return: $ref: '#/components/schemas/AdminReturn' AdminCollection: @@ -50054,7 +50893,7 @@ components: - exchange properties: order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangeRequestResponse: @@ -50069,7 +50908,7 @@ components: return: $ref: '#/components/schemas/AdminReturn' order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangeResponse: @@ -50090,7 +50929,7 @@ components: - return properties: order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' return: $ref: '#/components/schemas/AdminReturn' AdminExportProductRequest: @@ -51070,6 +51909,15 @@ components: type: number title: original_shipping_tax_total description: The order's original shipping tax total. + AdminOrderEditPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderEditPreviewResponse + required: + - order_preview + properties: + order_preview: + $ref: '#/components/schemas/OrderPreview' AdminOrderPreview: type: object description: The return's order preview. @@ -52202,6 +53050,19 @@ components: metadata: type: object description: The item's metadata. + AdminPostExchangesItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. AdminPostExchangesRequestItemsReturnActionReqSchema: type: object description: SUMMARY @@ -52302,19 +53163,6 @@ components: metadata: type: object description: The exchange's metadata. - AdminPostExhangesItemsActionReqSchema: - type: object - description: SUMMARY - x-schemaName: AdminPostExhangesItemsActionReqSchema - properties: - quantity: - type: number - title: quantity - description: The exchange's quantity. - internal_note: - type: string - title: internal_note - description: The exchange's internal note. AdminPostOrderClaimsReqSchema: type: object description: SUMMARY @@ -52349,6 +53197,122 @@ components: metadata: type: object description: The claim's metadata. + AdminPostOrderEditsAddItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsAddItemsReqSchema + properties: + items: + type: array + description: The order edit's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + allow_backorder: + type: boolean + title: allow_backorder + description: The item's allow backorder. + metadata: + type: object + description: The item's metadata. + AdminPostOrderEditsItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The order edit's quantity. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + AdminPostOrderEditsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsReqSchema + required: + - order_id + - metadata + properties: + order_id: + type: string + title: order_id + description: The order edit's order id. + description: + type: string + title: description + description: The order edit's description. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. + AdminPostOrderEditsShippingActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsShippingActionReqSchema + properties: + custom_price: + type: number + title: custom_price + description: The order edit's custom price. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. + AdminPostOrderEditsShippingReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsShippingReqSchema + required: + - shipping_option_id + properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The order edit's shipping option id. + custom_price: + type: number + title: custom_price + description: The order edit's custom price. + description: + type: string + title: description + description: The order edit's description. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. AdminPostOrderExchangesReqSchema: type: object description: SUMMARY @@ -58881,13 +59845,259 @@ components: description: The inventory level's metadata. Order: type: object - description: The exchange's order preview. + description: The transaction's order. x-schemaName: Order + OrderAddress: + type: object + description: The order preview's billing address. + x-schemaName: OrderAddress + required: + - id + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The billing address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The billing address's updated at. + OrderChange: + type: object + description: The order preview's order change. + x-schemaName: OrderChange required: - id - version + - order_id + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The order change's order id. + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + type: object + return_order: + $ref: '#/components/schemas/Return' + exchange: + $ref: '#/components/schemas/OrderExchange' + claim: + $ref: '#/components/schemas/OrderClaim' + actions: + type: array + description: The order change's actions. + items: + $ref: '#/components/schemas/OrderChangeAction' + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. + OrderChangeAction: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + OrderClaim: + type: object + description: The order change's claim. + x-schemaName: OrderClaim + OrderExchange: + type: object + description: The order change's exchange. + x-schemaName: OrderExchange + OrderItem: + type: object + description: The item's detail. + x-schemaName: OrderItem + OrderLineItemAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: OrderLineItemAdjustment + OrderLineItemTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: OrderLineItemTaxLine + OrderPreview: + type: object + description: The exchange's order preview. + x-schemaName: OrderPreview + required: + - order_change - status - currency_code + - id + - version - original_item_total - original_item_subtotal - original_item_tax_total @@ -58933,16 +60143,611 @@ components: - raw_original_shipping_subtotal - raw_original_shipping_tax_total properties: - id: - type: string - title: id - description: The order preview's ID. - version: - type: number - title: version - description: The order preview's version. order_change: $ref: '#/components/schemas/OrderChange' + items: + type: array + description: The order preview's items. + items: + allOf: + - type: object + description: The item's items. + x-schemaName: OrderLineItem + required: + - id + - title + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - raw_unit_price + - quantity + - raw_quantity + - detail + - created_at + - updated_at + - 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 + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_refundable_total + - raw_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 item's thumbnail. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + raw_unit_price: + type: object + description: The item's raw unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/OrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/OrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/OrderItem' + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + refundable_total: + oneOf: + - type: string + title: refundable_total + description: The item's refundable total. + - type: number + title: refundable_total + description: The item's refundable total. + - type: string + title: refundable_total + description: The item's refundable total. + - $ref: '#/components/schemas/IBigNumber' + refundable_total_per_unit: + oneOf: + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - $ref: '#/components/schemas/IBigNumber' + raw_original_total: + type: object + description: The item's raw original total. + raw_original_subtotal: + type: object + description: The item's raw original subtotal. + raw_original_tax_total: + type: object + description: The item's raw original tax total. + raw_item_total: + type: object + description: The item's raw item total. + raw_item_subtotal: + type: object + description: The item's raw item subtotal. + raw_item_tax_total: + type: object + description: The item's raw item tax total. + raw_total: + type: object + description: The item's raw total. + raw_subtotal: + type: object + description: The item's raw subtotal. + raw_tax_total: + type: object + description: The item's raw tax total. + raw_discount_total: + type: object + description: The item's raw discount total. + raw_discount_tax_total: + type: object + description: The item's raw discount tax total. + raw_refundable_total: + type: object + description: The item's raw refundable total. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + - type: object + description: The item's items. + properties: + actions: + type: array + description: The item's actions. + items: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + allOf: + - type: object + description: The shipping method's shipping methods. + x-schemaName: OrderShippingMethod + required: + - id + - order_id + - name + - amount + - raw_amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: '#/components/schemas/IBigNumber' + raw_amount: + type: object + description: The shipping method's raw amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/OrderShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/OrderShippingMethodAdjustment' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: 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' + raw_original_total: + type: object + description: The shipping method's raw original total. + raw_original_subtotal: + type: object + description: The shipping method's raw original subtotal. + raw_original_tax_total: + type: object + description: The shipping method's raw original tax total. + raw_total: + type: object + description: The shipping method's raw total. + raw_subtotal: + type: object + description: The shipping method's raw subtotal. + raw_tax_total: + type: object + description: The shipping method's raw tax total. + raw_discount_total: + type: object + description: The shipping method's raw discount total. + raw_discount_tax_total: + type: object + description: The shipping method's raw discount tax total. + - type: object + description: The shipping method's shipping methods. + properties: + actions: + type: array + description: The shipping method's actions. + items: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction status: type: string enum: @@ -58952,6 +60757,18 @@ components: - completed - draft - archived + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. region_id: type: string title: region_id @@ -58969,24 +60786,10 @@ components: title: email description: The order preview's email. format: email - currency_code: - type: string - title: currency_code - description: The order preview's currency code. shipping_address: $ref: '#/components/schemas/OrderAddress' billing_address: $ref: '#/components/schemas/OrderAddress' - items: - type: array - description: The order preview's items. - items: - $ref: '#/components/schemas/OrderLineItem' - shipping_methods: - type: array - description: The order preview's shipping methods. - items: - $ref: '#/components/schemas/OrderShippingMethod' transactions: type: array description: The order preview's transactions. @@ -59225,15 +61028,6 @@ components: metadata: type: object description: The order preview's metadata. - canceled_at: - oneOf: - - type: string - title: canceled_at - description: The order preview's canceled at. - - type: string - title: canceled_at - description: The order preview's canceled at. - format: date-time created_at: type: string format: date-time @@ -59508,6 +61302,15 @@ components: title: original_shipping_tax_total description: The order preview's original shipping tax total. - $ref: '#/components/schemas/IBigNumber' + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order preview's canceled at. + - type: string + title: canceled_at + description: The order preview's canceled at. + format: date-time raw_original_item_total: type: object description: The order preview's raw original item total. @@ -59816,822 +61619,6 @@ components: - type: number title: value description: The raw original shipping tax total's value. - OrderAddress: - type: object - description: The order preview's billing address. - x-schemaName: OrderAddress - required: - - id - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The billing address's ID. - customer_id: - type: string - title: customer_id - description: The billing address's customer id. - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - phone: - type: string - title: phone - description: The billing address's phone. - company: - type: string - title: company - description: The billing address's company. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - metadata: - type: object - description: The billing address's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The billing address's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The billing address's updated at. - OrderChange: - type: object - description: The order preview's order change. - x-schemaName: OrderChange - required: - - id - - version - - order_id - - return_id - - exchange_id - - claim_id - - order - - return_order - - exchange - - claim - - actions - - status - - requested_by - - requested_at - - confirmed_by - - confirmed_at - - declined_by - - declined_reason - - metadata - - declined_at - - canceled_by - - canceled_at - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The order change's ID. - version: - type: number - title: version - description: The order change's version. - change_type: - type: string - enum: - - return - - exchange - - claim - - edit - order_id: - type: string - title: order_id - description: The order change's order id. - return_id: - type: string - title: return_id - description: The order change's return id. - exchange_id: - type: string - title: exchange_id - description: The order change's exchange id. - claim_id: - type: string - title: claim_id - description: The order change's claim id. - order: - type: object - return_order: - $ref: '#/components/schemas/Return' - exchange: - $ref: '#/components/schemas/OrderExchange' - claim: - $ref: '#/components/schemas/OrderClaim' - actions: - type: array - description: The order change's actions. - items: - $ref: '#/components/schemas/OrderChangeAction' - status: - type: string - title: status - description: The order change's status. - requested_by: - type: string - title: requested_by - description: The order change's requested by. - requested_at: - oneOf: - - type: string - title: requested_at - description: The order change's requested at. - - type: string - title: requested_at - description: The order change's requested at. - format: date-time - confirmed_by: - type: string - title: confirmed_by - description: The order change's confirmed by. - confirmed_at: - oneOf: - - type: string - title: confirmed_at - description: The order change's confirmed at. - - type: string - title: confirmed_at - description: The order change's confirmed at. - format: date-time - declined_by: - type: string - title: declined_by - description: The order change's declined by. - declined_reason: - type: string - title: declined_reason - description: The order change's declined reason. - metadata: - type: object - description: The order change's metadata. - declined_at: - oneOf: - - type: string - title: declined_at - description: The order change's declined at. - - type: string - title: declined_at - description: The order change's declined at. - format: date-time - canceled_by: - type: string - title: canceled_by - description: The order change's canceled by. - canceled_at: - oneOf: - - type: string - title: canceled_at - description: The order change's canceled at. - - type: string - title: canceled_at - description: The order change's canceled at. - format: date-time - created_at: - type: string - format: date-time - title: created_at - description: The order change's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The order change's updated at. - OrderChangeAction: - type: object - description: The action's actions. - x-schemaName: OrderChangeAction - OrderClaim: - type: object - description: The order change's claim. - x-schemaName: OrderClaim - OrderExchange: - type: object - description: The order change's exchange. - x-schemaName: OrderExchange - OrderItem: - type: object - description: The item's detail. - x-schemaName: OrderItem - OrderLineItem: - type: object - description: The item's items. - x-schemaName: OrderLineItem - required: - - id - - title - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - - raw_unit_price - - quantity - - raw_quantity - - detail - - created_at - - updated_at - - 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 - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_item_total - - raw_item_subtotal - - raw_item_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - - raw_refundable_total - - raw_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 item's thumbnail. - variant_id: - type: string - title: variant_id - description: The item's variant id. - product_id: - type: string - title: product_id - description: The item's product id. - product_title: - type: string - title: product_title - description: The item's product title. - product_description: - type: string - title: product_description - description: The item's product description. - product_subtitle: - type: string - title: product_subtitle - description: The item's product subtitle. - product_type: - type: string - title: product_type - description: The item's product type. - product_collection: - type: string - title: product_collection - description: The item's product collection. - product_handle: - type: string - title: product_handle - description: The item's product handle. - variant_sku: - type: string - title: variant_sku - description: The item's variant sku. - variant_barcode: - type: string - title: variant_barcode - description: The item's variant barcode. - variant_title: - type: string - title: variant_title - description: The item's variant title. - variant_option_values: - type: object - description: The item's variant option values. - requires_shipping: - type: boolean - title: requires_shipping - description: The item's requires shipping. - is_discountable: - type: boolean - title: is_discountable - description: The item's is discountable. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The item's is tax inclusive. - compare_at_unit_price: - type: number - title: compare_at_unit_price - description: The item's compare at unit price. - raw_compare_at_unit_price: - type: object - description: The item's raw compare at unit price. - unit_price: - type: number - title: unit_price - description: The item's unit price. - raw_unit_price: - type: object - description: The item's raw unit price. - quantity: - type: number - title: quantity - description: The item's quantity. - raw_quantity: - type: object - description: The item's raw quantity. - tax_lines: - type: array - description: The item's tax lines. - items: - $ref: '#/components/schemas/OrderLineItemTaxLine' - adjustments: - type: array - description: The item's adjustments. - items: - $ref: '#/components/schemas/OrderLineItemAdjustment' - detail: - $ref: '#/components/schemas/OrderItem' - created_at: - type: string - title: created_at - description: The item's created at. - format: date-time - updated_at: - type: string - title: updated_at - description: The item's updated at. - format: date-time - metadata: - type: object - description: The item's metadata. - original_total: - oneOf: - - type: string - title: original_total - description: The item's original total. - - type: number - title: original_total - description: The item's original total. - - type: string - title: original_total - description: The item's original total. - - $ref: '#/components/schemas/IBigNumber' - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The item's original subtotal. - - type: number - title: original_subtotal - description: The item's original subtotal. - - type: string - title: original_subtotal - description: The item's original subtotal. - - $ref: '#/components/schemas/IBigNumber' - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The item's original tax total. - - type: number - title: original_tax_total - description: The item's original tax total. - - type: string - title: original_tax_total - description: The item's original tax total. - - $ref: '#/components/schemas/IBigNumber' - item_total: - oneOf: - - type: string - title: item_total - description: The item's item total. - - type: number - title: item_total - description: The item's item total. - - type: string - title: item_total - description: The item's item total. - - $ref: '#/components/schemas/IBigNumber' - item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The item's item subtotal. - - type: number - title: item_subtotal - description: The item's item subtotal. - - type: string - title: item_subtotal - description: The item's item subtotal. - - $ref: '#/components/schemas/IBigNumber' - item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The item's item tax total. - - type: number - title: item_tax_total - description: The item's item tax total. - - type: string - title: item_tax_total - description: The item's item tax total. - - $ref: '#/components/schemas/IBigNumber' - total: - oneOf: - - type: string - title: total - description: The item's total. - - type: number - title: total - description: The item's total. - - type: string - title: total - description: The item's total. - - $ref: '#/components/schemas/IBigNumber' - subtotal: - oneOf: - - type: string - title: subtotal - description: The item's subtotal. - - type: number - title: subtotal - description: The item's subtotal. - - type: string - title: subtotal - description: The item's subtotal. - - $ref: '#/components/schemas/IBigNumber' - tax_total: - oneOf: - - type: string - title: tax_total - description: The item's tax total. - - type: number - title: tax_total - description: The item's tax total. - - type: string - title: tax_total - description: The item's tax total. - - $ref: '#/components/schemas/IBigNumber' - discount_total: - oneOf: - - type: string - title: discount_total - description: The item's discount total. - - type: number - title: discount_total - description: The item's discount total. - - type: string - title: discount_total - description: The item's discount total. - - $ref: '#/components/schemas/IBigNumber' - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The item's discount tax total. - - type: number - title: discount_tax_total - description: The item's discount tax total. - - type: string - title: discount_tax_total - description: The item's discount tax total. - - $ref: '#/components/schemas/IBigNumber' - refundable_total: - oneOf: - - type: string - title: refundable_total - description: The item's refundable total. - - type: number - title: refundable_total - description: The item's refundable total. - - type: string - title: refundable_total - description: The item's refundable total. - - $ref: '#/components/schemas/IBigNumber' - refundable_total_per_unit: - oneOf: - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: number - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - $ref: '#/components/schemas/IBigNumber' - raw_original_total: - type: object - description: The item's raw original total. - raw_original_subtotal: - type: object - description: The item's raw original subtotal. - raw_original_tax_total: - type: object - description: The item's raw original tax total. - raw_item_total: - type: object - description: The item's raw item total. - raw_item_subtotal: - type: object - description: The item's raw item subtotal. - raw_item_tax_total: - type: object - description: The item's raw item tax total. - raw_total: - type: object - description: The item's raw total. - raw_subtotal: - type: object - description: The item's raw subtotal. - raw_tax_total: - type: object - description: The item's raw tax total. - raw_discount_total: - type: object - description: The item's raw discount total. - raw_discount_tax_total: - type: object - description: The item's raw discount tax total. - raw_refundable_total: - type: object - description: The item's raw refundable total. - raw_refundable_total_per_unit: - type: object - description: The item's raw refundable total per unit. - OrderLineItemAdjustment: - type: object - description: The adjustment's adjustments. - x-schemaName: OrderLineItemAdjustment - OrderLineItemTaxLine: - type: object - description: The tax line's tax lines. - x-schemaName: OrderLineItemTaxLine - OrderShippingMethod: - type: object - description: The shipping method's shipping methods. - x-schemaName: OrderShippingMethod - required: - - id - - order_id - - name - - amount - - raw_amount - - is_tax_inclusive - - created_at - - updated_at - - original_total - - original_subtotal - - original_tax_total - - total - - subtotal - - tax_total - - discount_total - - discount_tax_total - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - properties: - id: - type: string - title: id - description: The shipping method's ID. - order_id: - type: string - title: order_id - description: The shipping method's order id. - name: - type: string - title: name - description: The shipping method's name. - description: - type: string - title: description - description: The shipping method's description. - amount: - oneOf: - - type: string - title: amount - description: The shipping method's amount. - - type: number - title: amount - description: The shipping method's amount. - - type: string - title: amount - description: The shipping method's amount. - - $ref: '#/components/schemas/IBigNumber' - raw_amount: - type: object - description: The shipping method's raw amount. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The shipping method's is tax inclusive. - shipping_option_id: - type: string - title: shipping_option_id - description: The shipping method's shipping option id. - data: - type: object - description: The shipping method's data. - metadata: - type: object - description: The shipping method's metadata. - tax_lines: - type: array - description: The shipping method's tax lines. - items: - $ref: '#/components/schemas/OrderShippingMethodTaxLine' - adjustments: - type: array - description: The shipping method's adjustments. - items: - $ref: '#/components/schemas/OrderShippingMethodAdjustment' - created_at: - type: string - format: date-time - title: created_at - description: The shipping method's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The shipping method's updated at. - original_total: - oneOf: - - type: string - title: original_total - description: The shipping method's original total. - - type: number - title: original_total - description: The shipping method's original total. - - type: string - title: original_total - description: The shipping method's original total. - - $ref: '#/components/schemas/IBigNumber' - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The shipping method's original subtotal. - - type: number - title: original_subtotal - description: The shipping method's original subtotal. - - type: string - title: original_subtotal - description: The shipping method's original subtotal. - - $ref: '#/components/schemas/IBigNumber' - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The shipping method's original tax total. - - type: number - title: original_tax_total - description: The shipping method's original tax total. - - type: string - title: original_tax_total - description: The shipping method's original tax total. - - $ref: '#/components/schemas/IBigNumber' - total: - oneOf: - - type: string - title: total - description: The shipping method's total. - - type: number - title: total - description: The shipping method's total. - - type: string - title: total - description: The shipping method's total. - - $ref: '#/components/schemas/IBigNumber' - subtotal: - oneOf: - - type: string - title: subtotal - description: The shipping method's subtotal. - - type: number - title: subtotal - description: The shipping method's subtotal. - - type: string - title: subtotal - description: The shipping method's subtotal. - - $ref: '#/components/schemas/IBigNumber' - tax_total: - oneOf: - - type: string - title: tax_total - description: The shipping method's tax total. - - type: number - title: tax_total - description: The shipping method's tax total. - - type: string - title: tax_total - description: The shipping method's tax total. - - $ref: '#/components/schemas/IBigNumber' - discount_total: - oneOf: - - type: string - title: discount_total - description: The shipping method's discount total. - - type: number - title: discount_total - description: The shipping method's discount total. - - type: string - title: discount_total - description: The shipping method's discount total. - - $ref: '#/components/schemas/IBigNumber' - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The shipping method's discount tax total. - - type: number - title: 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' - raw_original_total: - type: object - description: The shipping method's raw original total. - raw_original_subtotal: - type: object - description: The shipping method's raw original subtotal. - raw_original_tax_total: - type: object - description: The shipping method's raw original tax total. - raw_total: - type: object - description: The shipping method's raw total. - raw_subtotal: - type: object - description: The shipping method's raw subtotal. - raw_tax_total: - type: object - description: The shipping method's raw tax total. - raw_discount_total: - type: object - description: The shipping method's raw discount total. - raw_discount_tax_total: - type: object - description: The shipping method's raw discount tax total. OrderShippingMethodAdjustment: type: object description: The adjustment's adjustments. diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 74b8f2a25f..b903a762a6 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -70,6 +70,7 @@ tags: - name: Notifications x-associatedSchema: $ref: ./components/schemas/AdminNotification.yaml + - name: Order Edits - name: Orders x-associatedSchema: $ref: ./components/schemas/AdminOrder.yaml @@ -227,6 +228,8 @@ paths: $ref: paths/admin_draft-orders_{id}.yaml /admin/exchanges: $ref: paths/admin_exchanges.yaml + /admin/exchanges/{id}: + $ref: paths/admin_exchanges_{id}.yaml /admin/exchanges/{id}/cancel: $ref: paths/admin_exchanges_{id}_cancel.yaml /admin/exchanges/{id}/inbound/items: @@ -283,6 +286,20 @@ paths: $ref: paths/admin_notifications.yaml /admin/notifications/{id}: $ref: paths/admin_notifications_{id}.yaml + /admin/order-edits: + $ref: paths/admin_order-edits.yaml + /admin/order-edits/{id}: + $ref: paths/admin_order-edits_{id}.yaml + /admin/order-edits/{id}/confirm: + $ref: paths/admin_order-edits_{id}_confirm.yaml + /admin/order-edits/{id}/items: + $ref: paths/admin_order-edits_{id}_items.yaml + /admin/order-edits/{id}/items/{action_id}: + $ref: paths/admin_order-edits_{id}_items_{action_id}.yaml + /admin/order-edits/{id}/shipping-method: + $ref: paths/admin_order-edits_{id}_shipping-method.yaml + /admin/order-edits/{id}/shipping-method/{action_id}: + $ref: paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml /admin/orders: $ref: paths/admin_orders.yaml /admin/orders/{id}: diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml index d408c71f48..fd266eb262 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml @@ -24,18 +24,20 @@ get: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml index d024dea878..4e15e34b57 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -18,18 +18,20 @@ get: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -133,18 +135,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml new file mode 100644 index 0000000000..668a926867 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml @@ -0,0 +1,97 @@ +get: + operationId: GetExchangesId + summary: Get a Exchange + description: >- + Retrieve a exchange by its ID. You can expand the exchange's relations or + select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The exchange's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_exchanges_{id}/get.sh + tags: + - Exchanges + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminExchangeResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml index e8f0e137be..df2fa0100f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml index 7cc4270e23..c1fb34c251 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml index 841e4e02fa..6ef2e5db70 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml @@ -28,18 +28,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -139,18 +141,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml index bf0226b477..6a18a6232d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml index 348842fc37..f2e97d6554 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml @@ -28,18 +28,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -139,18 +141,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml index cc678e09a3..f100836304 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml index 402a85aca8..f2bbd76f9d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml @@ -28,18 +28,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -77,7 +79,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostExhangesItemsActionReqSchema.yaml + $ref: ../components/schemas/AdminPostExchangesItemsActionReqSchema.yaml x-codeSamples: - lang: Shell label: cURL @@ -138,18 +140,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml index 4c766b4354..e3fd392399 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml index 50e2659e7a..c552a88893 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml @@ -28,18 +28,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -139,18 +141,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml index 0779ce0897..d7fa0e3737 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml @@ -22,18 +22,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -94,6 +96,10 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: confirmExchangeRequestWorkflow + requestBody: + content: + application/json: + schema: {} delete: operationId: DeleteExchangesIdRequest summary: Remove Requests from Exchange @@ -120,18 +126,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml new file mode 100644 index 0000000000..3e83453347 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml @@ -0,0 +1,94 @@ +post: + operationId: PostOrderEdits + summary: Create Order Edit + description: Create a order edit. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostOrderEditsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_order-edits/post.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml new file mode 100644 index 0000000000..3be8eb02ad --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml @@ -0,0 +1,116 @@ +delete: + operationId: DeleteOrderEditsId + summary: Delete a Order Edit + description: Delete a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_order-edits_{id}/delete.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The order edit's ID. + object: + type: string + title: object + description: The order edit's object. + deleted: + type: boolean + title: deleted + description: The order edit's deleted. + parent: + type: object + description: The order edit's parent. + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml new file mode 100644 index 0000000000..7f21a0ebff --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostOrderEditsIdConfirm + summary: Add Confirms to Order Edit + description: Add a list of confirms to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_order-edits_{id}_confirm/post.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderEditPreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: confirmOrderEditRequestWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml new file mode 100644 index 0000000000..0eec4f5d0e --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml @@ -0,0 +1,101 @@ +post: + operationId: PostOrderEditsIdItems + summary: Add Items to Order Edit + description: Add a list of items to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_order-edits_{id}_items/post.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderEditPreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: orderEditAddNewItemWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml new file mode 100644 index 0000000000..389191c60e --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml @@ -0,0 +1,212 @@ +post: + operationId: PostOrderEditsIdItemsAction_id + summary: Add Items to Order Edit + description: Add a list of items to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The order edit's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_order-edits_{id}_items_{action_id}/post.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderEditPreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: updateOrderEditAddItemWorkflow +delete: + operationId: DeleteOrderEditsIdItemsAction_id + summary: Remove Items from Order Edit + description: >- + Remove a list of items from a order edit. This doesn't delete the Item, only + the association between the Item and the order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The order edit's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_order-edits_{id}_items_{action_id}/delete.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderEditPreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: removeItemOrderEditActionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml new file mode 100644 index 0000000000..f53160451e --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml @@ -0,0 +1,101 @@ +post: + operationId: PostOrderEditsIdShippingMethod + summary: Add Shipping Methods to Order Edit + description: Add a list of shipping methods to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostOrderEditsShippingReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_order-edits_{id}_shipping-method/post.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderEditPreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: createOrderEditShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml new file mode 100644 index 0000000000..1be0ad0665 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml @@ -0,0 +1,215 @@ +post: + operationId: PostOrderEditsIdShippingMethodAction_id + summary: Add Shipping Methods to Order Edit + description: Add a list of shipping methods to a order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The order edit's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/post.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderEditPreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: updateOrderEditShippingMethodWorkflow +delete: + operationId: DeleteOrderEditsIdShippingMethodAction_id + summary: Remove Shipping Methods from Order Edit + description: >- + Remove a list of shipping methods from a order edit. This doesn't delete the + Shipping Method, only the association between the Shipping Method and the + order edit. + x-authenticated: true + parameters: + - name: id + in: path + description: The order edit's ID. + required: true + schema: + type: string + - name: action_id + in: path + description: The order edit's action id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_order-edits_{id}_shipping-method_{action_id}/delete.sh + tags: + - Order Edits + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderEditPreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: removeOrderEditShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml index a5da729301..14aa800995 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml @@ -18,18 +18,20 @@ get: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml index 093cfc1f8b..51b28e725f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml @@ -18,18 +18,20 @@ get: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -136,18 +138,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml index 69c1258af8..f5b922afda 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml @@ -24,18 +24,20 @@ get: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -119,18 +121,20 @@ post: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -231,18 +235,20 @@ delete: data. - name: fields in: query - description: |- - Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. required: false schema: type: string title: fields - description: |- + description: >- Comma-separated fields that should be included in the returned data. - * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * without prefix it will replace the entire default fields. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml index f463a9ee83..477ff17bd7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml @@ -6,6 +6,6 @@ required: - claim properties: order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml claim: $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml index 74bbc37b56..3b7c3d283c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml @@ -9,6 +9,6 @@ properties: return: $ref: ./AdminReturn.yaml order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml claim: $ref: ./AdminClaim.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml index ff9659b347..296a46bca0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml @@ -6,6 +6,6 @@ required: - return properties: order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml return: $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml index 6776dd01d0..4178d2079e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml @@ -6,6 +6,6 @@ required: - exchange properties: order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml exchange: $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml index 400aec0e26..16b834277c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml @@ -9,6 +9,6 @@ properties: return: $ref: ./AdminReturn.yaml order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml exchange: $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml index f0db225699..d357aa7c5f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml @@ -6,6 +6,6 @@ required: - return properties: order_preview: - $ref: ./Order.yaml + $ref: ./OrderPreview.yaml return: $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditPreviewResponse.yaml new file mode 100644 index 0000000000..09feaf500f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditPreviewResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderEditPreviewResponse +required: + - order_preview +properties: + order_preview: + $ref: ./OrderPreview.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml similarity index 82% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml index d058255237..e48200586c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExhangesItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesItemsActionReqSchema.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: AdminPostExhangesItemsActionReqSchema +x-schemaName: AdminPostExchangesItemsActionReqSchema properties: quantity: type: number diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml new file mode 100644 index 0000000000..e1298622f0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsAddItemsReqSchema +properties: + items: + type: array + description: The order edit's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + allow_backorder: + type: boolean + title: allow_backorder + description: The item's allow backorder. + metadata: + type: object + description: The item's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml new file mode 100644 index 0000000000..b366dab18e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -0,0 +1,12 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsItemsActionReqSchema +properties: + quantity: + type: number + title: quantity + description: The order edit's quantity. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml new file mode 100644 index 0000000000..592ffc30b3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml @@ -0,0 +1,22 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsReqSchema +required: + - order_id + - metadata +properties: + order_id: + type: string + title: order_id + description: The order edit's order id. + description: + type: string + title: description + description: The order edit's description. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml new file mode 100644 index 0000000000..ce424d8297 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsShippingActionReqSchema +properties: + custom_price: + type: number + title: custom_price + description: The order edit's custom price. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml new file mode 100644 index 0000000000..91e223dc84 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml @@ -0,0 +1,25 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostOrderEditsShippingReqSchema +required: + - shipping_option_id +properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The order edit's shipping option id. + custom_price: + type: number + title: custom_price + description: The order edit's custom price. + description: + type: string + title: description + description: The order edit's description. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml index f138b6e974..8c90e11018 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -1,936 +1,3 @@ type: object -description: The exchange's order preview. +description: The transaction's order. x-schemaName: Order -required: - - id - - version - - status - - currency_code - - 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 - - raw_original_item_total - - raw_original_item_subtotal - - raw_original_item_tax_total - - raw_item_total - - raw_item_subtotal - - raw_item_tax_total - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - - raw_gift_card_total - - raw_gift_card_tax_total - - raw_shipping_total - - raw_shipping_subtotal - - raw_shipping_tax_total - - raw_original_shipping_total - - raw_original_shipping_subtotal - - raw_original_shipping_tax_total -properties: - id: - type: string - title: id - description: The order preview's ID. - version: - type: number - title: version - description: The order preview's version. - order_change: - $ref: ./OrderChange.yaml - status: - type: string - enum: - - canceled - - requires_action - - pending - - completed - - draft - - archived - region_id: - type: string - title: region_id - description: The order preview's region id. - customer_id: - type: string - title: customer_id - description: The order preview's customer id. - sales_channel_id: - type: string - title: sales_channel_id - description: The order preview's sales channel id. - email: - type: string - title: email - description: The order preview's email. - format: email - currency_code: - type: string - title: currency_code - description: The order preview's currency code. - shipping_address: - $ref: ./OrderAddress.yaml - billing_address: - $ref: ./OrderAddress.yaml - items: - type: array - description: The order preview's items. - items: - $ref: ./OrderLineItem.yaml - shipping_methods: - type: array - description: The order preview's shipping methods. - items: - $ref: ./OrderShippingMethod.yaml - transactions: - type: array - description: The order preview's transactions. - items: - $ref: ./OrderTransaction.yaml - summary: - type: object - description: The order preview's summary. - required: - - total - - subtotal - - total_tax - - ordered_total - - fulfilled_total - - returned_total - - return_request_total - - write_off_total - - projected_total - - net_total - - net_subtotal - - net_total_tax - - balance - - paid_total - - refunded_total - properties: - total: - oneOf: - - type: string - title: total - description: The summary's total. - - type: number - title: total - description: The summary's total. - - type: string - title: total - description: The summary's total. - - type: object - description: The summary's total. - x-schemaName: IBigNumber - subtotal: - oneOf: - - type: string - title: subtotal - description: The summary's subtotal. - - type: number - title: subtotal - description: The summary's subtotal. - - type: string - title: subtotal - description: The summary's subtotal. - - type: object - description: The summary's subtotal. - x-schemaName: IBigNumber - total_tax: - oneOf: - - type: string - title: total_tax - description: The summary's total tax. - - type: number - title: total_tax - description: The summary's total tax. - - type: string - title: total_tax - description: The summary's total tax. - - type: object - description: The summary's total tax. - x-schemaName: IBigNumber - ordered_total: - oneOf: - - type: string - title: ordered_total - description: The summary's ordered total. - - type: number - title: ordered_total - description: The summary's ordered total. - - type: string - title: ordered_total - description: The summary's ordered total. - - type: object - description: The summary's ordered total. - x-schemaName: IBigNumber - fulfilled_total: - oneOf: - - type: string - title: fulfilled_total - description: The summary's fulfilled total. - - type: number - title: fulfilled_total - description: The summary's fulfilled total. - - type: string - title: fulfilled_total - description: The summary's fulfilled total. - - type: object - description: The summary's fulfilled total. - x-schemaName: IBigNumber - returned_total: - oneOf: - - type: string - title: returned_total - description: The summary's returned total. - - type: number - title: returned_total - description: The summary's returned total. - - type: string - title: returned_total - description: The summary's returned total. - - type: object - description: The summary's returned total. - x-schemaName: IBigNumber - return_request_total: - oneOf: - - type: string - title: return_request_total - description: The summary's return request total. - - type: number - title: return_request_total - description: The summary's return request total. - - type: string - title: return_request_total - description: The summary's return request total. - - type: object - description: The summary's return request total. - x-schemaName: IBigNumber - write_off_total: - oneOf: - - type: string - title: write_off_total - description: The summary's write off total. - - type: number - title: write_off_total - description: The summary's write off total. - - type: string - title: write_off_total - description: The summary's write off total. - - type: object - description: The summary's write off total. - x-schemaName: IBigNumber - projected_total: - oneOf: - - type: string - title: projected_total - description: The summary's projected total. - - type: number - title: projected_total - description: The summary's projected total. - - type: string - title: projected_total - description: The summary's projected total. - - type: object - description: The summary's projected total. - x-schemaName: IBigNumber - net_total: - oneOf: - - type: string - title: net_total - description: The summary's net total. - - type: number - title: net_total - description: The summary's net total. - - type: string - title: net_total - description: The summary's net total. - - type: object - description: The summary's net total. - x-schemaName: IBigNumber - net_subtotal: - oneOf: - - type: string - title: net_subtotal - description: The summary's net subtotal. - - type: number - title: net_subtotal - description: The summary's net subtotal. - - type: string - title: net_subtotal - description: The summary's net subtotal. - - type: object - description: The summary's net subtotal. - x-schemaName: IBigNumber - net_total_tax: - oneOf: - - type: string - title: net_total_tax - description: The summary's net total tax. - - type: number - title: net_total_tax - description: The summary's net total tax. - - type: string - title: net_total_tax - description: The summary's net total tax. - - type: object - description: The summary's net total tax. - x-schemaName: IBigNumber - balance: - oneOf: - - type: string - title: balance - description: The summary's balance. - - type: number - title: balance - description: The summary's balance. - - type: string - title: balance - description: The summary's balance. - - type: object - description: The summary's balance. - x-schemaName: IBigNumber - paid_total: - oneOf: - - type: string - title: paid_total - description: The summary's paid total. - - type: number - title: paid_total - description: The summary's paid total. - - type: string - title: paid_total - description: The summary's paid total. - - type: object - description: The summary's paid total. - x-schemaName: IBigNumber - refunded_total: - oneOf: - - type: string - title: refunded_total - description: The summary's refunded total. - - type: number - title: refunded_total - description: The summary's refunded total. - - type: string - title: refunded_total - description: The summary's refunded total. - - type: object - description: The summary's refunded total. - x-schemaName: IBigNumber - metadata: - type: object - description: The order preview's metadata. - canceled_at: - oneOf: - - type: string - title: canceled_at - description: The order preview's canceled at. - - type: string - title: canceled_at - description: The order preview's canceled at. - format: date-time - created_at: - type: string - format: date-time - title: created_at - description: The order preview's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The order preview's updated at. - original_item_total: - oneOf: - - type: string - title: original_item_total - description: The order preview's original item total. - - type: number - title: original_item_total - description: The order preview's original item total. - - type: string - title: original_item_total - description: The order preview's original item total. - - $ref: ./IBigNumber.yaml - original_item_subtotal: - oneOf: - - type: string - title: original_item_subtotal - description: The order preview's original item subtotal. - - type: number - title: original_item_subtotal - description: The order preview's original item subtotal. - - type: string - title: original_item_subtotal - description: The order preview's original item subtotal. - - $ref: ./IBigNumber.yaml - original_item_tax_total: - oneOf: - - type: string - title: original_item_tax_total - description: The order preview's original item tax total. - - type: number - title: original_item_tax_total - description: The order preview's original item tax total. - - type: string - title: original_item_tax_total - description: The order preview's original item tax total. - - $ref: ./IBigNumber.yaml - item_total: - oneOf: - - type: string - title: item_total - description: The order preview's item total. - - type: number - title: item_total - description: The order preview's item total. - - type: string - title: item_total - description: The order preview's item total. - - $ref: ./IBigNumber.yaml - item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The order preview's item subtotal. - - type: number - title: item_subtotal - description: The order preview's item subtotal. - - type: string - title: item_subtotal - description: The order preview's item subtotal. - - $ref: ./IBigNumber.yaml - item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The order preview's item tax total. - - type: number - title: item_tax_total - description: The order preview's item tax total. - - type: string - title: item_tax_total - description: The order preview's item tax total. - - $ref: ./IBigNumber.yaml - original_total: - oneOf: - - type: string - title: original_total - description: The order preview's original total. - - type: number - title: original_total - description: The order preview's original total. - - type: string - title: original_total - description: The order preview's original total. - - $ref: ./IBigNumber.yaml - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The order preview's original subtotal. - - type: number - title: original_subtotal - description: The order preview's original subtotal. - - type: string - title: original_subtotal - description: The order preview's original subtotal. - - $ref: ./IBigNumber.yaml - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The order preview's original tax total. - - type: number - title: original_tax_total - description: The order preview's original tax total. - - type: string - title: original_tax_total - description: The order preview's original tax total. - - $ref: ./IBigNumber.yaml - total: - oneOf: - - type: string - title: total - description: The order preview's total. - - type: number - title: total - description: The order preview's total. - - type: string - title: total - description: The order preview's total. - - $ref: ./IBigNumber.yaml - subtotal: - oneOf: - - type: string - title: subtotal - description: The order preview's subtotal. - - type: number - title: subtotal - description: The order preview's subtotal. - - type: string - title: subtotal - description: The order preview's subtotal. - - $ref: ./IBigNumber.yaml - tax_total: - oneOf: - - type: string - title: tax_total - description: The order preview's tax total. - - type: number - title: tax_total - description: The order preview's tax total. - - type: string - title: tax_total - description: The order preview's tax total. - - $ref: ./IBigNumber.yaml - discount_total: - oneOf: - - type: string - title: discount_total - description: The order preview's discount total. - - type: number - title: discount_total - description: The order preview's discount total. - - type: string - title: discount_total - description: The order preview's discount total. - - $ref: ./IBigNumber.yaml - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The order preview's discount tax total. - - type: number - title: discount_tax_total - description: The order preview's discount tax total. - - type: string - title: discount_tax_total - description: The order preview's discount tax total. - - $ref: ./IBigNumber.yaml - gift_card_total: - oneOf: - - type: string - title: gift_card_total - description: The order preview's gift card total. - - type: number - title: gift_card_total - description: The order preview's gift card total. - - type: string - title: gift_card_total - description: The order preview's gift card total. - - $ref: ./IBigNumber.yaml - gift_card_tax_total: - oneOf: - - type: string - title: gift_card_tax_total - description: The order preview's gift card tax total. - - type: number - title: gift_card_tax_total - description: The order preview's gift card tax total. - - type: string - title: gift_card_tax_total - description: The order preview's gift card tax total. - - $ref: ./IBigNumber.yaml - shipping_total: - oneOf: - - type: string - title: shipping_total - description: The order preview's shipping total. - - type: number - title: shipping_total - description: The order preview's shipping total. - - type: string - title: shipping_total - description: The order preview's shipping total. - - $ref: ./IBigNumber.yaml - shipping_subtotal: - oneOf: - - type: string - title: shipping_subtotal - description: The order preview's shipping subtotal. - - type: number - title: shipping_subtotal - description: The order preview's shipping subtotal. - - type: string - title: shipping_subtotal - description: The order preview's shipping subtotal. - - $ref: ./IBigNumber.yaml - shipping_tax_total: - oneOf: - - type: string - title: shipping_tax_total - description: The order preview's shipping tax total. - - type: number - title: shipping_tax_total - description: The order preview's shipping tax total. - - type: string - title: shipping_tax_total - description: The order preview's shipping tax total. - - $ref: ./IBigNumber.yaml - original_shipping_total: - oneOf: - - type: string - title: original_shipping_total - description: The order preview's original shipping total. - - type: number - title: original_shipping_total - description: The order preview's original shipping total. - - type: string - title: original_shipping_total - description: The order preview's original shipping total. - - $ref: ./IBigNumber.yaml - original_shipping_subtotal: - oneOf: - - type: string - title: original_shipping_subtotal - description: The order preview's original shipping subtotal. - - type: number - title: original_shipping_subtotal - description: The order preview's original shipping subtotal. - - type: string - title: original_shipping_subtotal - description: The order preview's original shipping subtotal. - - $ref: ./IBigNumber.yaml - original_shipping_tax_total: - oneOf: - - type: string - title: original_shipping_tax_total - description: The order preview's original shipping tax total. - - type: number - title: original_shipping_tax_total - description: The order preview's original shipping tax total. - - type: string - title: original_shipping_tax_total - description: The order preview's original shipping tax total. - - $ref: ./IBigNumber.yaml - raw_original_item_total: - type: object - description: The order preview's raw original item total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original item total's value. - - type: number - title: value - description: The raw original item total's value. - raw_original_item_subtotal: - type: object - description: The order preview's raw original item subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original item subtotal's value. - - type: number - title: value - description: The raw original item subtotal's value. - raw_original_item_tax_total: - type: object - description: The order preview's raw original item tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original item tax total's value. - - type: number - title: value - description: The raw original item tax total's value. - raw_item_total: - type: object - description: The order preview's raw item total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw item total's value. - - type: number - title: value - description: The raw item total's value. - raw_item_subtotal: - type: object - description: The order preview's raw item subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw item subtotal's value. - - type: number - title: value - description: The raw item subtotal's value. - raw_item_tax_total: - type: object - description: The order preview's raw item tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw item tax total's value. - - type: number - title: value - description: The raw item tax total's value. - raw_original_total: - type: object - description: The order preview's raw original total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original total's value. - - type: number - title: value - description: The raw original total's value. - raw_original_subtotal: - type: object - description: The order preview's raw original subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original subtotal's value. - - type: number - title: value - description: The raw original subtotal's value. - raw_original_tax_total: - type: object - description: The order preview's raw original tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original tax total's value. - - type: number - title: value - description: The raw original tax total's value. - raw_total: - type: object - description: The order preview's raw total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw total's value. - - type: number - title: value - description: The raw total's value. - raw_subtotal: - type: object - description: The order preview's raw subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw subtotal's value. - - type: number - title: value - description: The raw subtotal's value. - raw_tax_total: - type: object - description: The order preview's raw tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw tax total's value. - - type: number - title: value - description: The raw tax total's value. - raw_discount_total: - type: object - description: The order preview's raw discount total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw discount total's value. - - type: number - title: value - description: The raw discount total's value. - raw_discount_tax_total: - type: object - description: The order preview's raw discount tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw discount tax total's value. - - type: number - title: value - description: The raw discount tax total's value. - raw_gift_card_total: - type: object - description: The order preview's raw gift card total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw gift card total's value. - - type: number - title: value - description: The raw gift card total's value. - raw_gift_card_tax_total: - type: object - description: The order preview's raw gift card tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw gift card tax total's value. - - type: number - title: value - description: The raw gift card tax total's value. - raw_shipping_total: - type: object - description: The order preview's raw shipping total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw shipping total's value. - - type: number - title: value - description: The raw shipping total's value. - raw_shipping_subtotal: - type: object - description: The order preview's raw shipping subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw shipping subtotal's value. - - type: number - title: value - description: The raw shipping subtotal's value. - raw_shipping_tax_total: - type: object - description: The order preview's raw shipping tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw shipping tax total's value. - - type: number - title: value - description: The raw shipping tax total's value. - raw_original_shipping_total: - type: object - description: The order preview's raw original shipping total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original shipping total's value. - - type: number - title: value - description: The raw original shipping total's value. - raw_original_shipping_subtotal: - type: object - description: The order preview's raw original shipping subtotal. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original shipping subtotal's value. - - type: number - title: value - description: The raw original shipping subtotal's value. - raw_original_shipping_tax_total: - type: object - description: The order preview's raw original shipping tax total. - required: - - value - properties: - value: - oneOf: - - type: string - title: value - description: The raw original shipping tax total's value. - - type: number - title: value - description: The raw original shipping tax total's value. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml deleted file mode 100644 index 971b9caf80..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml +++ /dev/null @@ -1,359 +0,0 @@ -type: object -description: The item's items. -x-schemaName: OrderLineItem -required: - - id - - title - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - - raw_unit_price - - quantity - - raw_quantity - - detail - - created_at - - updated_at - - 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 - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_item_total - - raw_item_subtotal - - raw_item_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - - raw_refundable_total - - raw_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 item's thumbnail. - variant_id: - type: string - title: variant_id - description: The item's variant id. - product_id: - type: string - title: product_id - description: The item's product id. - product_title: - type: string - title: product_title - description: The item's product title. - product_description: - type: string - title: product_description - description: The item's product description. - product_subtitle: - type: string - title: product_subtitle - description: The item's product subtitle. - product_type: - type: string - title: product_type - description: The item's product type. - product_collection: - type: string - title: product_collection - description: The item's product collection. - product_handle: - type: string - title: product_handle - description: The item's product handle. - variant_sku: - type: string - title: variant_sku - description: The item's variant sku. - variant_barcode: - type: string - title: variant_barcode - description: The item's variant barcode. - variant_title: - type: string - title: variant_title - description: The item's variant title. - variant_option_values: - type: object - description: The item's variant option values. - requires_shipping: - type: boolean - title: requires_shipping - description: The item's requires shipping. - is_discountable: - type: boolean - title: is_discountable - description: The item's is discountable. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The item's is tax inclusive. - compare_at_unit_price: - type: number - title: compare_at_unit_price - description: The item's compare at unit price. - raw_compare_at_unit_price: - type: object - description: The item's raw compare at unit price. - unit_price: - type: number - title: unit_price - description: The item's unit price. - raw_unit_price: - type: object - description: The item's raw unit price. - quantity: - type: number - title: quantity - description: The item's quantity. - raw_quantity: - type: object - description: The item's raw quantity. - tax_lines: - type: array - description: The item's tax lines. - items: - $ref: ./OrderLineItemTaxLine.yaml - adjustments: - type: array - description: The item's adjustments. - items: - $ref: ./OrderLineItemAdjustment.yaml - detail: - $ref: ./OrderItem.yaml - created_at: - type: string - title: created_at - description: The item's created at. - format: date-time - updated_at: - type: string - title: updated_at - description: The item's updated at. - format: date-time - metadata: - type: object - description: The item's metadata. - original_total: - oneOf: - - type: string - title: original_total - description: The item's original total. - - type: number - title: original_total - description: The item's original total. - - type: string - title: original_total - description: The item's original total. - - $ref: ./IBigNumber.yaml - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The item's original subtotal. - - type: number - title: original_subtotal - description: The item's original subtotal. - - type: string - title: original_subtotal - description: The item's original subtotal. - - $ref: ./IBigNumber.yaml - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The item's original tax total. - - type: number - title: original_tax_total - description: The item's original tax total. - - type: string - title: original_tax_total - description: The item's original tax total. - - $ref: ./IBigNumber.yaml - item_total: - oneOf: - - type: string - title: item_total - description: The item's item total. - - type: number - title: item_total - description: The item's item total. - - type: string - title: item_total - description: The item's item total. - - $ref: ./IBigNumber.yaml - item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The item's item subtotal. - - type: number - title: item_subtotal - description: The item's item subtotal. - - type: string - title: item_subtotal - description: The item's item subtotal. - - $ref: ./IBigNumber.yaml - item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The item's item tax total. - - type: number - title: item_tax_total - description: The item's item tax total. - - type: string - title: item_tax_total - description: The item's item tax total. - - $ref: ./IBigNumber.yaml - total: - oneOf: - - type: string - title: total - description: The item's total. - - type: number - title: total - description: The item's total. - - type: string - title: total - description: The item's total. - - $ref: ./IBigNumber.yaml - subtotal: - oneOf: - - type: string - title: subtotal - description: The item's subtotal. - - type: number - title: subtotal - description: The item's subtotal. - - type: string - title: subtotal - description: The item's subtotal. - - $ref: ./IBigNumber.yaml - tax_total: - oneOf: - - type: string - title: tax_total - description: The item's tax total. - - type: number - title: tax_total - description: The item's tax total. - - type: string - title: tax_total - description: The item's tax total. - - $ref: ./IBigNumber.yaml - discount_total: - oneOf: - - type: string - title: discount_total - description: The item's discount total. - - type: number - title: discount_total - description: The item's discount total. - - type: string - title: discount_total - description: The item's discount total. - - $ref: ./IBigNumber.yaml - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The item's discount tax total. - - type: number - title: discount_tax_total - description: The item's discount tax total. - - type: string - title: discount_tax_total - description: The item's discount tax total. - - $ref: ./IBigNumber.yaml - refundable_total: - oneOf: - - type: string - title: refundable_total - description: The item's refundable total. - - type: number - title: refundable_total - description: The item's refundable total. - - type: string - title: refundable_total - description: The item's refundable total. - - $ref: ./IBigNumber.yaml - refundable_total_per_unit: - oneOf: - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: number - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - $ref: ./IBigNumber.yaml - raw_original_total: - type: object - description: The item's raw original total. - raw_original_subtotal: - type: object - description: The item's raw original subtotal. - raw_original_tax_total: - type: object - description: The item's raw original tax total. - raw_item_total: - type: object - description: The item's raw item total. - raw_item_subtotal: - type: object - description: The item's raw item subtotal. - raw_item_tax_total: - type: object - description: The item's raw item tax total. - raw_total: - type: object - description: The item's raw total. - raw_subtotal: - type: object - description: The item's raw subtotal. - raw_tax_total: - type: object - description: The item's raw tax total. - raw_discount_total: - type: object - description: The item's raw discount total. - raw_discount_tax_total: - type: object - description: The item's raw discount tax total. - raw_refundable_total: - type: object - description: The item's raw refundable total. - raw_refundable_total_per_unit: - type: object - description: The item's raw refundable total per unit. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml new file mode 100644 index 0000000000..3753f8ac74 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml @@ -0,0 +1,1530 @@ +type: object +description: The exchange's order preview. +x-schemaName: OrderPreview +required: + - order_change + - status + - currency_code + - id + - version + - 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 + - raw_original_item_total + - raw_original_item_subtotal + - raw_original_item_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_gift_card_total + - raw_gift_card_tax_total + - raw_shipping_total + - raw_shipping_subtotal + - raw_shipping_tax_total + - raw_original_shipping_total + - raw_original_shipping_subtotal + - raw_original_shipping_tax_total +properties: + order_change: + $ref: ./OrderChange.yaml + items: + type: array + description: The order preview's items. + items: + allOf: + - type: object + description: The item's items. + x-schemaName: OrderLineItem + required: + - id + - title + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - raw_unit_price + - quantity + - raw_quantity + - detail + - created_at + - updated_at + - 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 + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_refundable_total + - raw_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 item's thumbnail. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + raw_unit_price: + type: object + description: The item's raw unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./OrderLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./OrderLineItemAdjustment.yaml + detail: + $ref: ./OrderItem.yaml + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: ./IBigNumber.yaml + refundable_total: + oneOf: + - type: string + title: refundable_total + description: The item's refundable total. + - type: number + title: refundable_total + description: The item's refundable total. + - type: string + title: refundable_total + description: The item's refundable total. + - $ref: ./IBigNumber.yaml + refundable_total_per_unit: + oneOf: + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - $ref: ./IBigNumber.yaml + raw_original_total: + type: object + description: The item's raw original total. + raw_original_subtotal: + type: object + description: The item's raw original subtotal. + raw_original_tax_total: + type: object + description: The item's raw original tax total. + raw_item_total: + type: object + description: The item's raw item total. + raw_item_subtotal: + type: object + description: The item's raw item subtotal. + raw_item_tax_total: + type: object + description: The item's raw item tax total. + raw_total: + type: object + description: The item's raw total. + raw_subtotal: + type: object + description: The item's raw subtotal. + raw_tax_total: + type: object + description: The item's raw tax total. + raw_discount_total: + type: object + description: The item's raw discount total. + raw_discount_tax_total: + type: object + description: The item's raw discount tax total. + raw_refundable_total: + type: object + description: The item's raw refundable total. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + - type: object + description: The item's items. + properties: + actions: + type: array + description: The item's actions. + items: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + allOf: + - type: object + description: The shipping method's shipping methods. + x-schemaName: OrderShippingMethod + required: + - id + - order_id + - name + - amount + - raw_amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: ./IBigNumber.yaml + raw_amount: + type: object + description: The shipping method's raw amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: ./OrderShippingMethodTaxLine.yaml + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: ./OrderShippingMethodAdjustment.yaml + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: 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: ./IBigNumber.yaml + raw_original_total: + type: object + description: The shipping method's raw original total. + raw_original_subtotal: + type: object + description: The shipping method's raw original subtotal. + raw_original_tax_total: + type: object + description: The shipping method's raw original tax total. + raw_total: + type: object + description: The shipping method's raw total. + raw_subtotal: + type: object + description: The shipping method's raw subtotal. + raw_tax_total: + type: object + description: The shipping method's raw tax total. + raw_discount_total: + type: object + description: The shipping method's raw discount total. + raw_discount_tax_total: + type: object + description: The shipping method's raw discount tax total. + - type: object + description: The shipping method's shipping methods. + properties: + actions: + type: array + description: The shipping method's actions. + items: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + status: + type: string + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. + region_id: + type: string + title: region_id + description: The order preview's region id. + customer_id: + type: string + title: customer_id + description: The order preview's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The order preview's sales channel id. + email: + type: string + title: email + description: The order preview's email. + format: email + shipping_address: + $ref: ./OrderAddress.yaml + billing_address: + $ref: ./OrderAddress.yaml + transactions: + type: array + description: The order preview's transactions. + items: + $ref: ./OrderTransaction.yaml + summary: + type: object + description: The order preview's summary. + required: + - total + - subtotal + - total_tax + - ordered_total + - fulfilled_total + - returned_total + - return_request_total + - write_off_total + - projected_total + - net_total + - net_subtotal + - net_total_tax + - balance + - paid_total + - refunded_total + properties: + total: + oneOf: + - type: string + title: total + description: The summary's total. + - type: number + title: total + description: The summary's total. + - type: string + title: total + description: The summary's total. + - type: object + description: The summary's total. + x-schemaName: IBigNumber + subtotal: + oneOf: + - type: string + title: subtotal + description: The summary's subtotal. + - type: number + title: subtotal + description: The summary's subtotal. + - type: string + title: subtotal + description: The summary's subtotal. + - type: object + description: The summary's subtotal. + x-schemaName: IBigNumber + total_tax: + oneOf: + - type: string + title: total_tax + description: The summary's total tax. + - type: number + title: total_tax + description: The summary's total tax. + - type: string + title: total_tax + description: The summary's total tax. + - type: object + description: The summary's total tax. + x-schemaName: IBigNumber + ordered_total: + oneOf: + - type: string + title: ordered_total + description: The summary's ordered total. + - type: number + title: ordered_total + description: The summary's ordered total. + - type: string + title: ordered_total + description: The summary's ordered total. + - type: object + description: The summary's ordered total. + x-schemaName: IBigNumber + fulfilled_total: + oneOf: + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: number + title: fulfilled_total + description: The summary's fulfilled total. + - type: string + title: fulfilled_total + description: The summary's fulfilled total. + - type: object + description: The summary's fulfilled total. + x-schemaName: IBigNumber + returned_total: + oneOf: + - type: string + title: returned_total + description: The summary's returned total. + - type: number + title: returned_total + description: The summary's returned total. + - type: string + title: returned_total + description: The summary's returned total. + - type: object + description: The summary's returned total. + x-schemaName: IBigNumber + return_request_total: + oneOf: + - type: string + title: return_request_total + description: The summary's return request total. + - type: number + title: return_request_total + description: The summary's return request total. + - type: string + title: return_request_total + description: The summary's return request total. + - type: object + description: The summary's return request total. + x-schemaName: IBigNumber + write_off_total: + oneOf: + - type: string + title: write_off_total + description: The summary's write off total. + - type: number + title: write_off_total + description: The summary's write off total. + - type: string + title: write_off_total + description: The summary's write off total. + - type: object + description: The summary's write off total. + x-schemaName: IBigNumber + projected_total: + oneOf: + - type: string + title: projected_total + description: The summary's projected total. + - type: number + title: projected_total + description: The summary's projected total. + - type: string + title: projected_total + description: The summary's projected total. + - type: object + description: The summary's projected total. + x-schemaName: IBigNumber + net_total: + oneOf: + - type: string + title: net_total + description: The summary's net total. + - type: number + title: net_total + description: The summary's net total. + - type: string + title: net_total + description: The summary's net total. + - type: object + description: The summary's net total. + x-schemaName: IBigNumber + net_subtotal: + oneOf: + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: number + title: net_subtotal + description: The summary's net subtotal. + - type: string + title: net_subtotal + description: The summary's net subtotal. + - type: object + description: The summary's net subtotal. + x-schemaName: IBigNumber + net_total_tax: + oneOf: + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: number + title: net_total_tax + description: The summary's net total tax. + - type: string + title: net_total_tax + description: The summary's net total tax. + - type: object + description: The summary's net total tax. + x-schemaName: IBigNumber + balance: + oneOf: + - type: string + title: balance + description: The summary's balance. + - type: number + title: balance + description: The summary's balance. + - type: string + title: balance + description: The summary's balance. + - type: object + description: The summary's balance. + x-schemaName: IBigNumber + paid_total: + oneOf: + - type: string + title: paid_total + description: The summary's paid total. + - type: number + title: paid_total + description: The summary's paid total. + - type: string + title: paid_total + description: The summary's paid total. + - type: object + description: The summary's paid total. + x-schemaName: IBigNumber + refunded_total: + oneOf: + - type: string + title: refunded_total + description: The summary's refunded total. + - type: number + title: refunded_total + description: The summary's refunded total. + - type: string + title: refunded_total + description: The summary's refunded total. + - type: object + description: The summary's refunded total. + x-schemaName: IBigNumber + metadata: + type: object + description: The order preview's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The order preview's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order preview's updated at. + original_item_total: + oneOf: + - type: string + title: original_item_total + description: The order preview's original item total. + - type: number + title: original_item_total + description: The order preview's original item total. + - type: string + title: original_item_total + description: The order preview's original item total. + - $ref: ./IBigNumber.yaml + original_item_subtotal: + oneOf: + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: number + title: original_item_subtotal + description: The order preview's original item subtotal. + - type: string + title: original_item_subtotal + description: The order preview's original item subtotal. + - $ref: ./IBigNumber.yaml + original_item_tax_total: + oneOf: + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - type: number + title: original_item_tax_total + description: The order preview's original item tax total. + - type: string + title: original_item_tax_total + description: The order preview's original item tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The order preview's item total. + - type: number + title: item_total + description: The order preview's item total. + - type: string + title: item_total + description: The order preview's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - type: number + title: item_subtotal + description: The order preview's item subtotal. + - type: string + title: item_subtotal + description: The order preview's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The order preview's item tax total. + - type: number + title: item_tax_total + description: The order preview's item tax total. + - type: string + title: item_tax_total + description: The order preview's item tax total. + - $ref: ./IBigNumber.yaml + original_total: + oneOf: + - type: string + title: original_total + description: The order preview's original total. + - type: number + title: original_total + description: The order preview's original total. + - type: string + title: original_total + description: The order preview's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - type: number + title: original_subtotal + description: The order preview's original subtotal. + - type: string + title: original_subtotal + description: The order preview's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The order preview's original tax total. + - type: number + title: original_tax_total + description: The order preview's original tax total. + - type: string + title: original_tax_total + description: The order preview's original tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The order preview's total. + - type: number + title: total + description: The order preview's total. + - type: string + title: total + description: The order preview's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The order preview's subtotal. + - type: number + title: subtotal + description: The order preview's subtotal. + - type: string + title: subtotal + description: The order preview's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The order preview's tax total. + - type: number + title: tax_total + description: The order preview's tax total. + - type: string + title: tax_total + description: The order preview's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The order preview's discount total. + - type: number + title: discount_total + description: The order preview's discount total. + - type: string + title: discount_total + description: The order preview's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - type: number + title: discount_tax_total + description: The order preview's discount tax total. + - type: string + title: discount_tax_total + description: The order preview's discount tax total. + - $ref: ./IBigNumber.yaml + gift_card_total: + oneOf: + - type: string + title: gift_card_total + description: The order preview's gift card total. + - type: number + title: gift_card_total + description: The order preview's gift card total. + - type: string + title: gift_card_total + description: The order preview's gift card total. + - $ref: ./IBigNumber.yaml + gift_card_tax_total: + oneOf: + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: number + title: gift_card_tax_total + description: The order preview's gift card tax total. + - type: string + title: gift_card_tax_total + description: The order preview's gift card tax total. + - $ref: ./IBigNumber.yaml + shipping_total: + oneOf: + - type: string + title: shipping_total + description: The order preview's shipping total. + - type: number + title: shipping_total + description: The order preview's shipping total. + - type: string + title: shipping_total + description: The order preview's shipping total. + - $ref: ./IBigNumber.yaml + shipping_subtotal: + oneOf: + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: number + title: shipping_subtotal + description: The order preview's shipping subtotal. + - type: string + title: shipping_subtotal + description: The order preview's shipping subtotal. + - $ref: ./IBigNumber.yaml + shipping_tax_total: + oneOf: + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: number + title: shipping_tax_total + description: The order preview's shipping tax total. + - type: string + title: shipping_tax_total + description: The order preview's shipping tax total. + - $ref: ./IBigNumber.yaml + original_shipping_total: + oneOf: + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - type: number + title: original_shipping_total + description: The order preview's original shipping total. + - type: string + title: original_shipping_total + description: The order preview's original shipping total. + - $ref: ./IBigNumber.yaml + original_shipping_subtotal: + oneOf: + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: number + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - type: string + title: original_shipping_subtotal + description: The order preview's original shipping subtotal. + - $ref: ./IBigNumber.yaml + original_shipping_tax_total: + oneOf: + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: number + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - type: string + title: original_shipping_tax_total + description: The order preview's original shipping tax total. + - $ref: ./IBigNumber.yaml + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order preview's canceled at. + - type: string + title: canceled_at + description: The order preview's canceled at. + format: date-time + raw_original_item_total: + type: object + description: The order preview's raw original item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item total's value. + - type: number + title: value + description: The raw original item total's value. + raw_original_item_subtotal: + type: object + description: The order preview's raw original item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item subtotal's value. + - type: number + title: value + description: The raw original item subtotal's value. + raw_original_item_tax_total: + type: object + description: The order preview's raw original item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original item tax total's value. + - type: number + title: value + description: The raw original item tax total's value. + raw_item_total: + type: object + description: The order preview's raw item total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item total's value. + - type: number + title: value + description: The raw item total's value. + raw_item_subtotal: + type: object + description: The order preview's raw item subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item subtotal's value. + - type: number + title: value + description: The raw item subtotal's value. + raw_item_tax_total: + type: object + description: The order preview's raw item tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw item tax total's value. + - type: number + title: value + description: The raw item tax total's value. + raw_original_total: + type: object + description: The order preview's raw original total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original total's value. + - type: number + title: value + description: The raw original total's value. + raw_original_subtotal: + type: object + description: The order preview's raw original subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original subtotal's value. + - type: number + title: value + description: The raw original subtotal's value. + raw_original_tax_total: + type: object + description: The order preview's raw original tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original tax total's value. + - type: number + title: value + description: The raw original tax total's value. + raw_total: + type: object + description: The order preview's raw total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw total's value. + - type: number + title: value + description: The raw total's value. + raw_subtotal: + type: object + description: The order preview's raw subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw subtotal's value. + - type: number + title: value + description: The raw subtotal's value. + raw_tax_total: + type: object + description: The order preview's raw tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw tax total's value. + - type: number + title: value + description: The raw tax total's value. + raw_discount_total: + type: object + description: The order preview's raw discount total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount total's value. + - type: number + title: value + description: The raw discount total's value. + raw_discount_tax_total: + type: object + description: The order preview's raw discount tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw discount tax total's value. + - type: number + title: value + description: The raw discount tax total's value. + raw_gift_card_total: + type: object + description: The order preview's raw gift card total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card total's value. + - type: number + title: value + description: The raw gift card total's value. + raw_gift_card_tax_total: + type: object + description: The order preview's raw gift card tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw gift card tax total's value. + - type: number + title: value + description: The raw gift card tax total's value. + raw_shipping_total: + type: object + description: The order preview's raw shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping total's value. + - type: number + title: value + description: The raw shipping total's value. + raw_shipping_subtotal: + type: object + description: The order preview's raw shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping subtotal's value. + - type: number + title: value + description: The raw shipping subtotal's value. + raw_shipping_tax_total: + type: object + description: The order preview's raw shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw shipping tax total's value. + - type: number + title: value + description: The raw shipping tax total's value. + raw_original_shipping_total: + type: object + description: The order preview's raw original shipping total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping total's value. + - type: number + title: value + description: The raw original shipping total's value. + raw_original_shipping_subtotal: + type: object + description: The order preview's raw original shipping subtotal. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping subtotal's value. + - type: number + title: value + description: The raw original shipping subtotal's value. + raw_original_shipping_tax_total: + type: object + description: The order preview's raw original shipping tax total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw original shipping tax total's value. + - type: number + title: value + description: The raw original shipping tax total's value. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml deleted file mode 100644 index 27f2932fb3..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml +++ /dev/null @@ -1,214 +0,0 @@ -type: object -description: The shipping method's shipping methods. -x-schemaName: OrderShippingMethod -required: - - id - - order_id - - name - - amount - - raw_amount - - is_tax_inclusive - - created_at - - updated_at - - original_total - - original_subtotal - - original_tax_total - - total - - subtotal - - tax_total - - discount_total - - discount_tax_total - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total -properties: - id: - type: string - title: id - description: The shipping method's ID. - order_id: - type: string - title: order_id - description: The shipping method's order id. - name: - type: string - title: name - description: The shipping method's name. - description: - type: string - title: description - description: The shipping method's description. - amount: - oneOf: - - type: string - title: amount - description: The shipping method's amount. - - type: number - title: amount - description: The shipping method's amount. - - type: string - title: amount - description: The shipping method's amount. - - $ref: ./IBigNumber.yaml - raw_amount: - type: object - description: The shipping method's raw amount. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The shipping method's is tax inclusive. - shipping_option_id: - type: string - title: shipping_option_id - description: The shipping method's shipping option id. - data: - type: object - description: The shipping method's data. - metadata: - type: object - description: The shipping method's metadata. - tax_lines: - type: array - description: The shipping method's tax lines. - items: - $ref: ./OrderShippingMethodTaxLine.yaml - adjustments: - type: array - description: The shipping method's adjustments. - items: - $ref: ./OrderShippingMethodAdjustment.yaml - created_at: - type: string - format: date-time - title: created_at - description: The shipping method's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The shipping method's updated at. - original_total: - oneOf: - - type: string - title: original_total - description: The shipping method's original total. - - type: number - title: original_total - description: The shipping method's original total. - - type: string - title: original_total - description: The shipping method's original total. - - $ref: ./IBigNumber.yaml - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The shipping method's original subtotal. - - type: number - title: original_subtotal - description: The shipping method's original subtotal. - - type: string - title: original_subtotal - description: The shipping method's original subtotal. - - $ref: ./IBigNumber.yaml - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The shipping method's original tax total. - - type: number - title: original_tax_total - description: The shipping method's original tax total. - - type: string - title: original_tax_total - description: The shipping method's original tax total. - - $ref: ./IBigNumber.yaml - total: - oneOf: - - type: string - title: total - description: The shipping method's total. - - type: number - title: total - description: The shipping method's total. - - type: string - title: total - description: The shipping method's total. - - $ref: ./IBigNumber.yaml - subtotal: - oneOf: - - type: string - title: subtotal - description: The shipping method's subtotal. - - type: number - title: subtotal - description: The shipping method's subtotal. - - type: string - title: subtotal - description: The shipping method's subtotal. - - $ref: ./IBigNumber.yaml - tax_total: - oneOf: - - type: string - title: tax_total - description: The shipping method's tax total. - - type: number - title: tax_total - description: The shipping method's tax total. - - type: string - title: tax_total - description: The shipping method's tax total. - - $ref: ./IBigNumber.yaml - discount_total: - oneOf: - - type: string - title: discount_total - description: The shipping method's discount total. - - type: number - title: discount_total - description: The shipping method's discount total. - - type: string - title: discount_total - description: The shipping method's discount total. - - $ref: ./IBigNumber.yaml - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The shipping method's discount tax total. - - type: number - title: 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: ./IBigNumber.yaml - raw_original_total: - type: object - description: The shipping method's raw original total. - raw_original_subtotal: - type: object - description: The shipping method's raw original subtotal. - raw_original_tax_total: - type: object - description: The shipping method's raw original tax total. - raw_total: - type: object - description: The shipping method's raw total. - raw_subtotal: - type: object - description: The shipping method's raw subtotal. - raw_tax_total: - type: object - description: The shipping method's raw tax total. - raw_discount_total: - type: object - description: The shipping method's raw discount total. - raw_discount_tax_total: - type: object - description: The shipping method's raw discount tax total. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index ae876bb05e..0b820cbe00 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -11070,7 +11070,7 @@ components: - claim properties: order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimRequestResponse: @@ -11085,7 +11085,7 @@ components: return: $ref: '#/components/schemas/AdminReturn' order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimResponse: @@ -11106,7 +11106,7 @@ components: - return properties: order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' return: $ref: '#/components/schemas/AdminReturn' AdminCollection: @@ -12679,7 +12679,7 @@ components: - exchange properties: order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangeRequestResponse: @@ -12694,7 +12694,7 @@ components: return: $ref: '#/components/schemas/AdminReturn' order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangeResponse: @@ -12715,7 +12715,7 @@ components: - return properties: order_preview: - $ref: '#/components/schemas/Order' + $ref: '#/components/schemas/OrderPreview' return: $ref: '#/components/schemas/AdminReturn' AdminExportProductRequest: @@ -13695,6 +13695,15 @@ components: type: number title: original_shipping_tax_total description: The order's original shipping tax total. + AdminOrderEditPreviewResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderEditPreviewResponse + required: + - order_preview + properties: + order_preview: + $ref: '#/components/schemas/OrderPreview' AdminOrderPreview: type: object description: The return's order preview. @@ -14827,6 +14836,19 @@ components: metadata: type: object description: The item's metadata. + AdminPostExchangesItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostExchangesItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The exchange's quantity. + internal_note: + type: string + title: internal_note + description: The exchange's internal note. AdminPostExchangesRequestItemsReturnActionReqSchema: type: object description: SUMMARY @@ -14927,19 +14949,6 @@ components: metadata: type: object description: The exchange's metadata. - AdminPostExhangesItemsActionReqSchema: - type: object - description: SUMMARY - x-schemaName: AdminPostExhangesItemsActionReqSchema - properties: - quantity: - type: number - title: quantity - description: The exchange's quantity. - internal_note: - type: string - title: internal_note - description: The exchange's internal note. AdminPostOrderClaimsReqSchema: type: object description: SUMMARY @@ -14974,6 +14983,122 @@ components: metadata: type: object description: The claim's metadata. + AdminPostOrderEditsAddItemsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsAddItemsReqSchema + properties: + items: + type: array + description: The order edit's items. + items: + type: object + description: The item's items. + required: + - variant_id + - quantity + properties: + variant_id: + type: string + title: variant_id + description: The item's variant id. + quantity: + type: number + title: quantity + description: The item's quantity. + unit_price: + type: number + title: unit_price + description: The item's unit price. + internal_note: + type: string + title: internal_note + description: The item's internal note. + allow_backorder: + type: boolean + title: allow_backorder + description: The item's allow backorder. + metadata: + type: object + description: The item's metadata. + AdminPostOrderEditsItemsActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsItemsActionReqSchema + properties: + quantity: + type: number + title: quantity + description: The order edit's quantity. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + AdminPostOrderEditsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsReqSchema + required: + - order_id + - metadata + properties: + order_id: + type: string + title: order_id + description: The order edit's order id. + description: + type: string + title: description + description: The order edit's description. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. + AdminPostOrderEditsShippingActionReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsShippingActionReqSchema + properties: + custom_price: + type: number + title: custom_price + description: The order edit's custom price. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. + AdminPostOrderEditsShippingReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostOrderEditsShippingReqSchema + required: + - shipping_option_id + properties: + shipping_option_id: + type: string + title: shipping_option_id + description: The order edit's shipping option id. + custom_price: + type: number + title: custom_price + description: The order edit's custom price. + description: + type: string + title: description + description: The order edit's description. + internal_note: + type: string + title: internal_note + description: The order edit's internal note. + metadata: + type: object + description: The order edit's metadata. AdminPostOrderExchangesReqSchema: type: object description: SUMMARY @@ -21506,13 +21631,259 @@ components: description: The inventory level's metadata. Order: type: object - description: The exchange's order preview. + description: The transaction's order. x-schemaName: Order + OrderAddress: + type: object + description: The order preview's billing address. + x-schemaName: OrderAddress + required: + - id + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The billing address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The billing address's updated at. + OrderChange: + type: object + description: The order preview's order change. + x-schemaName: OrderChange required: - id - version + - order_id + - return_id + - exchange_id + - claim_id + - order + - return_order + - exchange + - claim + - actions + - status + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - metadata + - declined_at + - canceled_by + - canceled_at + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: The order change's version. + change_type: + type: string + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The order change's order id. + return_id: + type: string + title: return_id + description: The order change's return id. + exchange_id: + type: string + title: exchange_id + description: The order change's exchange id. + claim_id: + type: string + title: claim_id + description: The order change's claim id. + order: + type: object + return_order: + $ref: '#/components/schemas/Return' + exchange: + $ref: '#/components/schemas/OrderExchange' + claim: + $ref: '#/components/schemas/OrderClaim' + actions: + type: array + description: The order change's actions. + items: + $ref: '#/components/schemas/OrderChangeAction' + status: + type: string + title: status + description: The order change's status. + requested_by: + type: string + title: requested_by + description: The order change's requested by. + requested_at: + oneOf: + - type: string + title: requested_at + description: The order change's requested at. + - type: string + title: requested_at + description: The order change's requested at. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The order change's confirmed by. + confirmed_at: + oneOf: + - type: string + title: confirmed_at + description: The order change's confirmed at. + - type: string + title: confirmed_at + description: The order change's confirmed at. + format: date-time + declined_by: + type: string + title: declined_by + description: The order change's declined by. + declined_reason: + type: string + title: declined_reason + description: The order change's declined reason. + metadata: + type: object + description: The order change's metadata. + declined_at: + oneOf: + - type: string + title: declined_at + description: The order change's declined at. + - type: string + title: declined_at + description: The order change's declined at. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The order change's canceled by. + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order change's canceled at. + - type: string + title: canceled_at + description: The order change's canceled at. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The order change's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The order change's updated at. + OrderChangeAction: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + OrderClaim: + type: object + description: The order change's claim. + x-schemaName: OrderClaim + OrderExchange: + type: object + description: The order change's exchange. + x-schemaName: OrderExchange + OrderItem: + type: object + description: The item's detail. + x-schemaName: OrderItem + OrderLineItemAdjustment: + type: object + description: The adjustment's adjustments. + x-schemaName: OrderLineItemAdjustment + OrderLineItemTaxLine: + type: object + description: The tax line's tax lines. + x-schemaName: OrderLineItemTaxLine + OrderPreview: + type: object + description: The exchange's order preview. + x-schemaName: OrderPreview + required: + - order_change - status - currency_code + - id + - version - original_item_total - original_item_subtotal - original_item_tax_total @@ -21558,16 +21929,611 @@ components: - raw_original_shipping_subtotal - raw_original_shipping_tax_total properties: - id: - type: string - title: id - description: The order preview's ID. - version: - type: number - title: version - description: The order preview's version. order_change: $ref: '#/components/schemas/OrderChange' + items: + type: array + description: The order preview's items. + items: + allOf: + - type: object + description: The item's items. + x-schemaName: OrderLineItem + required: + - id + - title + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - raw_unit_price + - quantity + - raw_quantity + - detail + - created_at + - updated_at + - 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 + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_item_total + - raw_item_subtotal + - raw_item_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + - raw_refundable_total + - raw_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 item's thumbnail. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + raw_unit_price: + type: object + description: The item's raw unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/OrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/OrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/OrderItem' + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + metadata: + type: object + description: The item's metadata. + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: '#/components/schemas/IBigNumber' + refundable_total: + oneOf: + - type: string + title: refundable_total + description: The item's refundable total. + - type: number + title: refundable_total + description: The item's refundable total. + - type: string + title: refundable_total + description: The item's refundable total. + - $ref: '#/components/schemas/IBigNumber' + refundable_total_per_unit: + oneOf: + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + - type: string + title: refundable_total_per_unit + description: The item's refundable total per unit. + - $ref: '#/components/schemas/IBigNumber' + raw_original_total: + type: object + description: The item's raw original total. + raw_original_subtotal: + type: object + description: The item's raw original subtotal. + raw_original_tax_total: + type: object + description: The item's raw original tax total. + raw_item_total: + type: object + description: The item's raw item total. + raw_item_subtotal: + type: object + description: The item's raw item subtotal. + raw_item_tax_total: + type: object + description: The item's raw item tax total. + raw_total: + type: object + description: The item's raw total. + raw_subtotal: + type: object + description: The item's raw subtotal. + raw_tax_total: + type: object + description: The item's raw tax total. + raw_discount_total: + type: object + description: The item's raw discount total. + raw_discount_tax_total: + type: object + description: The item's raw discount tax total. + raw_refundable_total: + type: object + description: The item's raw refundable total. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + - type: object + description: The item's items. + properties: + actions: + type: array + description: The item's actions. + items: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction + shipping_methods: + type: array + description: The order preview's shipping methods. + items: + allOf: + - type: object + description: The shipping method's shipping methods. + x-schemaName: OrderShippingMethod + required: + - id + - order_id + - name + - amount + - raw_amount + - is_tax_inclusive + - created_at + - updated_at + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - raw_original_total + - raw_original_subtotal + - raw_original_tax_total + - raw_total + - raw_subtotal + - raw_tax_total + - raw_discount_total + - raw_discount_tax_total + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: string + title: amount + description: The shipping method's amount. + - $ref: '#/components/schemas/IBigNumber' + raw_amount: + type: object + description: The shipping method's raw amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + $ref: '#/components/schemas/OrderShippingMethodTaxLine' + adjustments: + type: array + description: The shipping method's adjustments. + items: + $ref: '#/components/schemas/OrderShippingMethodAdjustment' + created_at: + type: string + format: date-time + title: created_at + description: The shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + original_total: + oneOf: + - type: string + title: original_total + description: The shipping method's original total. + - type: number + title: original_total + description: The shipping method's original total. + - type: string + title: original_total + description: The shipping method's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - type: number + title: original_subtotal + description: The shipping method's original subtotal. + - type: string + title: original_subtotal + description: The shipping method's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - type: number + title: original_tax_total + description: The shipping method's original tax total. + - type: string + title: original_tax_total + description: The shipping method's original tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The shipping method's total. + - type: number + title: total + description: The shipping method's total. + - type: string + title: total + description: The shipping method's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The shipping method's subtotal. + - type: number + title: subtotal + description: The shipping method's subtotal. + - type: string + title: subtotal + description: The shipping method's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The shipping method's tax total. + - type: number + title: tax_total + description: The shipping method's tax total. + - type: string + title: tax_total + description: The shipping method's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The shipping method's discount total. + - type: number + title: discount_total + description: The shipping method's discount total. + - type: string + title: discount_total + description: The shipping method's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The shipping method's discount tax total. + - type: number + title: 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' + raw_original_total: + type: object + description: The shipping method's raw original total. + raw_original_subtotal: + type: object + description: The shipping method's raw original subtotal. + raw_original_tax_total: + type: object + description: The shipping method's raw original tax total. + raw_total: + type: object + description: The shipping method's raw total. + raw_subtotal: + type: object + description: The shipping method's raw subtotal. + raw_tax_total: + type: object + description: The shipping method's raw tax total. + raw_discount_total: + type: object + description: The shipping method's raw discount total. + raw_discount_tax_total: + type: object + description: The shipping method's raw discount tax total. + - type: object + description: The shipping method's shipping methods. + properties: + actions: + type: array + description: The shipping method's actions. + items: + type: object + description: The action's actions. + x-schemaName: OrderChangeAction status: type: string enum: @@ -21577,6 +22543,18 @@ components: - completed - draft - archived + currency_code: + type: string + title: currency_code + description: The order preview's currency code. + id: + type: string + title: id + description: The order preview's ID. + version: + type: number + title: version + description: The order preview's version. region_id: type: string title: region_id @@ -21594,24 +22572,10 @@ components: title: email description: The order preview's email. format: email - currency_code: - type: string - title: currency_code - description: The order preview's currency code. shipping_address: $ref: '#/components/schemas/OrderAddress' billing_address: $ref: '#/components/schemas/OrderAddress' - items: - type: array - description: The order preview's items. - items: - $ref: '#/components/schemas/OrderLineItem' - shipping_methods: - type: array - description: The order preview's shipping methods. - items: - $ref: '#/components/schemas/OrderShippingMethod' transactions: type: array description: The order preview's transactions. @@ -21850,15 +22814,6 @@ components: metadata: type: object description: The order preview's metadata. - canceled_at: - oneOf: - - type: string - title: canceled_at - description: The order preview's canceled at. - - type: string - title: canceled_at - description: The order preview's canceled at. - format: date-time created_at: type: string format: date-time @@ -22133,6 +23088,15 @@ components: title: original_shipping_tax_total description: The order preview's original shipping tax total. - $ref: '#/components/schemas/IBigNumber' + canceled_at: + oneOf: + - type: string + title: canceled_at + description: The order preview's canceled at. + - type: string + title: canceled_at + description: The order preview's canceled at. + format: date-time raw_original_item_total: type: object description: The order preview's raw original item total. @@ -22441,822 +23405,6 @@ components: - type: number title: value description: The raw original shipping tax total's value. - OrderAddress: - type: object - description: The order preview's billing address. - x-schemaName: OrderAddress - required: - - id - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The billing address's ID. - customer_id: - type: string - title: customer_id - description: The billing address's customer id. - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - phone: - type: string - title: phone - description: The billing address's phone. - company: - type: string - title: company - description: The billing address's company. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - metadata: - type: object - description: The billing address's metadata. - created_at: - type: string - format: date-time - title: created_at - description: The billing address's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The billing address's updated at. - OrderChange: - type: object - description: The order preview's order change. - x-schemaName: OrderChange - required: - - id - - version - - order_id - - return_id - - exchange_id - - claim_id - - order - - return_order - - exchange - - claim - - actions - - status - - requested_by - - requested_at - - confirmed_by - - confirmed_at - - declined_by - - declined_reason - - metadata - - declined_at - - canceled_by - - canceled_at - - created_at - - updated_at - properties: - id: - type: string - title: id - description: The order change's ID. - version: - type: number - title: version - description: The order change's version. - change_type: - type: string - enum: - - return - - exchange - - claim - - edit - order_id: - type: string - title: order_id - description: The order change's order id. - return_id: - type: string - title: return_id - description: The order change's return id. - exchange_id: - type: string - title: exchange_id - description: The order change's exchange id. - claim_id: - type: string - title: claim_id - description: The order change's claim id. - order: - type: object - return_order: - $ref: '#/components/schemas/Return' - exchange: - $ref: '#/components/schemas/OrderExchange' - claim: - $ref: '#/components/schemas/OrderClaim' - actions: - type: array - description: The order change's actions. - items: - $ref: '#/components/schemas/OrderChangeAction' - status: - type: string - title: status - description: The order change's status. - requested_by: - type: string - title: requested_by - description: The order change's requested by. - requested_at: - oneOf: - - type: string - title: requested_at - description: The order change's requested at. - - type: string - title: requested_at - description: The order change's requested at. - format: date-time - confirmed_by: - type: string - title: confirmed_by - description: The order change's confirmed by. - confirmed_at: - oneOf: - - type: string - title: confirmed_at - description: The order change's confirmed at. - - type: string - title: confirmed_at - description: The order change's confirmed at. - format: date-time - declined_by: - type: string - title: declined_by - description: The order change's declined by. - declined_reason: - type: string - title: declined_reason - description: The order change's declined reason. - metadata: - type: object - description: The order change's metadata. - declined_at: - oneOf: - - type: string - title: declined_at - description: The order change's declined at. - - type: string - title: declined_at - description: The order change's declined at. - format: date-time - canceled_by: - type: string - title: canceled_by - description: The order change's canceled by. - canceled_at: - oneOf: - - type: string - title: canceled_at - description: The order change's canceled at. - - type: string - title: canceled_at - description: The order change's canceled at. - format: date-time - created_at: - type: string - format: date-time - title: created_at - description: The order change's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The order change's updated at. - OrderChangeAction: - type: object - description: The action's actions. - x-schemaName: OrderChangeAction - OrderClaim: - type: object - description: The order change's claim. - x-schemaName: OrderClaim - OrderExchange: - type: object - description: The order change's exchange. - x-schemaName: OrderExchange - OrderItem: - type: object - description: The item's detail. - x-schemaName: OrderItem - OrderLineItem: - type: object - description: The item's items. - x-schemaName: OrderLineItem - required: - - id - - title - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - - raw_unit_price - - quantity - - raw_quantity - - detail - - created_at - - updated_at - - 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 - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_item_total - - raw_item_subtotal - - raw_item_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - - raw_refundable_total - - raw_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 item's thumbnail. - variant_id: - type: string - title: variant_id - description: The item's variant id. - product_id: - type: string - title: product_id - description: The item's product id. - product_title: - type: string - title: product_title - description: The item's product title. - product_description: - type: string - title: product_description - description: The item's product description. - product_subtitle: - type: string - title: product_subtitle - description: The item's product subtitle. - product_type: - type: string - title: product_type - description: The item's product type. - product_collection: - type: string - title: product_collection - description: The item's product collection. - product_handle: - type: string - title: product_handle - description: The item's product handle. - variant_sku: - type: string - title: variant_sku - description: The item's variant sku. - variant_barcode: - type: string - title: variant_barcode - description: The item's variant barcode. - variant_title: - type: string - title: variant_title - description: The item's variant title. - variant_option_values: - type: object - description: The item's variant option values. - requires_shipping: - type: boolean - title: requires_shipping - description: The item's requires shipping. - is_discountable: - type: boolean - title: is_discountable - description: The item's is discountable. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The item's is tax inclusive. - compare_at_unit_price: - type: number - title: compare_at_unit_price - description: The item's compare at unit price. - raw_compare_at_unit_price: - type: object - description: The item's raw compare at unit price. - unit_price: - type: number - title: unit_price - description: The item's unit price. - raw_unit_price: - type: object - description: The item's raw unit price. - quantity: - type: number - title: quantity - description: The item's quantity. - raw_quantity: - type: object - description: The item's raw quantity. - tax_lines: - type: array - description: The item's tax lines. - items: - $ref: '#/components/schemas/OrderLineItemTaxLine' - adjustments: - type: array - description: The item's adjustments. - items: - $ref: '#/components/schemas/OrderLineItemAdjustment' - detail: - $ref: '#/components/schemas/OrderItem' - created_at: - type: string - title: created_at - description: The item's created at. - format: date-time - updated_at: - type: string - title: updated_at - description: The item's updated at. - format: date-time - metadata: - type: object - description: The item's metadata. - original_total: - oneOf: - - type: string - title: original_total - description: The item's original total. - - type: number - title: original_total - description: The item's original total. - - type: string - title: original_total - description: The item's original total. - - $ref: '#/components/schemas/IBigNumber' - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The item's original subtotal. - - type: number - title: original_subtotal - description: The item's original subtotal. - - type: string - title: original_subtotal - description: The item's original subtotal. - - $ref: '#/components/schemas/IBigNumber' - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The item's original tax total. - - type: number - title: original_tax_total - description: The item's original tax total. - - type: string - title: original_tax_total - description: The item's original tax total. - - $ref: '#/components/schemas/IBigNumber' - item_total: - oneOf: - - type: string - title: item_total - description: The item's item total. - - type: number - title: item_total - description: The item's item total. - - type: string - title: item_total - description: The item's item total. - - $ref: '#/components/schemas/IBigNumber' - item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The item's item subtotal. - - type: number - title: item_subtotal - description: The item's item subtotal. - - type: string - title: item_subtotal - description: The item's item subtotal. - - $ref: '#/components/schemas/IBigNumber' - item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The item's item tax total. - - type: number - title: item_tax_total - description: The item's item tax total. - - type: string - title: item_tax_total - description: The item's item tax total. - - $ref: '#/components/schemas/IBigNumber' - total: - oneOf: - - type: string - title: total - description: The item's total. - - type: number - title: total - description: The item's total. - - type: string - title: total - description: The item's total. - - $ref: '#/components/schemas/IBigNumber' - subtotal: - oneOf: - - type: string - title: subtotal - description: The item's subtotal. - - type: number - title: subtotal - description: The item's subtotal. - - type: string - title: subtotal - description: The item's subtotal. - - $ref: '#/components/schemas/IBigNumber' - tax_total: - oneOf: - - type: string - title: tax_total - description: The item's tax total. - - type: number - title: tax_total - description: The item's tax total. - - type: string - title: tax_total - description: The item's tax total. - - $ref: '#/components/schemas/IBigNumber' - discount_total: - oneOf: - - type: string - title: discount_total - description: The item's discount total. - - type: number - title: discount_total - description: The item's discount total. - - type: string - title: discount_total - description: The item's discount total. - - $ref: '#/components/schemas/IBigNumber' - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The item's discount tax total. - - type: number - title: discount_tax_total - description: The item's discount tax total. - - type: string - title: discount_tax_total - description: The item's discount tax total. - - $ref: '#/components/schemas/IBigNumber' - refundable_total: - oneOf: - - type: string - title: refundable_total - description: The item's refundable total. - - type: number - title: refundable_total - description: The item's refundable total. - - type: string - title: refundable_total - description: The item's refundable total. - - $ref: '#/components/schemas/IBigNumber' - refundable_total_per_unit: - oneOf: - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: number - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - $ref: '#/components/schemas/IBigNumber' - raw_original_total: - type: object - description: The item's raw original total. - raw_original_subtotal: - type: object - description: The item's raw original subtotal. - raw_original_tax_total: - type: object - description: The item's raw original tax total. - raw_item_total: - type: object - description: The item's raw item total. - raw_item_subtotal: - type: object - description: The item's raw item subtotal. - raw_item_tax_total: - type: object - description: The item's raw item tax total. - raw_total: - type: object - description: The item's raw total. - raw_subtotal: - type: object - description: The item's raw subtotal. - raw_tax_total: - type: object - description: The item's raw tax total. - raw_discount_total: - type: object - description: The item's raw discount total. - raw_discount_tax_total: - type: object - description: The item's raw discount tax total. - raw_refundable_total: - type: object - description: The item's raw refundable total. - raw_refundable_total_per_unit: - type: object - description: The item's raw refundable total per unit. - OrderLineItemAdjustment: - type: object - description: The adjustment's adjustments. - x-schemaName: OrderLineItemAdjustment - OrderLineItemTaxLine: - type: object - description: The tax line's tax lines. - x-schemaName: OrderLineItemTaxLine - OrderShippingMethod: - type: object - description: The shipping method's shipping methods. - x-schemaName: OrderShippingMethod - required: - - id - - order_id - - name - - amount - - raw_amount - - is_tax_inclusive - - created_at - - updated_at - - original_total - - original_subtotal - - original_tax_total - - total - - subtotal - - tax_total - - discount_total - - discount_tax_total - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - properties: - id: - type: string - title: id - description: The shipping method's ID. - order_id: - type: string - title: order_id - description: The shipping method's order id. - name: - type: string - title: name - description: The shipping method's name. - description: - type: string - title: description - description: The shipping method's description. - amount: - oneOf: - - type: string - title: amount - description: The shipping method's amount. - - type: number - title: amount - description: The shipping method's amount. - - type: string - title: amount - description: The shipping method's amount. - - $ref: '#/components/schemas/IBigNumber' - raw_amount: - type: object - description: The shipping method's raw amount. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The shipping method's is tax inclusive. - shipping_option_id: - type: string - title: shipping_option_id - description: The shipping method's shipping option id. - data: - type: object - description: The shipping method's data. - metadata: - type: object - description: The shipping method's metadata. - tax_lines: - type: array - description: The shipping method's tax lines. - items: - $ref: '#/components/schemas/OrderShippingMethodTaxLine' - adjustments: - type: array - description: The shipping method's adjustments. - items: - $ref: '#/components/schemas/OrderShippingMethodAdjustment' - created_at: - type: string - format: date-time - title: created_at - description: The shipping method's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The shipping method's updated at. - original_total: - oneOf: - - type: string - title: original_total - description: The shipping method's original total. - - type: number - title: original_total - description: The shipping method's original total. - - type: string - title: original_total - description: The shipping method's original total. - - $ref: '#/components/schemas/IBigNumber' - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The shipping method's original subtotal. - - type: number - title: original_subtotal - description: The shipping method's original subtotal. - - type: string - title: original_subtotal - description: The shipping method's original subtotal. - - $ref: '#/components/schemas/IBigNumber' - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The shipping method's original tax total. - - type: number - title: original_tax_total - description: The shipping method's original tax total. - - type: string - title: original_tax_total - description: The shipping method's original tax total. - - $ref: '#/components/schemas/IBigNumber' - total: - oneOf: - - type: string - title: total - description: The shipping method's total. - - type: number - title: total - description: The shipping method's total. - - type: string - title: total - description: The shipping method's total. - - $ref: '#/components/schemas/IBigNumber' - subtotal: - oneOf: - - type: string - title: subtotal - description: The shipping method's subtotal. - - type: number - title: subtotal - description: The shipping method's subtotal. - - type: string - title: subtotal - description: The shipping method's subtotal. - - $ref: '#/components/schemas/IBigNumber' - tax_total: - oneOf: - - type: string - title: tax_total - description: The shipping method's tax total. - - type: number - title: tax_total - description: The shipping method's tax total. - - type: string - title: tax_total - description: The shipping method's tax total. - - $ref: '#/components/schemas/IBigNumber' - discount_total: - oneOf: - - type: string - title: discount_total - description: The shipping method's discount total. - - type: number - title: discount_total - description: The shipping method's discount total. - - type: string - title: discount_total - description: The shipping method's discount total. - - $ref: '#/components/schemas/IBigNumber' - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The shipping method's discount tax total. - - type: number - title: 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' - raw_original_total: - type: object - description: The shipping method's raw original total. - raw_original_subtotal: - type: object - description: The shipping method's raw original subtotal. - raw_original_tax_total: - type: object - description: The shipping method's raw original tax total. - raw_total: - type: object - description: The shipping method's raw total. - raw_subtotal: - type: object - description: The shipping method's raw subtotal. - raw_tax_total: - type: object - description: The shipping method's raw tax total. - raw_discount_total: - type: object - description: The shipping method's raw discount total. - raw_discount_tax_total: - type: object - description: The shipping method's raw discount tax total. OrderShippingMethodAdjustment: type: object description: The adjustment's adjustments. diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index 790484aa8d..258e1d2250 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -65,6 +65,7 @@ tags: - name: Notifications x-associatedSchema: $ref: "#/components/schemas/AdminNotification" + - name: Order Edits - name: Orders x-associatedSchema: $ref: "#/components/schemas/AdminOrder" diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts index 702c9f7125..c33f2bf0da 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -28,18 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index 891b945e6c..43b82d57d5 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -29,18 +29,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts index afa5fff1c7..288df8b828 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -28,18 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index 0f6dbc80b7..04353ef932 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -29,18 +29,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts index 9ab6427d3a..a582ebece1 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts @@ -22,18 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts new file mode 100644 index 0000000000..d882405fd6 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts @@ -0,0 +1,118 @@ +/** + * @oas [delete] /admin/order-edits/{id} + * operationId: DeleteOrderEditsId + * summary: Delete a Order Edit + * description: Delete a order edit. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order edit's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/order-edits/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The order edit's ID. + * object: + * type: string + * title: object + * description: The order edit's object. + * deleted: + * type: boolean + * title: deleted + * description: The order edit's deleted. + * parent: + * type: object + * description: The order edit's parent. + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts new file mode 100644 index 0000000000..1d750498aa --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts @@ -0,0 +1,105 @@ +/** + * @oas [delete] /admin/order-edits/{id}/items/{action_id} + * operationId: DeleteOrderEditsIdItemsAction_id + * summary: Remove Items from Order Edit + * description: Remove a list of items from a order edit. This doesn't delete the + * Item, only the association between the Item and the order edit. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order edit's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The order edit's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderEditPreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: removeItemOrderEditActionWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts new file mode 100644 index 0000000000..2f9ae73839 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts @@ -0,0 +1,108 @@ +/** + * @oas [delete] /admin/order-edits/{id}/shipping-method/{action_id} + * operationId: DeleteOrderEditsIdShippingMethodAction_id + * summary: Remove Shipping Methods from Order Edit + * description: Remove a list of shipping methods from a order edit. This doesn't + * delete the Shipping Method, only the association between the Shipping Method + * and the order edit. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order edit's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The order edit's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderEditPreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: removeOrderEditShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts index 5eadfec590..0f28b766c1 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts index c46771ab39..a4e461a355 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts @@ -22,18 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts index 4a2345ad32..c50bfdce09 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts @@ -16,18 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts new file mode 100644 index 0000000000..bd5916ae01 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts @@ -0,0 +1,98 @@ +/** + * @oas [get] /admin/exchanges/{id} + * operationId: GetExchangesId + * summary: Get a Exchange + * description: Retrieve a exchange by its ID. You can expand the exchange's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The exchange's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/exchanges/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Exchanges + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminExchangeResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts index d117a5f176..8970c04a0b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts @@ -17,18 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts index 03b3f3f852..39bbc18403 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts @@ -17,18 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts index 1105afddd9..2ee35f1213 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts @@ -22,18 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts index 77c6ded748..e51c0e48f3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts @@ -15,18 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts index 260e35f73c..df00eed867 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts index 4ed06634e9..08dfe6add7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts index e61a9e1c1a..c9499b18c2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -27,18 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts index df000b76a8..fe5cd379c7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index fcc8582cee..eeee41b1a0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -27,18 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts index 88d7a0908a..6092f5c967 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts index 46cec37e0b..da78e85c2a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -27,18 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -75,7 +75,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostExhangesItemsActionReqSchema" + * $ref: "#/components/schemas/AdminPostExchangesItemsActionReqSchema" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts index 44e5bcfe04..594a65edea 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index 15c07ce7ad..44788d4cc9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -27,18 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts index 0abc2b7d23..c7576ca5d2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -93,6 +93,10 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: confirmExchangeRequestWorkflow + * requestBody: + * content: + * application/json: + * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts new file mode 100644 index 0000000000..dd65c58bac --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts @@ -0,0 +1,101 @@ +/** + * @oas [post] /admin/order-edits + * operationId: PostOrderEdits + * summary: Create Order Edit + * description: Create a order edit. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostOrderEditsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/order-edits' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "order_id": "{value}", + * "metadata": {} + * }' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts new file mode 100644 index 0000000000..6fc1f3676c --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/order-edits/{id}/confirm + * operationId: PostOrderEditsIdConfirm + * summary: Add Confirms to Order Edit + * description: Add a list of confirms to a order edit. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order edit's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/order-edits/{id}/confirm' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderEditPreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: confirmOrderEditRequestWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts new file mode 100644 index 0000000000..f72ddb3ecc --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts @@ -0,0 +1,103 @@ +/** + * @oas [post] /admin/order-edits/{id}/items + * operationId: PostOrderEditsIdItems + * summary: Add Items to Order Edit + * description: Add a list of items to a order edit. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order edit's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostOrderEditsAddItemsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/order-edits/{id}/items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderEditPreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: orderEditAddNewItemWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts new file mode 100644 index 0000000000..cf6a42205e --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts @@ -0,0 +1,109 @@ +/** + * @oas [post] /admin/order-edits/{id}/items/{action_id} + * operationId: PostOrderEditsIdItemsAction_id + * summary: Add Items to Order Edit + * description: Add a list of items to a order edit. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order edit's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The order edit's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostOrderEditsItemsActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/order-edits/{id}/items/{action_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderEditPreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: updateOrderEditAddItemWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts new file mode 100644 index 0000000000..36c25d3e65 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts @@ -0,0 +1,107 @@ +/** + * @oas [post] /admin/order-edits/{id}/shipping-method + * operationId: PostOrderEditsIdShippingMethod + * summary: Add Shipping Methods to Order Edit + * description: Add a list of shipping methods to a order edit. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order edit's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostOrderEditsShippingReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "shipping_option_id": "{value}" + * }' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderEditPreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: createOrderEditShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts new file mode 100644 index 0000000000..a622de5d95 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts @@ -0,0 +1,111 @@ +/** + * @oas [post] /admin/order-edits/{id}/shipping-method/{action_id} + * operationId: PostOrderEditsIdShippingMethodAction_id + * summary: Add Shipping Methods to Order Edit + * description: Add a list of shipping methods to a order edit. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order edit's ID. + * required: true + * schema: + * type: string + * - name: action_id + * in: path + * description: The order edit's action id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostOrderEditsShippingActionReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Order Edits + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderEditPreviewResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: updateOrderEditShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts index b0e358fde6..30f6d9ca4f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts @@ -15,18 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts index 47b0a6f28f..6b44caa81b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts @@ -21,18 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: >- - * Comma-separated fields that should be included in the returned data. - * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. - * * without prefix it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned + * data. if a field is prefixed with `+` it will be added to the default + * fields, using `-` will remove it from the default fields. without prefix + * it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts index 38f52c17b8..4c9609297c 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts @@ -8,7 +8,7 @@ * - claim * properties: * order_preview: - * $ref: "#/components/schemas/Order" + * $ref: "#/components/schemas/OrderPreview" * claim: * $ref: "#/components/schemas/AdminClaim" * diff --git a/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts index a0fdf8de85..5448e68cb4 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts @@ -11,7 +11,7 @@ * return: * $ref: "#/components/schemas/AdminReturn" * order_preview: - * $ref: "#/components/schemas/Order" + * $ref: "#/components/schemas/OrderPreview" * claim: * $ref: "#/components/schemas/AdminClaim" * diff --git a/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts index 07af224d3c..78e01a27c8 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts @@ -8,7 +8,7 @@ * - return * properties: * order_preview: - * $ref: "#/components/schemas/Order" + * $ref: "#/components/schemas/OrderPreview" * return: * $ref: "#/components/schemas/AdminReturn" * diff --git a/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts index ee6e954501..5341e5925b 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts @@ -8,7 +8,7 @@ * - exchange * properties: * order_preview: - * $ref: "#/components/schemas/Order" + * $ref: "#/components/schemas/OrderPreview" * exchange: * $ref: "#/components/schemas/AdminExchange" * diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts index 86007dddd2..8adadd44a3 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts @@ -11,7 +11,7 @@ * return: * $ref: "#/components/schemas/AdminReturn" * order_preview: - * $ref: "#/components/schemas/Order" + * $ref: "#/components/schemas/OrderPreview" * exchange: * $ref: "#/components/schemas/AdminExchange" * diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts index 6c3dfb87ea..255098a9ff 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts @@ -8,7 +8,7 @@ * - return * properties: * order_preview: - * $ref: "#/components/schemas/Order" + * $ref: "#/components/schemas/OrderPreview" * return: * $ref: "#/components/schemas/AdminReturn" * diff --git a/www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts new file mode 100644 index 0000000000..549b26d3f3 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminOrderEditPreviewResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminOrderEditPreviewResponse + * required: + * - order_preview + * properties: + * order_preview: + * $ref: "#/components/schemas/OrderPreview" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostExhangesItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesItemsActionReqSchema.ts similarity index 73% rename from www/utils/generated/oas-output/schemas/AdminPostExhangesItemsActionReqSchema.ts rename to www/utils/generated/oas-output/schemas/AdminPostExchangesItemsActionReqSchema.ts index 7f7b493ef2..3bba550191 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExhangesItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesItemsActionReqSchema.ts @@ -1,8 +1,8 @@ /** - * @schema AdminPostExhangesItemsActionReqSchema + * @schema AdminPostExchangesItemsActionReqSchema * type: object * description: SUMMARY - * x-schemaName: AdminPostExhangesItemsActionReqSchema + * x-schemaName: AdminPostExchangesItemsActionReqSchema * properties: * quantity: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts new file mode 100644 index 0000000000..e8acd540a9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts @@ -0,0 +1,42 @@ +/** + * @schema AdminPostOrderEditsAddItemsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostOrderEditsAddItemsReqSchema + * properties: + * items: + * type: array + * description: The order edit's items. + * items: + * type: object + * description: The item's items. + * required: + * - variant_id + * - quantity + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * internal_note: + * type: string + * title: internal_note + * description: The item's internal note. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The item's allow backorder. + * metadata: + * type: object + * description: The item's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts new file mode 100644 index 0000000000..345e7bd362 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts @@ -0,0 +1,17 @@ +/** + * @schema AdminPostOrderEditsItemsActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostOrderEditsItemsActionReqSchema + * properties: + * quantity: + * type: number + * title: quantity + * description: The order edit's quantity. + * internal_note: + * type: string + * title: internal_note + * description: The order edit's internal note. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts new file mode 100644 index 0000000000..fb29681a97 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts @@ -0,0 +1,27 @@ +/** + * @schema AdminPostOrderEditsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostOrderEditsReqSchema + * required: + * - order_id + * - metadata + * properties: + * order_id: + * type: string + * title: order_id + * description: The order edit's order id. + * description: + * type: string + * title: description + * description: The order edit's description. + * internal_note: + * type: string + * title: internal_note + * description: The order edit's internal note. + * metadata: + * type: object + * description: The order edit's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts new file mode 100644 index 0000000000..28964c3650 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminPostOrderEditsShippingActionReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostOrderEditsShippingActionReqSchema + * properties: + * custom_price: + * type: number + * title: custom_price + * description: The order edit's custom price. + * internal_note: + * type: string + * title: internal_note + * description: The order edit's internal note. + * metadata: + * type: object + * description: The order edit's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts new file mode 100644 index 0000000000..cb32d0e6fc --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts @@ -0,0 +1,30 @@ +/** + * @schema AdminPostOrderEditsShippingReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostOrderEditsShippingReqSchema + * required: + * - shipping_option_id + * properties: + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The order edit's shipping option id. + * custom_price: + * type: number + * title: custom_price + * description: The order edit's custom price. + * description: + * type: string + * title: description + * description: The order edit's description. + * internal_note: + * type: string + * title: internal_note + * description: The order edit's internal note. + * metadata: + * type: object + * description: The order edit's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts index 4ed482079e..42d8c61cb0 100644 --- a/www/utils/generated/oas-output/schemas/Order.ts +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -1,941 +1,8 @@ /** * @schema Order * type: object - * description: The exchange's order preview. + * description: The transaction's order. * x-schemaName: Order - * required: - * - id - * - version - * - status - * - currency_code - * - 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 - * - raw_original_item_total - * - raw_original_item_subtotal - * - raw_original_item_tax_total - * - raw_item_total - * - raw_item_subtotal - * - raw_item_tax_total - * - raw_original_total - * - raw_original_subtotal - * - raw_original_tax_total - * - raw_total - * - raw_subtotal - * - raw_tax_total - * - raw_discount_total - * - raw_discount_tax_total - * - raw_gift_card_total - * - raw_gift_card_tax_total - * - raw_shipping_total - * - raw_shipping_subtotal - * - raw_shipping_tax_total - * - raw_original_shipping_total - * - raw_original_shipping_subtotal - * - raw_original_shipping_tax_total - * properties: - * id: - * type: string - * title: id - * description: The order preview's ID. - * version: - * type: number - * title: version - * description: The order preview's version. - * order_change: - * $ref: "#/components/schemas/OrderChange" - * status: - * type: string - * enum: - * - canceled - * - requires_action - * - pending - * - completed - * - draft - * - archived - * region_id: - * type: string - * title: region_id - * description: The order preview's region id. - * customer_id: - * type: string - * title: customer_id - * description: The order preview's customer id. - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The order preview's sales channel id. - * email: - * type: string - * title: email - * description: The order preview's email. - * format: email - * currency_code: - * type: string - * title: currency_code - * description: The order preview's currency code. - * shipping_address: - * $ref: "#/components/schemas/OrderAddress" - * billing_address: - * $ref: "#/components/schemas/OrderAddress" - * items: - * type: array - * description: The order preview's items. - * items: - * $ref: "#/components/schemas/OrderLineItem" - * shipping_methods: - * type: array - * description: The order preview's shipping methods. - * items: - * $ref: "#/components/schemas/OrderShippingMethod" - * transactions: - * type: array - * description: The order preview's transactions. - * items: - * $ref: "#/components/schemas/OrderTransaction" - * summary: - * type: object - * description: The order preview's summary. - * required: - * - total - * - subtotal - * - total_tax - * - ordered_total - * - fulfilled_total - * - returned_total - * - return_request_total - * - write_off_total - * - projected_total - * - net_total - * - net_subtotal - * - net_total_tax - * - balance - * - paid_total - * - refunded_total - * properties: - * total: - * oneOf: - * - type: string - * title: total - * description: The summary's total. - * - type: number - * title: total - * description: The summary's total. - * - type: string - * title: total - * description: The summary's total. - * - type: object - * description: The summary's total. - * x-schemaName: IBigNumber - * subtotal: - * oneOf: - * - type: string - * title: subtotal - * description: The summary's subtotal. - * - type: number - * title: subtotal - * description: The summary's subtotal. - * - type: string - * title: subtotal - * description: The summary's subtotal. - * - type: object - * description: The summary's subtotal. - * x-schemaName: IBigNumber - * total_tax: - * oneOf: - * - type: string - * title: total_tax - * description: The summary's total tax. - * - type: number - * title: total_tax - * description: The summary's total tax. - * - type: string - * title: total_tax - * description: The summary's total tax. - * - type: object - * description: The summary's total tax. - * x-schemaName: IBigNumber - * ordered_total: - * oneOf: - * - type: string - * title: ordered_total - * description: The summary's ordered total. - * - type: number - * title: ordered_total - * description: The summary's ordered total. - * - type: string - * title: ordered_total - * description: The summary's ordered total. - * - type: object - * description: The summary's ordered total. - * x-schemaName: IBigNumber - * fulfilled_total: - * oneOf: - * - type: string - * title: fulfilled_total - * description: The summary's fulfilled total. - * - type: number - * title: fulfilled_total - * description: The summary's fulfilled total. - * - type: string - * title: fulfilled_total - * description: The summary's fulfilled total. - * - type: object - * description: The summary's fulfilled total. - * x-schemaName: IBigNumber - * returned_total: - * oneOf: - * - type: string - * title: returned_total - * description: The summary's returned total. - * - type: number - * title: returned_total - * description: The summary's returned total. - * - type: string - * title: returned_total - * description: The summary's returned total. - * - type: object - * description: The summary's returned total. - * x-schemaName: IBigNumber - * return_request_total: - * oneOf: - * - type: string - * title: return_request_total - * description: The summary's return request total. - * - type: number - * title: return_request_total - * description: The summary's return request total. - * - type: string - * title: return_request_total - * description: The summary's return request total. - * - type: object - * description: The summary's return request total. - * x-schemaName: IBigNumber - * write_off_total: - * oneOf: - * - type: string - * title: write_off_total - * description: The summary's write off total. - * - type: number - * title: write_off_total - * description: The summary's write off total. - * - type: string - * title: write_off_total - * description: The summary's write off total. - * - type: object - * description: The summary's write off total. - * x-schemaName: IBigNumber - * projected_total: - * oneOf: - * - type: string - * title: projected_total - * description: The summary's projected total. - * - type: number - * title: projected_total - * description: The summary's projected total. - * - type: string - * title: projected_total - * description: The summary's projected total. - * - type: object - * description: The summary's projected total. - * x-schemaName: IBigNumber - * net_total: - * oneOf: - * - type: string - * title: net_total - * description: The summary's net total. - * - type: number - * title: net_total - * description: The summary's net total. - * - type: string - * title: net_total - * description: The summary's net total. - * - type: object - * description: The summary's net total. - * x-schemaName: IBigNumber - * net_subtotal: - * oneOf: - * - type: string - * title: net_subtotal - * description: The summary's net subtotal. - * - type: number - * title: net_subtotal - * description: The summary's net subtotal. - * - type: string - * title: net_subtotal - * description: The summary's net subtotal. - * - type: object - * description: The summary's net subtotal. - * x-schemaName: IBigNumber - * net_total_tax: - * oneOf: - * - type: string - * title: net_total_tax - * description: The summary's net total tax. - * - type: number - * title: net_total_tax - * description: The summary's net total tax. - * - type: string - * title: net_total_tax - * description: The summary's net total tax. - * - type: object - * description: The summary's net total tax. - * x-schemaName: IBigNumber - * balance: - * oneOf: - * - type: string - * title: balance - * description: The summary's balance. - * - type: number - * title: balance - * description: The summary's balance. - * - type: string - * title: balance - * description: The summary's balance. - * - type: object - * description: The summary's balance. - * x-schemaName: IBigNumber - * paid_total: - * oneOf: - * - type: string - * title: paid_total - * description: The summary's paid total. - * - type: number - * title: paid_total - * description: The summary's paid total. - * - type: string - * title: paid_total - * description: The summary's paid total. - * - type: object - * description: The summary's paid total. - * x-schemaName: IBigNumber - * refunded_total: - * oneOf: - * - type: string - * title: refunded_total - * description: The summary's refunded total. - * - type: number - * title: refunded_total - * description: The summary's refunded total. - * - type: string - * title: refunded_total - * description: The summary's refunded total. - * - type: object - * description: The summary's refunded total. - * x-schemaName: IBigNumber - * metadata: - * type: object - * description: The order preview's metadata. - * canceled_at: - * oneOf: - * - type: string - * title: canceled_at - * description: The order preview's canceled at. - * - type: string - * title: canceled_at - * description: The order preview's canceled at. - * format: date-time - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The order preview's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The order preview's updated at. - * original_item_total: - * oneOf: - * - type: string - * title: original_item_total - * description: The order preview's original item total. - * - type: number - * title: original_item_total - * description: The order preview's original item total. - * - type: string - * title: original_item_total - * description: The order preview's original item total. - * - $ref: "#/components/schemas/IBigNumber" - * original_item_subtotal: - * oneOf: - * - type: string - * title: original_item_subtotal - * description: The order preview's original item subtotal. - * - type: number - * title: original_item_subtotal - * description: The order preview's original item subtotal. - * - type: string - * title: original_item_subtotal - * description: The order preview's original item subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * original_item_tax_total: - * oneOf: - * - type: string - * title: original_item_tax_total - * description: The order preview's original item tax total. - * - type: number - * title: original_item_tax_total - * description: The order preview's original item tax total. - * - type: string - * title: original_item_tax_total - * description: The order preview's original item tax total. - * - $ref: "#/components/schemas/IBigNumber" - * item_total: - * oneOf: - * - type: string - * title: item_total - * description: The order preview's item total. - * - type: number - * title: item_total - * description: The order preview's item total. - * - type: string - * title: item_total - * description: The order preview's item total. - * - $ref: "#/components/schemas/IBigNumber" - * item_subtotal: - * oneOf: - * - type: string - * title: item_subtotal - * description: The order preview's item subtotal. - * - type: number - * title: item_subtotal - * description: The order preview's item subtotal. - * - type: string - * title: item_subtotal - * description: The order preview's item subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * item_tax_total: - * oneOf: - * - type: string - * title: item_tax_total - * description: The order preview's item tax total. - * - type: number - * title: item_tax_total - * description: The order preview's item tax total. - * - type: string - * title: item_tax_total - * description: The order preview's item tax total. - * - $ref: "#/components/schemas/IBigNumber" - * original_total: - * oneOf: - * - type: string - * title: original_total - * description: The order preview's original total. - * - type: number - * title: original_total - * description: The order preview's original total. - * - type: string - * title: original_total - * description: The order preview's original total. - * - $ref: "#/components/schemas/IBigNumber" - * original_subtotal: - * oneOf: - * - type: string - * title: original_subtotal - * description: The order preview's original subtotal. - * - type: number - * title: original_subtotal - * description: The order preview's original subtotal. - * - type: string - * title: original_subtotal - * description: The order preview's original subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * original_tax_total: - * oneOf: - * - type: string - * title: original_tax_total - * description: The order preview's original tax total. - * - type: number - * title: original_tax_total - * description: The order preview's original tax total. - * - type: string - * title: original_tax_total - * description: The order preview's original tax total. - * - $ref: "#/components/schemas/IBigNumber" - * total: - * oneOf: - * - type: string - * title: total - * description: The order preview's total. - * - type: number - * title: total - * description: The order preview's total. - * - type: string - * title: total - * description: The order preview's total. - * - $ref: "#/components/schemas/IBigNumber" - * subtotal: - * oneOf: - * - type: string - * title: subtotal - * description: The order preview's subtotal. - * - type: number - * title: subtotal - * description: The order preview's subtotal. - * - type: string - * title: subtotal - * description: The order preview's subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * tax_total: - * oneOf: - * - type: string - * title: tax_total - * description: The order preview's tax total. - * - type: number - * title: tax_total - * description: The order preview's tax total. - * - type: string - * title: tax_total - * description: The order preview's tax total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_total: - * oneOf: - * - type: string - * title: discount_total - * description: The order preview's discount total. - * - type: number - * title: discount_total - * description: The order preview's discount total. - * - type: string - * title: discount_total - * description: The order preview's discount total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_tax_total: - * oneOf: - * - type: string - * title: discount_tax_total - * description: The order preview's discount tax total. - * - type: number - * title: discount_tax_total - * description: The order preview's discount tax total. - * - type: string - * title: discount_tax_total - * description: The order preview's discount tax total. - * - $ref: "#/components/schemas/IBigNumber" - * gift_card_total: - * oneOf: - * - type: string - * title: gift_card_total - * description: The order preview's gift card total. - * - type: number - * title: gift_card_total - * description: The order preview's gift card total. - * - type: string - * title: gift_card_total - * description: The order preview's gift card total. - * - $ref: "#/components/schemas/IBigNumber" - * gift_card_tax_total: - * oneOf: - * - type: string - * title: gift_card_tax_total - * description: The order preview's gift card tax total. - * - type: number - * title: gift_card_tax_total - * description: The order preview's gift card tax total. - * - type: string - * title: gift_card_tax_total - * description: The order preview's gift card tax total. - * - $ref: "#/components/schemas/IBigNumber" - * shipping_total: - * oneOf: - * - type: string - * title: shipping_total - * description: The order preview's shipping total. - * - type: number - * title: shipping_total - * description: The order preview's shipping total. - * - type: string - * title: shipping_total - * description: The order preview's shipping total. - * - $ref: "#/components/schemas/IBigNumber" - * shipping_subtotal: - * oneOf: - * - type: string - * title: shipping_subtotal - * description: The order preview's shipping subtotal. - * - type: number - * title: shipping_subtotal - * description: The order preview's shipping subtotal. - * - type: string - * title: shipping_subtotal - * description: The order preview's shipping subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * shipping_tax_total: - * oneOf: - * - type: string - * title: shipping_tax_total - * description: The order preview's shipping tax total. - * - type: number - * title: shipping_tax_total - * description: The order preview's shipping tax total. - * - type: string - * title: shipping_tax_total - * description: The order preview's shipping tax total. - * - $ref: "#/components/schemas/IBigNumber" - * original_shipping_total: - * oneOf: - * - type: string - * title: original_shipping_total - * description: The order preview's original shipping total. - * - type: number - * title: original_shipping_total - * description: The order preview's original shipping total. - * - type: string - * title: original_shipping_total - * description: The order preview's original shipping total. - * - $ref: "#/components/schemas/IBigNumber" - * original_shipping_subtotal: - * oneOf: - * - type: string - * title: original_shipping_subtotal - * description: The order preview's original shipping subtotal. - * - type: number - * title: original_shipping_subtotal - * description: The order preview's original shipping subtotal. - * - type: string - * title: original_shipping_subtotal - * description: The order preview's original shipping subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * original_shipping_tax_total: - * oneOf: - * - type: string - * title: original_shipping_tax_total - * description: The order preview's original shipping tax total. - * - type: number - * title: original_shipping_tax_total - * description: The order preview's original shipping tax total. - * - type: string - * title: original_shipping_tax_total - * description: The order preview's original shipping tax total. - * - $ref: "#/components/schemas/IBigNumber" - * raw_original_item_total: - * type: object - * description: The order preview's raw original item total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original item total's value. - * - type: number - * title: value - * description: The raw original item total's value. - * raw_original_item_subtotal: - * type: object - * description: The order preview's raw original item subtotal. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original item subtotal's value. - * - type: number - * title: value - * description: The raw original item subtotal's value. - * raw_original_item_tax_total: - * type: object - * description: The order preview's raw original item tax total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original item tax total's value. - * - type: number - * title: value - * description: The raw original item tax total's value. - * raw_item_total: - * type: object - * description: The order preview's raw item total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw item total's value. - * - type: number - * title: value - * description: The raw item total's value. - * raw_item_subtotal: - * type: object - * description: The order preview's raw item subtotal. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw item subtotal's value. - * - type: number - * title: value - * description: The raw item subtotal's value. - * raw_item_tax_total: - * type: object - * description: The order preview's raw item tax total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw item tax total's value. - * - type: number - * title: value - * description: The raw item tax total's value. - * raw_original_total: - * type: object - * description: The order preview's raw original total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original total's value. - * - type: number - * title: value - * description: The raw original total's value. - * raw_original_subtotal: - * type: object - * description: The order preview's raw original subtotal. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original subtotal's value. - * - type: number - * title: value - * description: The raw original subtotal's value. - * raw_original_tax_total: - * type: object - * description: The order preview's raw original tax total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original tax total's value. - * - type: number - * title: value - * description: The raw original tax total's value. - * raw_total: - * type: object - * description: The order preview's raw total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw total's value. - * - type: number - * title: value - * description: The raw total's value. - * raw_subtotal: - * type: object - * description: The order preview's raw subtotal. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw subtotal's value. - * - type: number - * title: value - * description: The raw subtotal's value. - * raw_tax_total: - * type: object - * description: The order preview's raw tax total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw tax total's value. - * - type: number - * title: value - * description: The raw tax total's value. - * raw_discount_total: - * type: object - * description: The order preview's raw discount total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw discount total's value. - * - type: number - * title: value - * description: The raw discount total's value. - * raw_discount_tax_total: - * type: object - * description: The order preview's raw discount tax total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw discount tax total's value. - * - type: number - * title: value - * description: The raw discount tax total's value. - * raw_gift_card_total: - * type: object - * description: The order preview's raw gift card total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw gift card total's value. - * - type: number - * title: value - * description: The raw gift card total's value. - * raw_gift_card_tax_total: - * type: object - * description: The order preview's raw gift card tax total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw gift card tax total's value. - * - type: number - * title: value - * description: The raw gift card tax total's value. - * raw_shipping_total: - * type: object - * description: The order preview's raw shipping total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw shipping total's value. - * - type: number - * title: value - * description: The raw shipping total's value. - * raw_shipping_subtotal: - * type: object - * description: The order preview's raw shipping subtotal. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw shipping subtotal's value. - * - type: number - * title: value - * description: The raw shipping subtotal's value. - * raw_shipping_tax_total: - * type: object - * description: The order preview's raw shipping tax total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw shipping tax total's value. - * - type: number - * title: value - * description: The raw shipping tax total's value. - * raw_original_shipping_total: - * type: object - * description: The order preview's raw original shipping total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original shipping total's value. - * - type: number - * title: value - * description: The raw original shipping total's value. - * raw_original_shipping_subtotal: - * type: object - * description: The order preview's raw original shipping subtotal. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original shipping subtotal's value. - * - type: number - * title: value - * description: The raw original shipping subtotal's value. - * raw_original_shipping_tax_total: - * type: object - * description: The order preview's raw original shipping tax total. - * required: - * - value - * properties: - * value: - * oneOf: - * - type: string - * title: value - * description: The raw original shipping tax total's value. - * - type: number - * title: value - * description: The raw original shipping tax total's value. * */ diff --git a/www/utils/generated/oas-output/schemas/OrderLineItem.ts b/www/utils/generated/oas-output/schemas/OrderLineItem.ts deleted file mode 100644 index 13d7a88890..0000000000 --- a/www/utils/generated/oas-output/schemas/OrderLineItem.ts +++ /dev/null @@ -1,364 +0,0 @@ -/** - * @schema OrderLineItem - * type: object - * description: The item's items. - * x-schemaName: OrderLineItem - * required: - * - id - * - title - * - requires_shipping - * - is_discountable - * - is_tax_inclusive - * - unit_price - * - raw_unit_price - * - quantity - * - raw_quantity - * - detail - * - created_at - * - updated_at - * - 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 - * - raw_original_total - * - raw_original_subtotal - * - raw_original_tax_total - * - raw_item_total - * - raw_item_subtotal - * - raw_item_tax_total - * - raw_total - * - raw_subtotal - * - raw_tax_total - * - raw_discount_total - * - raw_discount_tax_total - * - raw_refundable_total - * - raw_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 item's thumbnail. - * variant_id: - * type: string - * title: variant_id - * description: The item's variant id. - * product_id: - * type: string - * title: product_id - * description: The item's product id. - * product_title: - * type: string - * title: product_title - * description: The item's product title. - * product_description: - * type: string - * title: product_description - * description: The item's product description. - * product_subtitle: - * type: string - * title: product_subtitle - * description: The item's product subtitle. - * product_type: - * type: string - * title: product_type - * description: The item's product type. - * product_collection: - * type: string - * title: product_collection - * description: The item's product collection. - * product_handle: - * type: string - * title: product_handle - * description: The item's product handle. - * variant_sku: - * type: string - * title: variant_sku - * description: The item's variant sku. - * variant_barcode: - * type: string - * title: variant_barcode - * description: The item's variant barcode. - * variant_title: - * type: string - * title: variant_title - * description: The item's variant title. - * variant_option_values: - * type: object - * description: The item's variant option values. - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: The item's requires shipping. - * is_discountable: - * type: boolean - * title: is_discountable - * description: The item's is discountable. - * is_tax_inclusive: - * type: boolean - * title: is_tax_inclusive - * description: The item's is tax inclusive. - * compare_at_unit_price: - * type: number - * title: compare_at_unit_price - * description: The item's compare at unit price. - * raw_compare_at_unit_price: - * type: object - * description: The item's raw compare at unit price. - * unit_price: - * type: number - * title: unit_price - * description: The item's unit price. - * raw_unit_price: - * type: object - * description: The item's raw unit price. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * raw_quantity: - * type: object - * description: The item's raw quantity. - * tax_lines: - * type: array - * description: The item's tax lines. - * items: - * $ref: "#/components/schemas/OrderLineItemTaxLine" - * adjustments: - * type: array - * description: The item's adjustments. - * items: - * $ref: "#/components/schemas/OrderLineItemAdjustment" - * detail: - * $ref: "#/components/schemas/OrderItem" - * created_at: - * type: string - * title: created_at - * description: The item's created at. - * format: date-time - * updated_at: - * type: string - * title: updated_at - * description: The item's updated at. - * format: date-time - * metadata: - * type: object - * description: The item's metadata. - * original_total: - * oneOf: - * - type: string - * title: original_total - * description: The item's original total. - * - type: number - * title: original_total - * description: The item's original total. - * - type: string - * title: original_total - * description: The item's original total. - * - $ref: "#/components/schemas/IBigNumber" - * original_subtotal: - * oneOf: - * - type: string - * title: original_subtotal - * description: The item's original subtotal. - * - type: number - * title: original_subtotal - * description: The item's original subtotal. - * - type: string - * title: original_subtotal - * description: The item's original subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * original_tax_total: - * oneOf: - * - type: string - * title: original_tax_total - * description: The item's original tax total. - * - type: number - * title: original_tax_total - * description: The item's original tax total. - * - type: string - * title: original_tax_total - * description: The item's original tax total. - * - $ref: "#/components/schemas/IBigNumber" - * item_total: - * oneOf: - * - type: string - * title: item_total - * description: The item's item total. - * - type: number - * title: item_total - * description: The item's item total. - * - type: string - * title: item_total - * description: The item's item total. - * - $ref: "#/components/schemas/IBigNumber" - * item_subtotal: - * oneOf: - * - type: string - * title: item_subtotal - * description: The item's item subtotal. - * - type: number - * title: item_subtotal - * description: The item's item subtotal. - * - type: string - * title: item_subtotal - * description: The item's item subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * item_tax_total: - * oneOf: - * - type: string - * title: item_tax_total - * description: The item's item tax total. - * - type: number - * title: item_tax_total - * description: The item's item tax total. - * - type: string - * title: item_tax_total - * description: The item's item tax total. - * - $ref: "#/components/schemas/IBigNumber" - * total: - * oneOf: - * - type: string - * title: total - * description: The item's total. - * - type: number - * title: total - * description: The item's total. - * - type: string - * title: total - * description: The item's total. - * - $ref: "#/components/schemas/IBigNumber" - * subtotal: - * oneOf: - * - type: string - * title: subtotal - * description: The item's subtotal. - * - type: number - * title: subtotal - * description: The item's subtotal. - * - type: string - * title: subtotal - * description: The item's subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * tax_total: - * oneOf: - * - type: string - * title: tax_total - * description: The item's tax total. - * - type: number - * title: tax_total - * description: The item's tax total. - * - type: string - * title: tax_total - * description: The item's tax total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_total: - * oneOf: - * - type: string - * title: discount_total - * description: The item's discount total. - * - type: number - * title: discount_total - * description: The item's discount total. - * - type: string - * title: discount_total - * description: The item's discount total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_tax_total: - * oneOf: - * - type: string - * title: discount_tax_total - * description: The item's discount tax total. - * - type: number - * title: discount_tax_total - * description: The item's discount tax total. - * - type: string - * title: discount_tax_total - * description: The item's discount tax total. - * - $ref: "#/components/schemas/IBigNumber" - * refundable_total: - * oneOf: - * - type: string - * title: refundable_total - * description: The item's refundable total. - * - type: number - * title: refundable_total - * description: The item's refundable total. - * - type: string - * title: refundable_total - * description: The item's refundable total. - * - $ref: "#/components/schemas/IBigNumber" - * refundable_total_per_unit: - * oneOf: - * - type: string - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - type: number - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - type: string - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - $ref: "#/components/schemas/IBigNumber" - * raw_original_total: - * type: object - * description: The item's raw original total. - * raw_original_subtotal: - * type: object - * description: The item's raw original subtotal. - * raw_original_tax_total: - * type: object - * description: The item's raw original tax total. - * raw_item_total: - * type: object - * description: The item's raw item total. - * raw_item_subtotal: - * type: object - * description: The item's raw item subtotal. - * raw_item_tax_total: - * type: object - * description: The item's raw item tax total. - * raw_total: - * type: object - * description: The item's raw total. - * raw_subtotal: - * type: object - * description: The item's raw subtotal. - * raw_tax_total: - * type: object - * description: The item's raw tax total. - * raw_discount_total: - * type: object - * description: The item's raw discount total. - * raw_discount_tax_total: - * type: object - * description: The item's raw discount tax total. - * raw_refundable_total: - * type: object - * description: The item's raw refundable total. - * raw_refundable_total_per_unit: - * type: object - * description: The item's raw refundable total per unit. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/OrderPreview.ts b/www/utils/generated/oas-output/schemas/OrderPreview.ts new file mode 100644 index 0000000000..715cae567b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderPreview.ts @@ -0,0 +1,1535 @@ +/** + * @schema OrderPreview + * type: object + * description: The exchange's order preview. + * x-schemaName: OrderPreview + * required: + * - order_change + * - status + * - currency_code + * - id + * - version + * - 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 + * - raw_original_item_total + * - raw_original_item_subtotal + * - raw_original_item_tax_total + * - raw_item_total + * - raw_item_subtotal + * - raw_item_tax_total + * - raw_original_total + * - raw_original_subtotal + * - raw_original_tax_total + * - raw_total + * - raw_subtotal + * - raw_tax_total + * - raw_discount_total + * - raw_discount_tax_total + * - raw_gift_card_total + * - raw_gift_card_tax_total + * - raw_shipping_total + * - raw_shipping_subtotal + * - raw_shipping_tax_total + * - raw_original_shipping_total + * - raw_original_shipping_subtotal + * - raw_original_shipping_tax_total + * properties: + * order_change: + * $ref: "#/components/schemas/OrderChange" + * items: + * type: array + * description: The order preview's items. + * items: + * allOf: + * - type: object + * description: The item's items. + * x-schemaName: OrderLineItem + * required: + * - id + * - title + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - raw_unit_price + * - quantity + * - raw_quantity + * - detail + * - created_at + * - updated_at + * - 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 + * - raw_original_total + * - raw_original_subtotal + * - raw_original_tax_total + * - raw_item_total + * - raw_item_subtotal + * - raw_item_tax_total + * - raw_total + * - raw_subtotal + * - raw_tax_total + * - raw_discount_total + * - raw_discount_tax_total + * - raw_refundable_total + * - raw_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 item's thumbnail. + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * product_id: + * type: string + * title: product_id + * description: The item's product id. + * product_title: + * type: string + * title: product_title + * description: The item's product title. + * product_description: + * type: string + * title: product_description + * description: The item's product description. + * product_subtitle: + * type: string + * title: product_subtitle + * description: The item's product subtitle. + * product_type: + * type: string + * title: product_type + * description: The item's product type. + * product_collection: + * type: string + * title: product_collection + * description: The item's product collection. + * product_handle: + * type: string + * title: product_handle + * description: The item's product handle. + * variant_sku: + * type: string + * title: variant_sku + * description: The item's variant sku. + * variant_barcode: + * type: string + * title: variant_barcode + * description: The item's variant barcode. + * variant_title: + * type: string + * title: variant_title + * description: The item's variant title. + * variant_option_values: + * type: object + * description: The item's variant option values. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The item's requires shipping. + * is_discountable: + * type: boolean + * title: is_discountable + * description: The item's is discountable. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The item's is tax inclusive. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The item's compare at unit price. + * raw_compare_at_unit_price: + * type: object + * description: The item's raw compare at unit price. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * raw_unit_price: + * type: object + * description: The item's raw unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * raw_quantity: + * type: object + * description: The item's raw quantity. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * $ref: "#/components/schemas/OrderLineItemTaxLine" + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * $ref: "#/components/schemas/OrderLineItemAdjustment" + * detail: + * $ref: "#/components/schemas/OrderItem" + * created_at: + * type: string + * title: created_at + * description: The item's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The item's updated at. + * format: date-time + * metadata: + * type: object + * description: The item's metadata. + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The item's original total. + * - type: number + * title: original_total + * description: The item's original total. + * - type: string + * title: original_total + * description: The item's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The item's original subtotal. + * - type: number + * title: original_subtotal + * description: The item's original subtotal. + * - type: string + * title: original_subtotal + * description: The item's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The item's original tax total. + * - type: number + * title: original_tax_total + * description: The item's original tax total. + * - type: string + * title: original_tax_total + * description: The item's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * item_total: + * oneOf: + * - type: string + * title: item_total + * description: The item's item total. + * - type: number + * title: item_total + * description: The item's item total. + * - type: string + * title: item_total + * description: The item's item total. + * - $ref: "#/components/schemas/IBigNumber" + * item_subtotal: + * oneOf: + * - type: string + * title: item_subtotal + * description: The item's item subtotal. + * - type: number + * title: item_subtotal + * description: The item's item subtotal. + * - type: string + * title: item_subtotal + * description: The item's item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * item_tax_total: + * oneOf: + * - type: string + * title: item_tax_total + * description: The item's item tax total. + * - type: number + * title: item_tax_total + * description: The item's item tax total. + * - type: string + * title: item_tax_total + * description: The item's item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The item's total. + * - type: number + * title: total + * description: The item's total. + * - type: string + * title: total + * description: The item's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The item's subtotal. + * - type: number + * title: subtotal + * description: The item's subtotal. + * - type: string + * title: subtotal + * description: The item's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The item's tax total. + * - type: number + * title: tax_total + * description: The item's tax total. + * - type: string + * title: tax_total + * description: The item's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The item's discount total. + * - type: number + * title: discount_total + * description: The item's discount total. + * - type: string + * title: discount_total + * description: The item's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The item's discount tax total. + * - type: number + * title: discount_tax_total + * description: The item's discount tax total. + * - type: string + * title: discount_tax_total + * description: The item's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * refundable_total: + * oneOf: + * - type: string + * title: refundable_total + * description: The item's refundable total. + * - type: number + * title: refundable_total + * description: The item's refundable total. + * - type: string + * title: refundable_total + * description: The item's refundable total. + * - $ref: "#/components/schemas/IBigNumber" + * refundable_total_per_unit: + * oneOf: + * - type: string + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * - type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * - type: string + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * - $ref: "#/components/schemas/IBigNumber" + * raw_original_total: + * type: object + * description: The item's raw original total. + * raw_original_subtotal: + * type: object + * description: The item's raw original subtotal. + * raw_original_tax_total: + * type: object + * description: The item's raw original tax total. + * raw_item_total: + * type: object + * description: The item's raw item total. + * raw_item_subtotal: + * type: object + * description: The item's raw item subtotal. + * raw_item_tax_total: + * type: object + * description: The item's raw item tax total. + * raw_total: + * type: object + * description: The item's raw total. + * raw_subtotal: + * type: object + * description: The item's raw subtotal. + * raw_tax_total: + * type: object + * description: The item's raw tax total. + * raw_discount_total: + * type: object + * description: The item's raw discount total. + * raw_discount_tax_total: + * type: object + * description: The item's raw discount tax total. + * raw_refundable_total: + * type: object + * description: The item's raw refundable total. + * raw_refundable_total_per_unit: + * type: object + * description: The item's raw refundable total per unit. + * - type: object + * description: The item's items. + * properties: + * actions: + * type: array + * description: The item's actions. + * items: + * type: object + * description: The action's actions. + * x-schemaName: OrderChangeAction + * shipping_methods: + * type: array + * description: The order preview's shipping methods. + * items: + * allOf: + * - type: object + * description: The shipping method's shipping methods. + * x-schemaName: OrderShippingMethod + * required: + * - id + * - order_id + * - name + * - amount + * - raw_amount + * - is_tax_inclusive + * - created_at + * - updated_at + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - raw_original_total + * - raw_original_subtotal + * - raw_original_tax_total + * - raw_total + * - raw_subtotal + * - raw_tax_total + * - raw_discount_total + * - raw_discount_tax_total + * properties: + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * oneOf: + * - type: string + * title: amount + * description: The shipping method's amount. + * - type: number + * title: amount + * description: The shipping method's amount. + * - type: string + * title: amount + * description: The shipping method's amount. + * - $ref: "#/components/schemas/IBigNumber" + * raw_amount: + * type: object + * description: The shipping method's raw amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * $ref: "#/components/schemas/OrderShippingMethodTaxLine" + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * $ref: "#/components/schemas/OrderShippingMethodAdjustment" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The shipping method's original total. + * - type: number + * title: original_total + * description: The shipping method's original total. + * - type: string + * title: original_total + * description: The shipping method's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * - type: string + * title: original_subtotal + * description: The shipping method's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * - type: string + * title: original_tax_total + * description: The shipping method's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The shipping method's total. + * - type: number + * title: total + * description: The shipping method's total. + * - type: string + * title: total + * description: The shipping method's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - type: number + * title: subtotal + * description: The shipping method's subtotal. + * - type: string + * title: subtotal + * description: The shipping method's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - type: number + * title: tax_total + * description: The shipping method's tax total. + * - type: string + * title: tax_total + * description: The shipping method's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - type: number + * title: discount_total + * description: The shipping method's discount total. + * - type: string + * title: discount_total + * description: The shipping method's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The shipping method's discount tax total. + * - type: number + * title: 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" + * raw_original_total: + * type: object + * description: The shipping method's raw original total. + * raw_original_subtotal: + * type: object + * description: The shipping method's raw original subtotal. + * raw_original_tax_total: + * type: object + * description: The shipping method's raw original tax total. + * raw_total: + * type: object + * description: The shipping method's raw total. + * raw_subtotal: + * type: object + * description: The shipping method's raw subtotal. + * raw_tax_total: + * type: object + * description: The shipping method's raw tax total. + * raw_discount_total: + * type: object + * description: The shipping method's raw discount total. + * raw_discount_tax_total: + * type: object + * description: The shipping method's raw discount tax total. + * - type: object + * description: The shipping method's shipping methods. + * properties: + * actions: + * type: array + * description: The shipping method's actions. + * items: + * type: object + * description: The action's actions. + * x-schemaName: OrderChangeAction + * status: + * type: string + * enum: + * - canceled + * - requires_action + * - pending + * - completed + * - draft + * - archived + * currency_code: + * type: string + * title: currency_code + * description: The order preview's currency code. + * id: + * type: string + * title: id + * description: The order preview's ID. + * version: + * type: number + * title: version + * description: The order preview's version. + * region_id: + * type: string + * title: region_id + * description: The order preview's region id. + * customer_id: + * type: string + * title: customer_id + * description: The order preview's customer id. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The order preview's sales channel id. + * email: + * type: string + * title: email + * description: The order preview's email. + * format: email + * shipping_address: + * $ref: "#/components/schemas/OrderAddress" + * billing_address: + * $ref: "#/components/schemas/OrderAddress" + * transactions: + * type: array + * description: The order preview's transactions. + * items: + * $ref: "#/components/schemas/OrderTransaction" + * summary: + * type: object + * description: The order preview's summary. + * required: + * - total + * - subtotal + * - total_tax + * - ordered_total + * - fulfilled_total + * - returned_total + * - return_request_total + * - write_off_total + * - projected_total + * - net_total + * - net_subtotal + * - net_total_tax + * - balance + * - paid_total + * - refunded_total + * properties: + * total: + * oneOf: + * - type: string + * title: total + * description: The summary's total. + * - type: number + * title: total + * description: The summary's total. + * - type: string + * title: total + * description: The summary's total. + * - type: object + * description: The summary's total. + * x-schemaName: IBigNumber + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The summary's subtotal. + * - type: number + * title: subtotal + * description: The summary's subtotal. + * - type: string + * title: subtotal + * description: The summary's subtotal. + * - type: object + * description: The summary's subtotal. + * x-schemaName: IBigNumber + * total_tax: + * oneOf: + * - type: string + * title: total_tax + * description: The summary's total tax. + * - type: number + * title: total_tax + * description: The summary's total tax. + * - type: string + * title: total_tax + * description: The summary's total tax. + * - type: object + * description: The summary's total tax. + * x-schemaName: IBigNumber + * ordered_total: + * oneOf: + * - type: string + * title: ordered_total + * description: The summary's ordered total. + * - type: number + * title: ordered_total + * description: The summary's ordered total. + * - type: string + * title: ordered_total + * description: The summary's ordered total. + * - type: object + * description: The summary's ordered total. + * x-schemaName: IBigNumber + * fulfilled_total: + * oneOf: + * - type: string + * title: fulfilled_total + * description: The summary's fulfilled total. + * - type: number + * title: fulfilled_total + * description: The summary's fulfilled total. + * - type: string + * title: fulfilled_total + * description: The summary's fulfilled total. + * - type: object + * description: The summary's fulfilled total. + * x-schemaName: IBigNumber + * returned_total: + * oneOf: + * - type: string + * title: returned_total + * description: The summary's returned total. + * - type: number + * title: returned_total + * description: The summary's returned total. + * - type: string + * title: returned_total + * description: The summary's returned total. + * - type: object + * description: The summary's returned total. + * x-schemaName: IBigNumber + * return_request_total: + * oneOf: + * - type: string + * title: return_request_total + * description: The summary's return request total. + * - type: number + * title: return_request_total + * description: The summary's return request total. + * - type: string + * title: return_request_total + * description: The summary's return request total. + * - type: object + * description: The summary's return request total. + * x-schemaName: IBigNumber + * write_off_total: + * oneOf: + * - type: string + * title: write_off_total + * description: The summary's write off total. + * - type: number + * title: write_off_total + * description: The summary's write off total. + * - type: string + * title: write_off_total + * description: The summary's write off total. + * - type: object + * description: The summary's write off total. + * x-schemaName: IBigNumber + * projected_total: + * oneOf: + * - type: string + * title: projected_total + * description: The summary's projected total. + * - type: number + * title: projected_total + * description: The summary's projected total. + * - type: string + * title: projected_total + * description: The summary's projected total. + * - type: object + * description: The summary's projected total. + * x-schemaName: IBigNumber + * net_total: + * oneOf: + * - type: string + * title: net_total + * description: The summary's net total. + * - type: number + * title: net_total + * description: The summary's net total. + * - type: string + * title: net_total + * description: The summary's net total. + * - type: object + * description: The summary's net total. + * x-schemaName: IBigNumber + * net_subtotal: + * oneOf: + * - type: string + * title: net_subtotal + * description: The summary's net subtotal. + * - type: number + * title: net_subtotal + * description: The summary's net subtotal. + * - type: string + * title: net_subtotal + * description: The summary's net subtotal. + * - type: object + * description: The summary's net subtotal. + * x-schemaName: IBigNumber + * net_total_tax: + * oneOf: + * - type: string + * title: net_total_tax + * description: The summary's net total tax. + * - type: number + * title: net_total_tax + * description: The summary's net total tax. + * - type: string + * title: net_total_tax + * description: The summary's net total tax. + * - type: object + * description: The summary's net total tax. + * x-schemaName: IBigNumber + * balance: + * oneOf: + * - type: string + * title: balance + * description: The summary's balance. + * - type: number + * title: balance + * description: The summary's balance. + * - type: string + * title: balance + * description: The summary's balance. + * - type: object + * description: The summary's balance. + * x-schemaName: IBigNumber + * paid_total: + * oneOf: + * - type: string + * title: paid_total + * description: The summary's paid total. + * - type: number + * title: paid_total + * description: The summary's paid total. + * - type: string + * title: paid_total + * description: The summary's paid total. + * - type: object + * description: The summary's paid total. + * x-schemaName: IBigNumber + * refunded_total: + * oneOf: + * - type: string + * title: refunded_total + * description: The summary's refunded total. + * - type: number + * title: refunded_total + * description: The summary's refunded total. + * - type: string + * title: refunded_total + * description: The summary's refunded total. + * - type: object + * description: The summary's refunded total. + * x-schemaName: IBigNumber + * metadata: + * type: object + * description: The order preview's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The order preview's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The order preview's updated at. + * original_item_total: + * oneOf: + * - type: string + * title: original_item_total + * description: The order preview's original item total. + * - type: number + * title: original_item_total + * description: The order preview's original item total. + * - type: string + * title: original_item_total + * description: The order preview's original item total. + * - $ref: "#/components/schemas/IBigNumber" + * original_item_subtotal: + * oneOf: + * - type: string + * title: original_item_subtotal + * description: The order preview's original item subtotal. + * - type: number + * title: original_item_subtotal + * description: The order preview's original item subtotal. + * - type: string + * title: original_item_subtotal + * description: The order preview's original item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_item_tax_total: + * oneOf: + * - type: string + * title: original_item_tax_total + * description: The order preview's original item tax total. + * - type: number + * title: original_item_tax_total + * description: The order preview's original item tax total. + * - type: string + * title: original_item_tax_total + * description: The order preview's original item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * item_total: + * oneOf: + * - type: string + * title: item_total + * description: The order preview's item total. + * - type: number + * title: item_total + * description: The order preview's item total. + * - type: string + * title: item_total + * description: The order preview's item total. + * - $ref: "#/components/schemas/IBigNumber" + * item_subtotal: + * oneOf: + * - type: string + * title: item_subtotal + * description: The order preview's item subtotal. + * - type: number + * title: item_subtotal + * description: The order preview's item subtotal. + * - type: string + * title: item_subtotal + * description: The order preview's item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * item_tax_total: + * oneOf: + * - type: string + * title: item_tax_total + * description: The order preview's item tax total. + * - type: number + * title: item_tax_total + * description: The order preview's item tax total. + * - type: string + * title: item_tax_total + * description: The order preview's item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The order preview's original total. + * - type: number + * title: original_total + * description: The order preview's original total. + * - type: string + * title: original_total + * description: The order preview's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The order preview's original subtotal. + * - type: number + * title: original_subtotal + * description: The order preview's original subtotal. + * - type: string + * title: original_subtotal + * description: The order preview's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The order preview's original tax total. + * - type: number + * title: original_tax_total + * description: The order preview's original tax total. + * - type: string + * title: original_tax_total + * description: The order preview's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The order preview's total. + * - type: number + * title: total + * description: The order preview's total. + * - type: string + * title: total + * description: The order preview's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The order preview's subtotal. + * - type: number + * title: subtotal + * description: The order preview's subtotal. + * - type: string + * title: subtotal + * description: The order preview's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The order preview's tax total. + * - type: number + * title: tax_total + * description: The order preview's tax total. + * - type: string + * title: tax_total + * description: The order preview's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The order preview's discount total. + * - type: number + * title: discount_total + * description: The order preview's discount total. + * - type: string + * title: discount_total + * description: The order preview's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The order preview's discount tax total. + * - type: number + * title: discount_tax_total + * description: The order preview's discount tax total. + * - type: string + * title: discount_tax_total + * description: The order preview's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * gift_card_total: + * oneOf: + * - type: string + * title: gift_card_total + * description: The order preview's gift card total. + * - type: number + * title: gift_card_total + * description: The order preview's gift card total. + * - type: string + * title: gift_card_total + * description: The order preview's gift card total. + * - $ref: "#/components/schemas/IBigNumber" + * gift_card_tax_total: + * oneOf: + * - type: string + * title: gift_card_tax_total + * description: The order preview's gift card tax total. + * - type: number + * title: gift_card_tax_total + * description: The order preview's gift card tax total. + * - type: string + * title: gift_card_tax_total + * description: The order preview's gift card tax total. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_total: + * oneOf: + * - type: string + * title: shipping_total + * description: The order preview's shipping total. + * - type: number + * title: shipping_total + * description: The order preview's shipping total. + * - type: string + * title: shipping_total + * description: The order preview's shipping total. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_subtotal: + * oneOf: + * - type: string + * title: shipping_subtotal + * description: The order preview's shipping subtotal. + * - type: number + * title: shipping_subtotal + * description: The order preview's shipping subtotal. + * - type: string + * title: shipping_subtotal + * description: The order preview's shipping subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * shipping_tax_total: + * oneOf: + * - type: string + * title: shipping_tax_total + * description: The order preview's shipping tax total. + * - type: number + * title: shipping_tax_total + * description: The order preview's shipping tax total. + * - type: string + * title: shipping_tax_total + * description: The order preview's shipping tax total. + * - $ref: "#/components/schemas/IBigNumber" + * original_shipping_total: + * oneOf: + * - type: string + * title: original_shipping_total + * description: The order preview's original shipping total. + * - type: number + * title: original_shipping_total + * description: The order preview's original shipping total. + * - type: string + * title: original_shipping_total + * description: The order preview's original shipping total. + * - $ref: "#/components/schemas/IBigNumber" + * original_shipping_subtotal: + * oneOf: + * - type: string + * title: original_shipping_subtotal + * description: The order preview's original shipping subtotal. + * - type: number + * title: original_shipping_subtotal + * description: The order preview's original shipping subtotal. + * - type: string + * title: original_shipping_subtotal + * description: The order preview's original shipping subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_shipping_tax_total: + * oneOf: + * - type: string + * title: original_shipping_tax_total + * description: The order preview's original shipping tax total. + * - type: number + * title: original_shipping_tax_total + * description: The order preview's original shipping tax total. + * - type: string + * title: original_shipping_tax_total + * description: The order preview's original shipping tax total. + * - $ref: "#/components/schemas/IBigNumber" + * canceled_at: + * oneOf: + * - type: string + * title: canceled_at + * description: The order preview's canceled at. + * - type: string + * title: canceled_at + * description: The order preview's canceled at. + * format: date-time + * raw_original_item_total: + * type: object + * description: The order preview's raw original item total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original item total's value. + * - type: number + * title: value + * description: The raw original item total's value. + * raw_original_item_subtotal: + * type: object + * description: The order preview's raw original item subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original item subtotal's value. + * - type: number + * title: value + * description: The raw original item subtotal's value. + * raw_original_item_tax_total: + * type: object + * description: The order preview's raw original item tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original item tax total's value. + * - type: number + * title: value + * description: The raw original item tax total's value. + * raw_item_total: + * type: object + * description: The order preview's raw item total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw item total's value. + * - type: number + * title: value + * description: The raw item total's value. + * raw_item_subtotal: + * type: object + * description: The order preview's raw item subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw item subtotal's value. + * - type: number + * title: value + * description: The raw item subtotal's value. + * raw_item_tax_total: + * type: object + * description: The order preview's raw item tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw item tax total's value. + * - type: number + * title: value + * description: The raw item tax total's value. + * raw_original_total: + * type: object + * description: The order preview's raw original total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original total's value. + * - type: number + * title: value + * description: The raw original total's value. + * raw_original_subtotal: + * type: object + * description: The order preview's raw original subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original subtotal's value. + * - type: number + * title: value + * description: The raw original subtotal's value. + * raw_original_tax_total: + * type: object + * description: The order preview's raw original tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original tax total's value. + * - type: number + * title: value + * description: The raw original tax total's value. + * raw_total: + * type: object + * description: The order preview's raw total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw total's value. + * - type: number + * title: value + * description: The raw total's value. + * raw_subtotal: + * type: object + * description: The order preview's raw subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw subtotal's value. + * - type: number + * title: value + * description: The raw subtotal's value. + * raw_tax_total: + * type: object + * description: The order preview's raw tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw tax total's value. + * - type: number + * title: value + * description: The raw tax total's value. + * raw_discount_total: + * type: object + * description: The order preview's raw discount total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw discount total's value. + * - type: number + * title: value + * description: The raw discount total's value. + * raw_discount_tax_total: + * type: object + * description: The order preview's raw discount tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw discount tax total's value. + * - type: number + * title: value + * description: The raw discount tax total's value. + * raw_gift_card_total: + * type: object + * description: The order preview's raw gift card total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw gift card total's value. + * - type: number + * title: value + * description: The raw gift card total's value. + * raw_gift_card_tax_total: + * type: object + * description: The order preview's raw gift card tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw gift card tax total's value. + * - type: number + * title: value + * description: The raw gift card tax total's value. + * raw_shipping_total: + * type: object + * description: The order preview's raw shipping total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw shipping total's value. + * - type: number + * title: value + * description: The raw shipping total's value. + * raw_shipping_subtotal: + * type: object + * description: The order preview's raw shipping subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw shipping subtotal's value. + * - type: number + * title: value + * description: The raw shipping subtotal's value. + * raw_shipping_tax_total: + * type: object + * description: The order preview's raw shipping tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw shipping tax total's value. + * - type: number + * title: value + * description: The raw shipping tax total's value. + * raw_original_shipping_total: + * type: object + * description: The order preview's raw original shipping total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original shipping total's value. + * - type: number + * title: value + * description: The raw original shipping total's value. + * raw_original_shipping_subtotal: + * type: object + * description: The order preview's raw original shipping subtotal. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original shipping subtotal's value. + * - type: number + * title: value + * description: The raw original shipping subtotal's value. + * raw_original_shipping_tax_total: + * type: object + * description: The order preview's raw original shipping tax total. + * required: + * - value + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw original shipping tax total's value. + * - type: number + * title: value + * description: The raw original shipping tax total's value. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts deleted file mode 100644 index fbde5bc8a1..0000000000 --- a/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts +++ /dev/null @@ -1,219 +0,0 @@ -/** - * @schema OrderShippingMethod - * type: object - * description: The shipping method's shipping methods. - * x-schemaName: OrderShippingMethod - * required: - * - id - * - order_id - * - name - * - amount - * - raw_amount - * - is_tax_inclusive - * - created_at - * - updated_at - * - original_total - * - original_subtotal - * - original_tax_total - * - total - * - subtotal - * - tax_total - * - discount_total - * - discount_tax_total - * - raw_original_total - * - raw_original_subtotal - * - raw_original_tax_total - * - raw_total - * - raw_subtotal - * - raw_tax_total - * - raw_discount_total - * - raw_discount_tax_total - * properties: - * id: - * type: string - * title: id - * description: The shipping method's ID. - * order_id: - * type: string - * title: order_id - * description: The shipping method's order id. - * name: - * type: string - * title: name - * description: The shipping method's name. - * description: - * type: string - * title: description - * description: The shipping method's description. - * amount: - * oneOf: - * - type: string - * title: amount - * description: The shipping method's amount. - * - type: number - * title: amount - * description: The shipping method's amount. - * - type: string - * title: amount - * description: The shipping method's amount. - * - $ref: "#/components/schemas/IBigNumber" - * raw_amount: - * type: object - * description: The shipping method's raw amount. - * is_tax_inclusive: - * type: boolean - * title: is_tax_inclusive - * description: The shipping method's is tax inclusive. - * shipping_option_id: - * type: string - * title: shipping_option_id - * description: The shipping method's shipping option id. - * data: - * type: object - * description: The shipping method's data. - * metadata: - * type: object - * description: The shipping method's metadata. - * tax_lines: - * type: array - * description: The shipping method's tax lines. - * items: - * $ref: "#/components/schemas/OrderShippingMethodTaxLine" - * adjustments: - * type: array - * description: The shipping method's adjustments. - * items: - * $ref: "#/components/schemas/OrderShippingMethodAdjustment" - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The shipping method's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The shipping method's updated at. - * original_total: - * oneOf: - * - type: string - * title: original_total - * description: The shipping method's original total. - * - type: number - * title: original_total - * description: The shipping method's original total. - * - type: string - * title: original_total - * description: The shipping method's original total. - * - $ref: "#/components/schemas/IBigNumber" - * original_subtotal: - * oneOf: - * - type: string - * title: original_subtotal - * description: The shipping method's original subtotal. - * - type: number - * title: original_subtotal - * description: The shipping method's original subtotal. - * - type: string - * title: original_subtotal - * description: The shipping method's original subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * original_tax_total: - * oneOf: - * - type: string - * title: original_tax_total - * description: The shipping method's original tax total. - * - type: number - * title: original_tax_total - * description: The shipping method's original tax total. - * - type: string - * title: original_tax_total - * description: The shipping method's original tax total. - * - $ref: "#/components/schemas/IBigNumber" - * total: - * oneOf: - * - type: string - * title: total - * description: The shipping method's total. - * - type: number - * title: total - * description: The shipping method's total. - * - type: string - * title: total - * description: The shipping method's total. - * - $ref: "#/components/schemas/IBigNumber" - * subtotal: - * oneOf: - * - type: string - * title: subtotal - * description: The shipping method's subtotal. - * - type: number - * title: subtotal - * description: The shipping method's subtotal. - * - type: string - * title: subtotal - * description: The shipping method's subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * tax_total: - * oneOf: - * - type: string - * title: tax_total - * description: The shipping method's tax total. - * - type: number - * title: tax_total - * description: The shipping method's tax total. - * - type: string - * title: tax_total - * description: The shipping method's tax total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_total: - * oneOf: - * - type: string - * title: discount_total - * description: The shipping method's discount total. - * - type: number - * title: discount_total - * description: The shipping method's discount total. - * - type: string - * title: discount_total - * description: The shipping method's discount total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_tax_total: - * oneOf: - * - type: string - * title: discount_tax_total - * description: The shipping method's discount tax total. - * - type: number - * title: 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" - * raw_original_total: - * type: object - * description: The shipping method's raw original total. - * raw_original_subtotal: - * type: object - * description: The shipping method's raw original subtotal. - * raw_original_tax_total: - * type: object - * description: The shipping method's raw original tax total. - * raw_total: - * type: object - * description: The shipping method's raw total. - * raw_subtotal: - * type: object - * description: The shipping method's raw subtotal. - * raw_tax_total: - * type: object - * description: The shipping method's raw tax total. - * raw_discount_total: - * type: object - * description: The shipping method's raw discount total. - * raw_discount_tax_total: - * type: object - * description: The shipping method's raw discount tax total. - * -*/ -