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

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

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

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

No files matched your search

www/utils/generated/oas-output/schemas/AdminArchiveOrder.ts
-15
View File
@@ -1,15 +0,0 @@
/**
* @schema AdminArchiveOrder
* type: object
* description: The archive details.
* x-schemaName: AdminArchiveOrder
* required:
* - order_id
* properties:
* order_id:
* type: string
* title: order_id
* description: The order's order id.
*
*/
www/utils/generated/oas-output/schemas/AdminCampaign.ts
+4 -4
View File
@@ -58,8 +58,8 @@
* type:
* type: string
* description: >
* The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions; `usage` means the limit is set on the total
* number of times the campaign's promotions can be used.
* The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions; `usage` means the limit is set on the total number of times the campaign's
* promotions can be used.
* enum:
* - spend
* - usage
@@ -75,8 +75,8 @@
* type: number
* title: used
* description: >
* How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds
* the number of times the campaign's promotions have been used so far.
* How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds the number of times the campaign's
* promotions have been used so far.
*
*/
www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts
+1 -1
View File
@@ -8,7 +8,7 @@
* - claim
* properties:
* order_preview:
* $ref: "#/components/schemas/OrderPreview"
* $ref: "#/components/schemas/AdminOrderPreview"
* claim:
* $ref: "#/components/schemas/AdminClaim"
*
www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts
+1 -1
View File
@@ -11,7 +11,7 @@
* return:
* $ref: "#/components/schemas/AdminReturn"
* order_preview:
* $ref: "#/components/schemas/OrderPreview"
* $ref: "#/components/schemas/AdminOrderPreview"
* claim:
* $ref: "#/components/schemas/AdminClaim"
*
www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts
+1 -1
View File
@@ -8,7 +8,7 @@
* - return
* properties:
* order_preview:
* $ref: "#/components/schemas/OrderPreview"
* $ref: "#/components/schemas/AdminOrderPreview"
* return:
* $ref: "#/components/schemas/AdminReturn"
*
www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts
-66
View File
@@ -1,66 +0,0 @@
/**
* @schema AdminCreateApplicationMethod
* type: object
* description: The application method's details.
* x-schemaName: AdminCreateApplicationMethod
* required:
* - value
* - type
* - target_type
* properties:
* description:
* type: string
* title: description
* description: The application method's description.
* value:
* type: number
* title: value
* description: The discounted amount applied by the associated promotion based on the `type`.
* currency_code:
* type: string
* title: currency_code
* description: The application method's currency code.
* max_quantity:
* type: number
* title: max_quantity
* description: The max quantity allowed in the cart for the associated promotion to be applied.
* type:
* type: string
* description: The type of the application method indicating how the associated promotion is applied.
* enum:
* - fixed
* - percentage
* target_type:
* type: string
* description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order.
* enum:
* - items
* - shipping_methods
* - order
* allocation:
* type: string
* description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart.
* enum:
* - each
* - across
* target_rules:
* type: array
* description: The application method's target rules.
* items:
* $ref: "#/components/schemas/AdminCreatePromotionRule"
* buy_rules:
* type: array
* description: The application method's buy rules.
* items:
* $ref: "#/components/schemas/AdminCreatePromotionRule"
* apply_to_quantity:
* type: number
* title: apply_to_quantity
* description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`.
* buy_rules_min_quantity:
* type: number
* title: buy_rules_min_quantity
* description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`.
*
*/
www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts
+5 -6
View File
@@ -4,15 +4,14 @@
* description: The filfillment's details.
* x-schemaName: AdminCreateFulfillment
* required:
* - data
* - order_id
* - metadata
* - items
* - location_id
* - provider_id
* - delivery_address
* - items
* - labels
* - order
* - order_id
* - data
* - metadata
* properties:
* location_id:
* type: string
@@ -77,8 +76,8 @@
* description: An item to fulfill.
* required:
* - title
* - sku
* - quantity
* - sku
* - barcode
* properties:
* title:
www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts
+1 -1
View File
@@ -50,8 +50,8 @@
* description: A price's details.
* required:
* - currency_code
* - amount
* - variant_id
* - amount
* properties:
* currency_code:
* type: string
www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts
+6
View File
@@ -84,5 +84,11 @@
* description: The variant's options, where the key is an option's name, and the value is the option's value.
* example:
* Color: Black
* inventory_items:
* type: array
* description: The variant's inventory items to create.
* items:
* $ref: "#/components/schemas/AdminCreateProductVariantInventoryKit"
*
*/
www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts
+3 -3
View File
@@ -12,13 +12,13 @@
* type: string
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* - lte
* - gte
* description:
* type: string
* title: description
@@ -27,7 +27,7 @@
* type: string
* title: attribute
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: item.product.id
* example: items.product.id
* values:
* oneOf:
* - type: string
www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* @schema AdminCreateReturnReason
* type: object
* description: The details of a return reason to create.
* description: The details of the return reason to create.
* x-schemaName: AdminCreateReturnReason
* required:
* - value
www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts
+1
View File
@@ -6,6 +6,7 @@
* required:
* - name
* - tax_region_id
* - code
* properties:
* name:
* type: string
www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts
+1
View File
@@ -23,6 +23,7 @@
* type: object
* description: The tax region's default tax rate.
* required:
* - code
* - name
* properties:
* rate:
www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts
+1 -1
View File
@@ -4,8 +4,8 @@
* description: The details of the variant-inventory item association.
* x-schemaName: AdminCreateVariantInventoryItem
* required:
* - required_quantity
* - inventory_item_id
* - required_quantity
* properties:
* required_quantity:
* type: number
www/utils/generated/oas-output/schemas/AdminCurrency.ts
-1
View File
@@ -10,7 +10,6 @@
* - name
* - decimal_digits
* - rounding
* - raw_rounding
* - created_at
* - updated_at
* - deleted_at
www/utils/generated/oas-output/schemas/AdminCustomer.ts
+1 -1
View File
@@ -5,6 +5,7 @@
* x-schemaName: AdminCustomer
* required:
* - has_account
* - addresses
* - id
* - email
* - default_billing_address_id
@@ -12,7 +13,6 @@
* - company_name
* - first_name
* - last_name
* - addresses
* properties:
* id:
* type: string
www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts
+1 -1
View File
@@ -4,9 +4,9 @@
* description: The customer group's details.
* x-schemaName: AdminCustomerGroup
* required:
* - customers
* - id
* - name
* - customers
* - metadata
* - created_at
* - updated_at
www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts
+1 -1
View File
@@ -8,7 +8,7 @@
* - exchange
* properties:
* order_preview:
* $ref: "#/components/schemas/OrderPreview"
* $ref: "#/components/schemas/AdminOrderPreview"
* exchange:
* $ref: "#/components/schemas/AdminExchange"
*
www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts
+1 -3
View File
@@ -9,11 +9,9 @@
* - exchange
* properties:
* return:
* description: The associated return's details.
* $ref: "#/components/schemas/AdminReturn"
* order_preview:
* description: A preview of the order once the exchange is applied.
* $ref: "#/components/schemas/OrderPreview"
* $ref: "#/components/schemas/AdminOrderPreview"
* exchange:
* $ref: "#/components/schemas/AdminExchange"
*
www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts
+1 -1
View File
@@ -8,7 +8,7 @@
* - return
* properties:
* order_preview:
* $ref: "#/components/schemas/OrderPreview"
* $ref: "#/components/schemas/AdminOrderPreview"
* return:
* $ref: "#/components/schemas/AdminReturn"
*
www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts
-8
View File
@@ -1,8 +0,0 @@
/**
* @schema AdminExportProductRequest
* type: object
* description: The export's details
* x-schemaName: AdminExportProductRequest
*
*/
www/utils/generated/oas-output/schemas/AdminFulfillment.ts
-2
View File
@@ -39,10 +39,8 @@
* title: shipping_option_id
* description: The ID of the shipping option this fulfillment is created for.
* provider:
* description: The details of the fulfillment provider using to handle this fulfillment.
* $ref: "#/components/schemas/AdminFulfillmentProvider"
* delivery_address:
* description: The address to deliver the item to.
* $ref: "#/components/schemas/AdminFulfillmentAddress"
* items:
* type: array
www/utils/generated/oas-output/schemas/AdminMarkOrderFulfillmentDelivered.ts
-8
View File
@@ -1,8 +0,0 @@
/**
* @schema AdminMarkOrderFulfillmentDelivered
* type: object
* description: SUMMARY
* x-schemaName: AdminMarkOrderFulfillmentDelivered
*
*/
www/utils/generated/oas-output/schemas/AdminOrder.ts
+9 -10
View File
@@ -5,21 +5,20 @@
* x-schemaName: AdminOrder
* required:
* - payment_collections
* - items
* - shipping_methods
* - currency_code
* - id
* - created_at
* - updated_at
* - email
* - version
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - currency_code
* - items
* - shipping_methods
* - payment_status
* - fulfillment_status
* - summary
* - metadata
* - created_at
* - updated_at
* - original_item_total
* - original_item_subtotal
* - original_item_tax_total
@@ -52,7 +51,7 @@
* type: array
* description: The order's fulfillments.
* items:
* $ref: "#/components/schemas/BaseOrderFulfillment"
* $ref: "#/components/schemas/AdminOrderFulfillment"
* sales_channel:
* $ref: "#/components/schemas/AdminSalesChannel"
* customer:
@@ -98,12 +97,12 @@
* type: array
* description: The order's items.
* items:
* $ref: "#/components/schemas/BaseOrderLineItem"
* $ref: "#/components/schemas/AdminOrderLineItem"
* shipping_methods:
* type: array
* description: The order's shipping methods.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethod"
* $ref: "#/components/schemas/AdminOrderShippingMethod"
* payment_status:
* type: string
* description: The order's payment status.
www/utils/generated/oas-output/schemas/AdminOrderChange.ts
+91 -100
View File
@@ -1,154 +1,145 @@
/**
* @schema AdminOrderChange
* type: object
* description: The order preview's order change.
* description: The order change's details.
* x-schemaName: AdminOrderChange
* required:
* - order
* - claim
* - return
* - return_order
* - exchange
* - id
* - version
* - actions
* - status
* - order_id
* - metadata
* - id
* - created_at
* - updated_at
* - version
* - canceled_at
* - return_id
* - exchange_id
* - claim_id
* - return_order
* - 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.
* order_id:
* type: string
* title: order_id
* description: The order change's order id.
* actions:
* type: array
* description: The order change's actions.
* items:
* $ref: "#/components/schemas/BaseOrderChangeAction"
* 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.
* version:
* type: number
* title: version
* description: The order change's version.
* description: The order change's version. This will be the order's version when the change is applied.
* change_type:
* type: string
* description: The order change's change type.
* description: The order change's type.
* enum:
* - return
* - exchange
* - claim
* - edit
* - return_request
* order_id:
* type: string
* title: order_id
* description: The ID of the order this change applies on.
* return_id:
* type: string
* title: return_id
* description: The order change's return id.
* description: The ID of the associated return.
* exchange_id:
* type: string
* title: exchange_id
* description: The order change's exchange id.
* description: The ID of the associated exchange.
* claim_id:
* type: string
* title: claim_id
* description: The order change's claim id.
* description: The ID of the associated claim.
* order:
* $ref: "#/components/schemas/AdminOrder"
* type: string
* title: order
* description: The order change's order.
* externalDocs:
* url: "#pagination"
* return_order:
* $ref: "#/components/schemas/AdminReturn"
* exchange:
* $ref: "#/components/schemas/AdminExchange"
* claim:
* $ref: "#/components/schemas/AdminClaim"
* actions:
* type: array
* description: The order change's actions.
* items:
* $ref: "#/components/schemas/AdminOrderChangeAction"
* status:
* type: string
* description: The order change's status.
* enum:
* - canceled
* - requested
* - pending
* - confirmed
* - declined
* requested_by:
* type: string
* title: requested_by
* description: The ID of the user that requested the change.
* requested_at:
* type: string
* title: requested_at
* description: The date the order change was requested.
* format: date-time
* confirmed_by:
* type: string
* title: confirmed_by
* description: The ID of the user that confirmed the order change.
* confirmed_at:
* type: string
* title: confirmed_at
* description: The date the order change was confirmed.
* format: date-time
* declined_by:
* type: string
* title: declined_by
* description: The ID of the user that declined the order change.
* declined_reason:
* type: string
* title: declined_reason
* description: The reason the order change was declined.
* metadata:
* type: object
* description: The order change's metadata, can hold custom key-value pairs.
* declined_at:
* type: string
* title: declined_at
* description: The date the order change was declined.
* format: date-time
* canceled_by:
* type: string
* title: canceled_by
* description: The ID of the user that canceled the order change.
* canceled_at:
* type: string
* title: canceled_at
* description: The date the order change was canceled.
* format: date-time
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the order change was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the order change was updated.
*
*/
www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts
+58 -39
View File
@@ -1,11 +1,25 @@
/**
* @schema AdminOrderChangeAction
* type: object
* description: The action's details.
* description: The order change action's details.
* x-schemaName: AdminOrderChangeAction
* required:
* - order_change
* - order
* - order_id
* - internal_note
* - id
* - created_at
* - updated_at
* - return_id
* - exchange_id
* - claim_id
* - order_change_id
* - reference
* - reference_id
* - action
* - details
* properties:
* order_change:
* $ref: "#/components/schemas/AdminOrderChange"
* id:
* type: string
* title: id
@@ -13,11 +27,31 @@
* order_change_id:
* type: string
* title: order_change_id
* description: The ID of the order change this action belongs to.
* description: The ID of the order change that the action belongs to.
* order_change:
* $ref: "#/components/schemas/AdminOrderChange"
* order_id:
* type: string
* title: order_id
* description: The ID of the associated order.
* description: The ID of the order the associated change is for.
* return_id:
* type: string
* title: return_id
* description: The ID of the associated return.
* claim_id:
* type: string
* title: claim_id
* description: The ID of the associated claim.
* exchange_id:
* type: string
* title: exchange_id
* description: The ID of the associated exchange.
* order:
* type: string
* title: order
* description: The order change's order.
* externalDocs:
* url: "#pagination"
* reference:
* type: string
* title: reference
@@ -33,8 +67,23 @@
* description: The ID of the record in the referenced table.
* action:
* type: string
* title: action
* description: The applied action.
* enum:
* - CANCEL_RETURN_ITEM
* - FULFILL_ITEM
* - DELIVER_ITEM
* - CANCEL_ITEM_FULFILLMENT
* - ITEM_ADD
* - ITEM_REMOVE
* - ITEM_UPDATE
* - RECEIVE_DAMAGED_RETURN_ITEM
* - RECEIVE_RETURN_ITEM
* - RETURN_ITEM
* - SHIPPING_ADD
* - SHIPPING_REMOVE
* - SHIP_ITEM
* - WRITE_OFF_ITEM
* - REINSTATE_ITEM
* details:
* type: object
* description: The action's details.
@@ -44,47 +93,17 @@
* internal_note:
* type: string
* title: internal_note
* description: A note viewed only by admin users.
* description: A note that's viewed only by admin users.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the order change action was created.
* description: The date the action was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the order change action was updated.
* return_id:
* type: string
* title: return_id
* description: The ID of the associated return.
* claim_id:
* type: string
* title: claim_id
* description: The ID of the associated claim.
* exchange_id:
* type: string
* title: exchange_id
* description: The ID of the associated exchange.
* order:
* $ref: "#/components/schemas/BaseOrder"
* required:
* - order_change
* - id
* - order_change_id
* - order_id
* - reference
* - reference_id
* - action
* - details
* - internal_note
* - created_at
* - updated_at
* - return_id
* - claim_id
* - exchange_id
* - order
* description: The date the action was updated.
*
*/
www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts
+1 -1
View File
@@ -10,7 +10,7 @@
* type: array
* description: An order's changes.
* items:
* $ref: "#/components/schemas/BaseOrderChange"
* $ref: "#/components/schemas/AdminOrderChange"
*
*/
www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts
+1 -1
View File
@@ -7,7 +7,7 @@
* - order_preview
* properties:
* order_preview:
* $ref: "#/components/schemas/OrderPreview"
* $ref: "#/components/schemas/AdminOrderPreview"
*
*/
www/utils/generated/oas-output/schemas/AdminOrderEditResponse.ts
+1 -1
View File
@@ -7,7 +7,7 @@
* - order_change
* properties:
* order_change:
* $ref: "#/components/schemas/OrderChange"
* $ref: "#/components/schemas/AdminOrderChange"
*
*/
www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts
+16 -16
View File
@@ -4,10 +4,24 @@
* description: The item's details.
* x-schemaName: AdminOrderLineItem
* required:
* - id
* - title
* - metadata
* - id
* - subtitle
* - thumbnail
* - created_at
* - updated_at
* - item_total
* - item_subtotal
* - item_tax_total
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - variant_id
* - product_id
* - product_title
@@ -26,20 +40,6 @@
* - unit_price
* - quantity
* - detail
* - created_at
* - updated_at
* - metadata
* - original_total
* - original_subtotal
* - original_tax_total
* - item_total
* - item_subtotal
* - item_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - refundable_total
* - refundable_total_per_unit
* properties:
@@ -66,7 +66,7 @@
* title: variant_id
* description: The ID of the associated variant.
* product:
* $ref: "#/components/schemas/BaseProduct"
* $ref: "#/components/schemas/AdminProduct"
* product_id:
* type: string
* title: product_id
www/utils/generated/oas-output/schemas/AdminPayment.ts
+3 -3
View File
@@ -87,11 +87,11 @@
* type: array
* description: The details of payment refunds.
* items:
* $ref: "#/components/schemas/BaseRefund"
* $ref: "#/components/schemas/AdminRefund"
* payment_collection:
* $ref: "#/components/schemas/BasePaymentCollection"
* $ref: "#/components/schemas/AdminPaymentCollection"
* payment_session:
* $ref: "#/components/schemas/BasePaymentSession"
* $ref: "#/components/schemas/AdminPaymentSession"
*
*/
www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts
+4 -4
View File
@@ -4,12 +4,12 @@
* description: The payment collection's details.
* x-schemaName: AdminPaymentCollection
* required:
* - payment_providers
* - id
* - currency_code
* - region_id
* - amount
* - status
* - payment_providers
* properties:
* id:
* type: string
@@ -70,17 +70,17 @@
* type: array
* description: The payment provider used to process the collection's payments and sessions.
* items:
* $ref: "#/components/schemas/BasePaymentProvider"
* $ref: "#/components/schemas/AdminPaymentProvider"
* payment_sessions:
* type: array
* description: The payment collection's payment sessions.
* items:
* $ref: "#/components/schemas/BasePaymentSession"
* $ref: "#/components/schemas/AdminPaymentSession"
* payments:
* type: array
* description: The payment collection's payments.
* items:
* $ref: "#/components/schemas/BasePayment"
* $ref: "#/components/schemas/AdminPayment"
*
*/
www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts
+1 -1
View File
@@ -37,7 +37,7 @@
* type: string
* title: object
* description: The name of the deleted object.
* default: "price"
* default: price
* deleted:
* type: boolean
* title: deleted
www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts
+1 -1
View File
@@ -71,7 +71,7 @@
* type: string
* format: date-time
* title: deleted_at
* description: The date the price was deleted.
* description: The date the price was deleted.
*
*/
www/utils/generated/oas-output/schemas/AdminProduct.ts
+7 -6
View File
@@ -4,15 +4,15 @@
* description: The product's details.
* x-schemaName: AdminProduct
* required:
* - variants
* - type
* - options
* - images
* - length
* - title
* - status
* - options
* - description
* - id
* - created_at
* - updated_at
* - handle
* - subtitle
* - is_giftcard
@@ -26,9 +26,10 @@
* - material
* - collection_id
* - type_id
* - images
* - discountable
* - external_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* collection:
@@ -75,7 +76,7 @@
* type: array
* description: The product's options.
* items:
* $ref: "#/components/schemas/BaseProductOption"
* $ref: "#/components/schemas/AdminProductOption"
* description:
* type: string
* title: description
@@ -153,7 +154,7 @@
* type: array
* description: The product's images.
* items:
* $ref: "#/components/schemas/BaseProductImage"
* $ref: "#/components/schemas/AdminProductImage"
* discountable:
* type: boolean
* title: discountable
www/utils/generated/oas-output/schemas/AdminProductOption.ts
+1 -1
View File
@@ -25,7 +25,7 @@
* type: array
* description: The product option's values.
* items:
* $ref: "#/components/schemas/BaseProductOptionValue"
* $ref: "#/components/schemas/AdminProductOptionValue"
* metadata:
* type: object
* description: The product option's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts
+1 -1
View File
@@ -16,7 +16,7 @@
* type: string
* title: object
* description: The name of the deleted object.
* default: "product_option"
* default: product_option
* deleted:
* type: boolean
* title: deleted
www/utils/generated/oas-output/schemas/AdminProductVariant.ts
+2 -2
View File
@@ -5,6 +5,7 @@
* x-schemaName: AdminProductVariant
* required:
* - prices
* - options
* - id
* - title
* - sku
@@ -21,7 +22,6 @@
* - length
* - height
* - width
* - options
* - created_at
* - updated_at
* - deleted_at
@@ -107,7 +107,7 @@
* type: array
* description: The variant's option values.
* items:
* $ref: "#/components/schemas/BaseProductOptionValue"
* $ref: "#/components/schemas/AdminProductOptionValue"
* product:
* $ref: "#/components/schemas/AdminProduct"
* product_id:
www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts
+1 -1
View File
@@ -20,7 +20,7 @@
* type: boolean
* title: deleted
* description: Whether the product variant was deleted.
* default: "variant"
* default: variant
* parent:
* $ref: "#/components/schemas/AdminProduct"
*
www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts
+1 -1
View File
@@ -15,7 +15,7 @@
* type: string
* title: object
* description: The name of the deleted object.
* default: "variant-inventory-item-link"
* default: variant-inventory-item-link
* deleted:
* type: boolean
* title: deleted
www/utils/generated/oas-output/schemas/AdminPromotion.ts
+7 -7
View File
@@ -6,6 +6,13 @@
* required:
* - id
* properties:
* application_method:
* $ref: "#/components/schemas/AdminApplicationMethod"
* rules:
* type: array
* description: The promotion's rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* id:
* type: string
* title: id
@@ -25,13 +32,6 @@
* type: boolean
* title: is_automatic
* description: Whether the promotion is applied on a cart automatically if it matches the promotion's rules.
* application_method:
* $ref: "#/components/schemas/BaseApplicationMethod"
* rules:
* type: array
* description: The promotion's rules.
* items:
* $ref: "#/components/schemas/BasePromotionRule"
* campaign_id:
* type: string
* title: campaign_id
www/utils/generated/oas-output/schemas/AdminPromotionRule.ts
+2 -2
View File
@@ -22,7 +22,7 @@
* example: customer_group_id
* operator:
* type: string
* description: The updated's operator.
* description: The rule's operator.
* enum:
* - gt
* - lt
@@ -33,7 +33,7 @@
* - gte
* values:
* type: array
* description: The updated's values.
* description: The rule's values.
* example:
* - "cusgroup_123"
* items:
www/utils/generated/oas-output/schemas/AdminRegion.ts
+1 -1
View File
@@ -4,9 +4,9 @@
* description: The region's details.
* x-schemaName: AdminRegion
* required:
* - id
* - name
* - currency_code
* - id
* properties:
* id:
* type: string
www/utils/generated/oas-output/schemas/AdminReservation.ts
+1 -3
View File
@@ -11,7 +11,6 @@
* - external_id
* - description
* - inventory_item_id
* - inventory_item
* properties:
* id:
* type: string
@@ -42,8 +41,7 @@
* title: inventory_item_id
* description: The ID of the inventory item this reservation is associated with.
* inventory_item:
* type: object
* description: The associated inventory item.
* $ref: "#/components/schemas/AdminInventoryItem"
* metadata:
* type: object
* description: The reservation's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts
+3 -5
View File
@@ -7,25 +7,23 @@
* - id
* - value
* - label
* - field_type
* - required
* - operators
* properties:
* id:
* type: string
* title: id
* description: The rule attribute's ID, which is a rule's `attribute` it refers to.
* example: "customer_group"
* example: customer_group
* value:
* type: string
* title: value
* description: The rule attribute's value.
* example: "customer.groups.id"
* example: customer.groups.id
* label:
* type: string
* title: label
* description: The rule attribute option's label.
* example: "Customer Group"
* example: Customer Group
* operators:
* type: array
* description: The attribute's operators.
www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts
+2 -2
View File
@@ -11,12 +11,12 @@
* type: string
* title: value
* description: The rule value's value.
* example: "reg_123"
* example: reg_123
* label:
* type: string
* title: label
* description: The rule value's label.
* example: "Europe Region"
* example: Europe Region
*
*/
www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts
+1 -1
View File
@@ -16,7 +16,7 @@
* type: string
* title: object
* description: The name of the deleted object.
* default: "service_zone"
* default: service_zone
* deleted:
* type: boolean
* title: deleted
www/utils/generated/oas-output/schemas/AdminShippingOption.ts
+3 -2
View File
@@ -33,7 +33,8 @@
* description: The shipping option's name.
* price_type:
* type: string
* description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider.
* description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated
* fulfillment provider.
* enum:
* - calculated
* - flat
@@ -54,7 +55,7 @@
* title: shipping_option_type_id
* description: The ID of the associated shipping option type.
* type:
* $ref: "#/components/schemas/AdminShippingOption"
* $ref: "#/components/schemas/AdminShippingOptionType"
* shipping_profile_id:
* type: string
* title: shipping_profile_id
www/utils/generated/oas-output/schemas/AdminShippingOptionType.ts
+53
View File
@@ -0,0 +1,53 @@
/**
* @schema AdminShippingOptionType
* type: object
* description: The shipping option's details.
* x-schemaName: AdminShippingOptionType
* required:
* - id
* - label
* - description
* - code
* - shipping_option_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The shipping option's ID.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the shipping option was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the shipping option was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the shipping option was deleted.
* label:
* type: string
* title: label
* description: The type's label.
* description:
* type: string
* title: description
* description: The type's description.
* code:
* type: string
* title: code
* description: The type's code.
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The type's shipping option id.
*
*/
www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts
+2 -1
View File
@@ -37,6 +37,7 @@
* description: The price list's rules.
* example:
* customer_group_id:
* - "cusgrp_123"
* - cusgrp_123
*
*/
www/utils/generated/oas-output/schemas/AdminUpdatePromotionRule.ts
+49
View File
@@ -0,0 +1,49 @@
/**
* @schema AdminUpdatePromotionRule
* type: object
* description: The properties to update in a buy rule.
* required:
* - id
* - values
* properties:
* id:
* type: string
* title: id
* description: The buy rule's ID.
* operator:
* type: string
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The buy rule's description.
* attribute:
* type: string
* title: attribute
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: An attribute value.
* example: prod_123
* x-schemaName: AdminUpdatePromotionRule
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateShippingOptionRule.ts
+48
View File
@@ -0,0 +1,48 @@
/**
* @schema AdminUpdateShippingOptionRule
* type: object
* description: The properties to update in the shipping option rule.
* required:
* - id
* - operator
* - attribute
* - value
* properties:
* id:
* type: string
* title: id
* description: The rule's ID.
* operator:
* type: string
* description: The operator used to check whether a rule applies.
* enum:
* - in
* - eq
* - ne
* - gt
* - gte
* - lt
* - lte
* - nin
* attribute:
* type: string
* title: attribute
* description: The name of a property or table that the rule applies to.
* example: customer_group
* value:
* oneOf:
* - type: string
* title: value
* description: A value of the attribute that enables this rule.
* example: cusgroup_123
* - type: array
* description: Values of the attribute that enable this rule.
* items:
* type: string
* title: value
* description: A value of the attribute that enables this rule.
* example: cusgroup_123
* x-schemaName: AdminUpdateShippingOptionRule
*
*/
www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts
+2 -1
View File
@@ -9,7 +9,8 @@
* required_quantity:
* type: number
* title: required_quantity
* description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`.
* description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the
* value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`.
*
*/
www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts
-67
View File
@@ -1,67 +0,0 @@
/**
* @schema BaseApplicationMethod
* type: object
* description: The application method's details.
* x-schemaName: BaseApplicationMethod
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The application method's ID.
* type:
* type: string
* description: How the associated promotion is applied. `fixed` means a fixed amount is discounted; `percentage` means a percentage of the original amount is discounted.
* enum:
* - fixed
* - percentage
* target_type:
* type: string
* description: Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order.
* enum:
* - items
* - shipping_methods
* - order
* allocation:
* type: string
* description: How is the promotion amount discounted. `each` means the discounted amount is applied on each applicable item; `across` means the discounted amount is split accross the applicable items.
* enum:
* - each
* - across
* value:
* type: number
* title: value
* description: The amount to be discounted.
* currency_code:
* type: string
* title: currency_code
* description: The application method's currency code.
* example: usd
* max_quantity:
* type: number
* title: max_quantity
* description: The max quantity allowed in the cart for the associated promotion to be applied.
* buy_rules_min_quantity:
* type: number
* title: buy_rules_min_quantity
* description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`.
* apply_to_quantity:
* type: number
* title: apply_to_quantity
* description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `1`.
* promotion:
* $ref: "#/components/schemas/BasePromotion"
* target_rules:
* type: array
* description: The application method's target rules. These rules indicate which items / shipping methods the promotion applies to.
* items:
* $ref: "#/components/schemas/BasePromotionRule"
* buy_rules:
* type: array
* description: The application method's buy rules. These rules indicate which items are part of the "Buy X" rule.
* items:
* $ref: "#/components/schemas/BasePromotionRule"
*
*/
www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts
+1 -1
View File
@@ -20,7 +20,7 @@
* is_calculated_price_tax_inclusive:
* type: boolean
* title: is_calculated_price_tax_inclusive
* description: Whether the calculated price is tax inclusive.
* description: Whether the calculated price is tax inclusive.
* calculated_amount:
* type: number
* title: calculated_amount
www/utils/generated/oas-output/schemas/BaseClaim.ts
-103
View File
@@ -1,103 +0,0 @@
/**
* @schema BaseClaim
* type: object
* description: The claim's details.
* x-schemaName: BaseClaim
* required:
* - id
* - type
* - order_id
* - display_id
* - order_version
* - created_at
* - updated_at
* - canceled_at
* - additional_items
* - claim_items
* properties:
* id:
* type: string
* title: id
* description: The claim's ID.
* type:
* type: string
* description: The claim's type. If `refund`, the customer is refunded for the damaged item. If `replace`, new items are sent to the customer.
* enum:
* - refund
* - replace
* order_id:
* type: string
* title: order_id
* description: The ID of the order the claim is created for.
* return_id:
* type: string
* title: return_id
* description: The ID of the returned used to return the items from the customer.
* display_id:
* type: string
* title: display_id
* description: The claim's display ID.
* order_version:
* type: string
* title: order_version
* description: The version of the order when the claim is applied.
* refund_amount:
* type: number
* title: refund_amount
* description: The amount to be refunded.
* created_by:
* type: string
* title: created_by
* description: The ID of the user that created the claim.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the claim was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the claim was updated.
* canceled_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the claim was canceled.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the claim was deleted.
* additional_items:
* type: array
* description: The items sent to the customer if the claim's type is `replace`.
* items:
* $ref: "#/components/schemas/BaseClaimItem"
* claim_items:
* type: array
* description: The claim items from the original order.
* items:
* $ref: "#/components/schemas/BaseClaimItem"
* no_notification:
* type: boolean
* title: no_notification
* description: Whether to send the customer notifications on the claim's updates.
* order:
* $ref: "#/components/schemas/BaseOrder"
* shipping_methods:
* type: array
* description: The claim's shipping methods, used to send the new items.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethod"
* transactions:
* type: array
* description: The claim's transactions, such as the refunds made.
* items:
* $ref: "#/components/schemas/BaseOrderTransaction"
* metadata:
* type: object
* description: The claim's metadata, can hold custom key-value pairs.
*
*/
www/utils/generated/oas-output/schemas/BaseClaimItem.ts
+11
View File
@@ -43,6 +43,17 @@
* raw_quantity:
* type: object
* description: The quantity claimed.
* properties:
* value:
* oneOf:
* - type: string
* title: value
* description: The raw quantity's value.
* - type: number
* title: value
* description: The raw quantity's value.
* required:
* - value
* metadata:
* type: object
* description: The item's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/BaseCollection.ts
-44
View File
@@ -3,50 +3,6 @@
* type: object
* description: The collection's details.
* x-schemaName: BaseCollection
* required:
* - id
* - title
* - handle
* - created_at
* - updated_at
* - deleted_at
* - metadata
* properties:
* id:
* type: string
* title: id
* description: The collection's ID.
* title:
* type: string
* title: title
* description: The collection's title.
* handle:
* type: string
* title: handle
* description: The collection's handle.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the collection is created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the collection is updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the collection is deleted.
* products:
* type: array
* description: The collection's products.
* items:
* $ref: "#/components/schemas/AdminProduct"
* metadata:
* type: object
* description: The collection's metadata, can hold custom key-value pairs.
*
*/
www/utils/generated/oas-output/schemas/BaseCustomer.ts
-78
View File
@@ -1,78 +0,0 @@
/**
* @schema BaseCustomer
* type: object
* description: The customer's details.
* x-schemaName: BaseCustomer
* required:
* - id
* - email
* - default_billing_address_id
* - default_shipping_address_id
* - company_name
* - first_name
* - last_name
* - addresses
* properties:
* id:
* type: string
* title: id
* description: The customer's ID.
* email:
* type: string
* title: email
* description: The customer's email.
* format: email
* default_billing_address_id:
* type: string
* title: default_billing_address_id
* description: The ID of the address used as the default billing address.
* default_shipping_address_id:
* type: string
* title: default_shipping_address_id
* description: The ID of the address used as the default shipping address.
* company_name:
* type: string
* title: company_name
* description: The customer's company name.
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* addresses:
* type: array
* description: The customer's addresses.
* items:
* $ref: "#/components/schemas/BaseCustomerAddress"
* phone:
* type: string
* title: phone
* description: The customer's phone.
* metadata:
* type: object
* description: The customer's metadata, used to store custom key-value pairs.
* created_by:
* type: string
* title: created_by
* description: The ID of the user that created this customer, if available.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The customer's creation date.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The customer's update date.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The customer's deletion date.
*
*/
www/utils/generated/oas-output/schemas/BaseOrderChange.ts
-154
View File
@@ -1,154 +0,0 @@
/**
* @schema BaseOrderChange
* type: object
* description: The order preview's order change.
* x-schemaName: BaseOrderChange
* required:
* - order
* - claim
* - return
* - exchange
* - id
* - version
* - order_id
* - return_id
* - exchange_id
* - claim_id
* - return_order
* - 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.
* order_id:
* type: string
* title: order_id
* description: The order change's order id.
* actions:
* type: array
* description: The order change's actions.
* items:
* $ref: "#/components/schemas/BaseOrderChangeAction"
* 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.
* version:
* type: number
* title: version
* description: The order change's version.
* change_type:
* type: string
* description: The order change's change type.
* enum:
* - return
* - exchange
* - claim
* - edit
* - return_request
* 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:
* $ref: "#/components/schemas/AdminOrder"
* return_order:
* $ref: "#/components/schemas/AdminReturn"
* exchange:
* $ref: "#/components/schemas/AdminExchange"
* claim:
* $ref: "#/components/schemas/AdminClaim"
*
*/
www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts
+3 -1
View File
@@ -6,6 +6,7 @@
* required:
* - id
* - item_id
* - item
* - quantity
* - fulfilled_quantity
* - delivered_quantity
@@ -27,7 +28,7 @@
* title: id
* description: the ID of the associated line item.
* item:
* $ref: "#/components/schemas/AdminOrderLineItem"
* $ref: "#/components/schemas/BaseOrderLineItem"
* quantity:
* type: number
* title: quantity
@@ -74,5 +75,6 @@
* format: date-time
* title: updated_at
* description: The date the detail was updated.
*
*/
www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts
+2 -1
View File
@@ -60,7 +60,7 @@
* title: thumbnail
* description: The URL of the item's thumbnail.
* variant:
* $ref: "#/components/schemas/AdminProductVariant"
* $ref: "#/components/schemas/BaseProductVariant"
* variant_id:
* type: string
* title: variant_id
@@ -215,3 +215,4 @@
* description: The total refundable amount of the item's total for a single quantity.
*
*/
www/utils/generated/oas-output/schemas/BaseOrderShippingDetail.ts
-3
View File
@@ -7,9 +7,6 @@
* - id
* - shipping_method_id
* - shipping_method
* - claim_id
* - exchange_id
* - return_id
* - created_at
* - updated_at
* properties:
www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts
+2
View File
@@ -111,6 +111,8 @@
* format: date-time
* title: updated_at
* description: The date the shipping method was updated.
* detail:
* $ref: "#/components/schemas/BaseOrderShippingDetail"
*
*/
www/utils/generated/oas-output/schemas/BaseOrderSummary.ts
-25
View File
@@ -12,11 +12,6 @@
* - returned_total
* - return_request_total
* - write_off_total
* - projected_total
* - net_total
* - net_subtotal
* - net_total_tax
* - balance
* - paid_total
* - refunded_total
* properties:
@@ -52,26 +47,6 @@
* type: number
* title: write_off_total
* description: The total of the items removed from the order.
* projected_total:
* type: number
* title: projected_total
* description: The summary's projected total.
* net_total:
* type: number
* title: net_total
* description: The summary's net total.
* net_subtotal:
* type: number
* title: net_subtotal
* description: The summary's net subtotal.
* net_total_tax:
* type: number
* title: net_total_tax
* description: The summary's net total tax.
* balance:
* type: number
* title: balance
* description: The summary's balance.
* paid_total:
* type: number
* title: paid_total
www/utils/generated/oas-output/schemas/BasePaymentProvider.ts
-5
View File
@@ -4,17 +4,12 @@
* description: The payment provider's payment providers.
* x-schemaName: BasePaymentProvider
* required:
* - is_enabled
* - id
* properties:
* id:
* type: string
* title: id
* description: The payment provider's ID.
* is_enabled:
* type: boolean
* title: is_enabled
* description: Whether the payment provider is enabled.
*
*/
www/utils/generated/oas-output/schemas/BaseRefund.ts
+2
View File
@@ -36,6 +36,8 @@
* description: The ID of the user that created the refund.
* payment:
* $ref: "#/components/schemas/BasePayment"
* refund_reason:
* $ref: "#/components/schemas/RefundReason"
*
*/
www/utils/generated/oas-output/schemas/BaseReturnItem.ts
-8
View File
@@ -1,8 +0,0 @@
/**
* @schema BaseReturnItem
* type: object
* description: The item's items.
* x-schemaName: BaseReturnItem
*
*/
www/utils/generated/oas-output/schemas/BaseRuleOperatorOptions.ts
+3 -3
View File
@@ -12,17 +12,17 @@
* type: string
* title: id
* description: The operator's ID.
* example: "in"
* example: in
* value:
* type: string
* title: value
* description: The operator's value.
* example: "in"
* example: in
* label:
* type: string
* title: label
* description: The operator's label.
* example: "In"
* example: In
*
*/
www/utils/generated/oas-output/schemas/CreateOrderReturnReason.ts
-31
View File
@@ -1,31 +0,0 @@
/**
* @schema CreateOrderReturnReason
* type: object
* description: The details of the return reason to create.
* x-schemaName: CreateOrderReturnReason
* required:
* - value
* - label
* properties:
* value:
* type: string
* title: value
* description: The return reason's value.
* label:
* type: string
* title: label
* description: The return reason's label.
* description:
* type: string
* title: description
* description: The return reason's description.
* parent_return_reason_id:
* type: string
* title: parent_return_reason_id
* description: The return reason's parent return reason id.
* metadata:
* type: object
* description: The return reason's metadata.
*
*/
www/utils/generated/oas-output/schemas/OrderPreview.ts
-1555
View File
File diff suppressed because it is too large. Load diff
www/utils/generated/oas-output/schemas/ReservationResponse.ts
-71
View File
@@ -1,71 +0,0 @@
/**
* @schema ReservationResponse
* type: object
* description: The reservation's details.
* x-schemaName: ReservationResponse
* required:
* - id
* - line_item_id
* - location_id
* - quantity
* - external_id
* - description
* - inventory_item_id
* - inventory_item
* properties:
* id:
* type: string
* title: id
* description: The reservation's ID.
* line_item_id:
* type: string
* title: line_item_id
* description: The reservation's line item id.
* location_id:
* type: string
* title: location_id
* description: The reservation's location id.
* quantity:
* type: string
* title: quantity
* description: The reservation's quantity.
* external_id:
* type: string
* title: external_id
* description: The reservation's external id.
* description:
* type: string
* title: description
* description: The reservation's description.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The reservation's inventory item id.
* inventory_item:
* type: object
* description: The reservation's inventory item.
* metadata:
* type: object
* description: The reservation's metadata.
* created_by:
* type: string
* title: created_by
* description: The reservation's created by.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The reservation's deleted at.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The reservation's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The reservation's updated at.
*
*/
www/utils/generated/oas-output/schemas/StoreCalculateCartTaxes.ts
-13
View File
@@ -1,13 +0,0 @@
/**
* @schema StoreCalculateCartTaxes
* type: object
* description: SUMMARY
* x-schemaName: StoreCalculateCartTaxes
* properties:
* fields:
* type: string
* title: fields
* description: The cart's fields.
*
*/
www/utils/generated/oas-output/schemas/StoreCart.ts
+4 -4
View File
@@ -4,8 +4,8 @@
* description: The cart's details.
* x-schemaName: StoreCart
* required:
* - id
* - currency_code
* - id
* - original_item_total
* - original_item_subtotal
* - original_item_tax_total
@@ -34,7 +34,7 @@
* title: id
* description: The cart's ID.
* region:
* $ref: "#/components/schemas/BaseRegion"
* $ref: "#/components/schemas/StoreRegion"
* region_id:
* type: string
* title: region_id
@@ -70,9 +70,9 @@
* type: array
* description: The cart's shipping methods.
* items:
* $ref: "#/components/schemas/BaseCartShippingMethod"
* $ref: "#/components/schemas/StoreCartShippingMethod"
* payment_collection:
* $ref: "#/components/schemas/BasePaymentCollection"
* $ref: "#/components/schemas/StorePaymentCollection"
* metadata:
* type: object
* description: The cart's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/StoreCartLineItem.ts
+156 -14
View File
@@ -4,26 +4,26 @@
* description: The item's details.
* x-schemaName: StoreCartLineItem
* required:
* - id
* - title
* - quantity
* - requires_shipping
* - is_discountable
* - is_tax_inclusive
* - unit_price
* - cart
* - cart_id
* - original_total
* - original_subtotal
* - original_tax_total
* - title
* - id
* - item_total
* - item_subtotal
* - item_tax_total
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - requires_shipping
* - is_discountable
* - is_tax_inclusive
* - unit_price
* - quantity
* - cart_id
* properties:
* id:
* type: string
@@ -76,7 +76,7 @@
* title: product_handle
* description: The item's product handle.
* variant:
* $ref: "#/components/schemas/BaseProductVariant"
* $ref: "#/components/schemas/StoreProductVariant"
* variant_id:
* type: string
* title: variant_id
@@ -122,12 +122,154 @@
* type: array
* description: The item's tax lines.
* items:
* $ref: "#/components/schemas/BaseLineItemTaxLine"
* allOf:
* - type: object
* description: The tax line's details.
* x-schemaName: BaseLineItemTaxLine
* required:
* - item
* - item_id
* - total
* - subtotal
* - id
* - code
* - rate
* - created_at
* - updated_at
* properties:
* item:
* type: object
* title: item
* description: The details of the item that the tax line belongs to.
* item_id:
* type: string
* title: item_id
* description: The ID of the line item this tax line belongs to.
* total:
* type: number
* title: total
* description: The item's total including taxes and promotions.
* subtotal:
* type: number
* title: subtotal
* description: The item's total excluding taxes, including promotions.
* id:
* type: string
* title: id
* description: The tax line's ID.
* description:
* type: string
* title: description
* description: The tax line's description.
* tax_rate_id:
* type: string
* title: tax_rate_id
* description: The ID of the applied tax rate.
* code:
* type: string
* title: code
* description: The code that the tax rate is identified by.
* rate:
* type: number
* title: rate
* description: The charged rate.
* provider_id:
* type: string
* title: provider_id
* description: The ID of the tax provider used to calculate the tax line.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the tax line was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the tax line was updated.
* - type: object
* description: The tax line's details.
* required:
* - item
* properties:
* item:
* type: object
* title: item
* description: The details of the item that the tax line belongs to.
* description: The tax line's details
* adjustments:
* type: array
* description: The item's adjustments.
* items:
* $ref: "#/components/schemas/BaseLineItemAdjustment"
* allOf:
* - type: object
* description: The adjustment's details.
* x-schemaName: BaseLineItemAdjustment
* required:
* - item
* - item_id
* - id
* - amount
* - cart_id
* - created_at
* - updated_at
* properties:
* item:
* type: object
* title: item
* description: The details of the item that the adjustment belongs to.
* item_id:
* type: string
* title: item_id
* description: The ID of the item that the adjustment belongs to.
* id:
* type: string
* title: id
* description: The adjustment's ID.
* code:
* type: string
* title: code
* description: The adjustment's code.
* amount:
* type: number
* title: amount
* description: The adjustment's amount.
* cart_id:
* type: string
* title: cart_id
* description: The ID of the associated cart.
* description:
* type: string
* title: description
* description: The adjustment's description.
* promotion_id:
* type: string
* title: promotion_id
* description: The ID of the applied promotion.
* provider_id:
* type: string
* title: provider_id
* description: The adjustment's provider ID.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the adjustment was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the adjustment was updated.
* - type: object
* description: The adjustment's details.
* required:
* - item
* properties:
* item:
* type: object
* title: item
* description: The details of the item that the adjustment belongs to.
* description: The adjustment's details.
* cart:
* $ref: "#/components/schemas/StoreCart"
* cart_id:
www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts
+140 -2
View File
@@ -60,12 +60,150 @@
* type: array
* description: The shipping method's tax lines.
* items:
* $ref: "#/components/schemas/BaseShippingMethodTaxLine"
* allOf:
* - type: object
* description: The tax line's details
* x-schemaName: BaseShippingMethodTaxLine
* required:
* - shipping_method
* - shipping_method_id
* - total
* - subtotal
* - id
* - code
* - rate
* - created_at
* - updated_at
* properties:
* shipping_method:
* type: object
* title: shipping_method
* description: The details of the method that the tax line belongs to.
* shipping_method_id:
* type: string
* title: shipping_method_id
* description: The ID of the shipping method this tax line belongs to.
* total:
* type: number
* title: total
* description: The method's total including taxes and promotions.
* subtotal:
* type: number
* title: subtotal
* description: The method's total excluding taxes, including promotions.
* id:
* type: string
* title: id
* description: The tax line's ID.
* description:
* type: string
* title: description
* description: The tax line's description.
* tax_rate_id:
* type: string
* title: tax_rate_id
* description: The ID of the applied tax rate.
* code:
* type: string
* title: code
* description: The code that the tax rate is identified by.
* rate:
* type: number
* title: rate
* description: The charged rate.
* provider_id:
* type: string
* title: provider_id
* description: The ID of the tax provider used to calculate the tax line.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the tax line was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the tax line was updated.
* - type: object
* description: The tax line's details.
* required:
* - shipping_method
* properties:
* shipping_method:
* type: object
* title: shipping_method
* description: The details of the method that the tax line belongs to.
* description: The tax line's details.
* adjustments:
* type: array
* description: The shipping method's adjustments, such as applied promotions.
* items:
* $ref: "#/components/schemas/BaseShippingMethodAdjustment"
* allOf:
* - type: object
* description: The adjustment's details.
* x-schemaName: BaseShippingMethodAdjustment
* required:
* - shipping_method
* - shipping_method_id
* - id
* - amount
* - cart_id
* - created_at
* - updated_at
* properties:
* shipping_method:
* type: object
* title: shipping_method
* description: The details of the method that the adjustment belongs to.
* id:
* type: string
* title: id
* description: The adjustment's ID.
* code:
* type: string
* title: code
* description: The adjustment's code.
* amount:
* type: number
* title: amount
* description: The adjustment's amount.
* cart_id:
* type: string
* title: cart_id
* description: The ID of the associated cart.
* description:
* type: string
* title: description
* description: The adjustment's description.
* promotion_id:
* type: string
* title: promotion_id
* description: The ID of the applied promotion.
* provider_id:
* type: string
* title: provider_id
* description: The adjustment's provider ID.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the adjustment was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the adjustment was updated.
* - type: object
* description: The adjustment's details.
* required:
* - shipping_method
* properties:
* shipping_method:
* type: object
* title: shipping_method
* description: The details of the method that the adjustment belongs to.
* description: The adjustment's details.
* created_at:
* type: string
* format: date-time
www/utils/generated/oas-output/schemas/StoreCollection.ts
+2 -2
View File
@@ -4,13 +4,13 @@
* description: The collection's details.
* x-schemaName: StoreCollection
* required:
* - id
* - title
* - metadata
* - id
* - handle
* - created_at
* - updated_at
* - deleted_at
* - metadata
* properties:
* id:
* type: string
www/utils/generated/oas-output/schemas/StoreCurrency.ts
-1
View File
@@ -10,7 +10,6 @@
* - name
* - decimal_digits
* - rounding
* - raw_rounding
* - created_at
* - updated_at
* - deleted_at
www/utils/generated/oas-output/schemas/StoreCustomer.ts
+3 -3
View File
@@ -4,14 +4,14 @@
* description: The customer's details.
* x-schemaName: StoreCustomer
* required:
* - addresses
* - id
* - email
* - default_billing_address_id
* - default_shipping_address_id
* - company_name
* - first_name
* - last_name
* - addresses
* - default_billing_address_id
* - default_shipping_address_id
* properties:
* id:
* type: string
www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts
+1 -1
View File
@@ -86,7 +86,7 @@
* description: The address's phone.
* metadata:
* type: object
* description: The address's metadata, can hold custom key-value pairs.
* description: The address's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
www/utils/generated/oas-output/schemas/StoreOrderAddress.ts
-78
View File
@@ -1,78 +0,0 @@
/**
* @schema StoreOrderAddress
* type: object
* description: The address's details.
* x-schemaName: StoreOrderAddress
* required:
* - id
* - metadata
* - created_at
* - updated_at
* properties:
* country:
* $ref: "#/components/schemas/StoreRegionCountry"
* id:
* type: string
* title: id
* description: The address's ID.
* customer_id:
* type: string
* title: customer_id
* description: The ID of the customer this address belongs to.
* first_name:
* type: string
* title: first_name
* description: The address's first name.
* last_name:
* type: string
* title: last_name
* description: The address's last name.
* phone:
* type: string
* title: phone
* description: The address's phone.
* company:
* type: string
* title: company
* description: The address's company.
* address_1:
* type: string
* title: address_1
* description: The address's first line.
* address_2:
* type: string
* title: address_2
* description: The address's second line.
* city:
* type: string
* title: city
* description: The address's city.
* country_code:
* type: string
* title: country_code
* description: The address's country code.
* example: us
* province:
* type: string
* title: province
* description: The address's province.
* postal_code:
* type: string
* title: postal_code
* description: The address's postal code.
* metadata:
* type: object
* description: The address's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the address was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the address was updated.
*
*/
www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts
-81
View File
@@ -1,81 +0,0 @@
/**
* @schema StoreOrderFulfillment
* type: object
* description: The fulfillment's details.
* x-schemaName: StoreOrderFulfillment
* required:
* - id
* - location_id
* - packed_at
* - shipped_at
* - delivered_at
* - canceled_at
* - requires_shipping
* - data
* - provider_id
* - shipping_option_id
* - metadata
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The fulfillment's ID.
* location_id:
* type: string
* title: location_id
* description: The ID of the location the items are fulfilled from.
* packed_at:
* type: string
* title: packed_at
* description: The date the fulfillment was packed.
* format: date-time
* shipped_at:
* type: string
* title: shipped_at
* description: The date the fulfillment was shipped.
* format: date-time
* delivered_at:
* type: string
* title: delivered_at
* description: The date the fulfillment was delivered.
* format: date-time
* canceled_at:
* type: string
* title: canceled_at
* description: The date the fulfillment was canceled.
* format: date-time
* requires_shipping:
* type: boolean
* title: requires_shipping
* description: Whether the fulfillment requires shipping.
* data:
* type: object
* description: The fulfillment's data, useful for the fulfillment providering handling it.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/item-fulfillment#data-property
* provider_id:
* type: string
* title: provider_id
* description: The ID of the provider handling this fulfillment.
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The ID of the associated shipping option.
* metadata:
* type: object
* description: The fulfillment's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the fulfillment was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the fulfillment was updated.
*
*/
www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts
-218
View File
@@ -1,218 +0,0 @@
/**
* @schema StoreOrderLineItem
* type: object
* description: The item's details.
* x-schemaName: StoreOrderLineItem
* required:
* - title
* - id
* - metadata
* - created_at
* - updated_at
* - item_total
* - item_subtotal
* - item_tax_total
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - subtitle
* - thumbnail
* - variant_id
* - product_id
* - product_title
* - product_description
* - product_subtitle
* - product_type
* - product_collection
* - product_handle
* - variant_sku
* - variant_barcode
* - variant_title
* - variant_option_values
* - requires_shipping
* - is_discountable
* - is_tax_inclusive
* - unit_price
* - quantity
* - detail
* - refundable_total
* - refundable_total_per_unit
* properties:
* variant:
* $ref: "#/components/schemas/StoreProductVariant"
* product:
* $ref: "#/components/schemas/StoreProduct"
* title:
* type: string
* title: title
* description: The item's title.
* id:
* type: string
* title: id
* description: The item's ID.
* metadata:
* type: object
* description: The item's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the item was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the item was updated.
* item_total:
* type: number
* title: item_total
* description: The total of a single quantity including taxes and promotions.
* item_subtotal:
* type: number
* title: item_subtotal
* description: The total of a single quantity excluding taxes, including promotions.
* item_tax_total:
* type: number
* title: item_tax_total
* description: The total taxes of a single quantity, including promotions.
* original_total:
* type: number
* title: original_total
* description: The item's total including taxes, excluding promotions.
* original_subtotal:
* type: number
* title: original_subtotal
* description: The item's total excluding taxes, including promotions.
* original_tax_total:
* type: number
* title: original_tax_total
* description: The total taxes of the item, excluding promotions.
* total:
* type: number
* title: total
* description: The item's total including taxes and promotions.
* subtotal:
* type: number
* title: subtotal
* description: The item's total excluding taxes, including promotions.
* tax_total:
* type: number
* title: tax_total
* description: The total taxes of the item, including promotions.
* discount_total:
* type: number
* title: discount_total
* description: The item's discount total.
* discount_tax_total:
* type: number
* title: discount_tax_total
* description: The total taxes applied on the discount amount.
* subtitle:
* type: string
* title: subtitle
* description: The item's subtitle.
* thumbnail:
* type: string
* title: thumbnail
* description: The item's thumbnail URL.
* variant_id:
* type: string
* title: variant_id
* description: The ID of the item's variant.
* product_id:
* type: string
* title: product_id
* description: The ID of the associated product.
* 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 ID of the associated product's type.
* product_collection:
* type: string
* title: product_collection
* description: The ID of the associated product's 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 associated variant's values of the associated product's options.
* example:
* Color: Red
* requires_shipping:
* type: boolean
* title: requires_shipping
* description: Whether the item requires shipping.
* is_discountable:
* type: boolean
* title: is_discountable
* description: Whether the item is discountable.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: Whether the item includes taxes.
* compare_at_unit_price:
* type: number
* title: compare_at_unit_price
* description: The original price of the item before a promotion or sale.
* unit_price:
* type: number
* title: unit_price
* description: The item's unit price.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* tax_lines:
* type: array
* description: The item's tax lines.
* items:
* $ref: "#/components/schemas/BaseOrderLineItemTaxLine"
* adjustments:
* type: array
* description: The item's adjustments.
* items:
* $ref: "#/components/schemas/BaseOrderLineItemAdjustment"
* detail:
* $ref: "#/components/schemas/BaseOrderItemDetail"
* refundable_total:
* type: number
* title: refundable_total
* description: The refundable amount of the item.
* refundable_total_per_unit:
* type: number
* title: refundable_total_per_unit
* description: The refundable amount for a single quantity of the item.
*
*/
www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts
-118
View File
@@ -1,118 +0,0 @@
/**
* @schema StoreOrderShippingMethod
* type: object
* description: The shipping method's details.
* x-schemaName: StoreOrderShippingMethod
* required:
* - id
* - order_id
* - name
* - amount
* - is_tax_inclusive
* - shipping_option_id
* - data
* - metadata
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The shipping method's ID.
* order_id:
* type: string
* title: order_id
* description: The ID of the associated order.
* name:
* type: string
* title: name
* description: The shipping method's name.
* description:
* type: string
* title: description
* description: The shipping method's description.
* amount:
* type: number
* title: amount
* description: The shipping method's amount.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: Whether the shipping method's amount includes taxes.
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The ID of the associated shipping method.
* data:
* type: object
* description: The shipping method's data, useful for the provider handling its fulfillment.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property
* metadata:
* type: object
* description: The shipping method's metadata, can hold custom key-value pairs.
* tax_lines:
* type: array
* description: The shipping method's tax lines.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethodTaxLine"
* adjustments:
* type: array
* description: The shipping method's adjustments.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethodAdjustment"
* original_total:
* type: number
* title: original_total
* description: The total of the shipping method including taxes, excluding promotions.
* original_subtotal:
* type: number
* title: original_subtotal
* description: The total of the shipping method excluding taxes, including promotions.
* original_tax_total:
* type: number
* title: original_tax_total
* description: The total taxes of the shipping method, excluding promotion.
* total:
* type: number
* title: total
* description: The total of the shipping method including taxes and promotions.
* detail:
* $ref: "#/components/schemas/BaseOrderShippingDetail"
* subtotal:
* type: number
* title: subtotal
* description: The shipping method's subtotal.
* tax_total:
* type: number
* title: tax_total
* description: The shipping method's tax total.
* discount_total:
* type: number
* title: discount_total
* description: The shipping method's discount total.
* discount_tax_total:
* type: number
* title: discount_tax_total
* description: The shipping method's discount tax total.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the shipping method was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the shipping method was updated.
*
*/
www/utils/generated/oas-output/schemas/StoreReturn.ts
+5 -14
View File
@@ -4,14 +4,13 @@
* description: The return's details.
* x-schemaName: StoreReturn
* required:
* - id
* - order_id
* - order_version
* - display_id
* - items
* - received_at
* - order_id
* - id
* - created_at
* - display_id
* - canceled_at
* - received_at
* properties:
* id:
* type: string
@@ -37,18 +36,10 @@
* type: string
* title: claim_id
* description: The ID of the associated claim.
* order_version:
* type: number
* title: order_version
* description: The version of the order when the return is applied.
* display_id:
* type: number
* title: display_id
* description: The return's display ID.
* no_notification:
* type: boolean
* title: no_notification
* description: Whether the customer should receive updates about changes in the return.
* refund_amount:
* type: number
* title: refund_amount
@@ -57,7 +48,7 @@
* type: array
* description: The return's items.
* items:
* $ref: "#/components/schemas/BaseReturnItem"
* $ref: "#/components/schemas/StoreReturnItem"
* received_at:
* type: string
* title: received_at
www/utils/generated/oas-output/schemas/StoreShippingOption.ts
+3 -2
View File
@@ -28,7 +28,8 @@
* description: The shipping option's name.
* price_type:
* type: string
* description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider.
* description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated
* fulfillment provider.
* enum:
* - flat
* - calculated
@@ -47,7 +48,7 @@
* title: shipping_option_type_id
* description: The ID of the shipping option's type.
* type:
* $ref: "#/components/schemas/StoreShippingOption"
* $ref: "#/components/schemas/StoreShippingOptionType"
* shipping_profile_id:
* type: string
* title: shipping_profile_id
www/utils/generated/oas-output/schemas/UpdateOrderReturnReason.ts
-28
View File
@@ -1,28 +0,0 @@
/**
* @schema UpdateOrderReturnReason
* type: object
* description: The details to update in a return reason.
* x-schemaName: UpdateOrderReturnReason
* properties:
* id:
* type: string
* title: id
* description: The return reason's ID.
* label:
* type: string
* title: label
* description: The return reason's label.
* value:
* type: string
* title: value
* description: The return reason's value.
* description:
* type: string
* title: description
* description: The return reason's description.
* metadata:
* type: object
* description: The return reason's metadata, can hold custom key-value pairs.
*
*/