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

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

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

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-10-18 17:14:26 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 2ea766daf5
commit 8209d936a0
595 changed files with 33468 additions and 13327 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts
+2 -2
View File
@@ -5,9 +5,9 @@
* x-schemaName: AdminCreateFulfillment
* required:
* - data
* - order_id
* - metadata
* - items
* - metadata
* - order_id
* - location_id
* - provider_id
* - delivery_address
www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts
+74 -12
View File
@@ -4,22 +4,84 @@
* description: The shipping option's details.
* x-schemaName: AdminCreateShippingOption
* required:
* - label
* - description
* - code
* - name
* - service_zone_id
* - shipping_profile_id
* - price_type
* - provider_id
* - type
* - prices
* properties:
* label:
* name:
* type: string
* title: label
* description: The type's label.
* description:
* title: name
* description: The shipping option's name.
* service_zone_id:
* type: string
* title: description
* description: The type's description.
* code:
* title: service_zone_id
* description: The ID of the associated service zone.
* shipping_profile_id:
* type: string
* title: code
* description: The type's code.
* title: shipping_profile_id
* description: The ID of the associated shipping profile.
* data:
* type: object
* description: The shipping option's data, useful for the fulfillment provider handling its processing.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* price_type:
* type: string
* description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider.
* enum:
* - flat
* - calculated
* provider_id:
* type: string
* title: provider_id
* description: The ID of the fulfillment provider handling this shipping option.
* type:
* $ref: "#/components/schemas/AdminCreateShippingOptionType"
* prices:
* type: array
* description: The shipping option's prices.
* items:
* oneOf:
* - type: object
* description: The price's details.
* x-schemaName: AdminCreateShippingOptionPriceWithCurrency
* required:
* - currency_code
* - amount
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* example: usd
* amount:
* type: number
* title: amount
* description: The price's amount.
* - type: object
* description: The price's details.
* x-schemaName: AdminCreateShippingOptionPriceWithRegion
* required:
* - region_id
* - amount
* properties:
* region_id:
* type: string
* title: region_id
* description: The ID of the region this price is used in.
* amount:
* type: number
* title: amount
* description: The price's amount.
* rules:
* type: array
* description: The shipping option's rules.
* items:
* $ref: "#/components/schemas/AdminCreateShippingOptionRule"
*
*/
www/utils/generated/oas-output/schemas/AdminCreateShippingOptionType.ts
+25
View File
@@ -0,0 +1,25 @@
/**
* @schema AdminCreateShippingOptionType
* type: object
* description: The shipping option type's details.
* x-schemaName: AdminCreateShippingOptionType
* required:
* - label
* - description
* - code
* properties:
* 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.
*
*/
www/utils/generated/oas-output/schemas/AdminExchange.ts
+1 -1
View File
@@ -93,7 +93,7 @@
* title: deleted_at
* description: The date the exchange was deleted.
* order:
* $ref: "#/components/schemas/AdminOrder"
* $ref: "#/components/schemas/BaseOrder"
* allow_backorder:
* type: boolean
* title: allow_backorder
www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts
-1
View File
@@ -8,7 +8,6 @@
* - exchange
* properties:
* order:
* description: The details of the associated order.
* $ref: "#/components/schemas/Order"
* exchange:
* $ref: "#/components/schemas/AdminExchange"
www/utils/generated/oas-output/schemas/AdminOrder.ts
+3 -3
View File
@@ -9,16 +9,16 @@
* - shipping_methods
* - currency_code
* - id
* - created_at
* - updated_at
* - email
* - version
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - payment_status
* - fulfillment_status
* - summary
* - created_at
* - updated_at
* - original_item_total
* - original_item_subtotal
* - original_item_tax_total
www/utils/generated/oas-output/schemas/AdminOrderChange.ts
+4 -8
View File
@@ -10,12 +10,12 @@
* - exchange
* - actions
* - status
* - order_id
* - metadata
* - id
* - version
* - metadata
* - created_at
* - updated_at
* - version
* - order_id
* - canceled_at
* - return_id
* - exchange_id
@@ -62,11 +62,7 @@
* title: claim_id
* description: The ID of the associated claim.
* order:
* type: string
* title: order
* description: The order change's order.
* externalDocs:
* url: "#pagination"
* $ref: "#/components/schemas/AdminOrder"
* return_order:
* $ref: "#/components/schemas/AdminReturn"
* exchange:
www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts
+3 -7
View File
@@ -6,11 +6,11 @@
* required:
* - order_change
* - order
* - order_id
* - internal_note
* - id
* - created_at
* - updated_at
* - order_id
* - internal_note
* - return_id
* - exchange_id
* - claim_id
@@ -47,11 +47,7 @@
* title: exchange_id
* description: The ID of the associated exchange.
* order:
* type: string
* title: order
* description: The order change's order.
* externalDocs:
* url: "#pagination"
* $ref: "#/components/schemas/AdminOrder"
* reference:
* type: string
* title: reference
www/utils/generated/oas-output/schemas/AdminOrderItem.ts
+50
View File
@@ -0,0 +1,50 @@
/**
* @schema AdminOrderItem
* type: object
* description: The order item's details.
* x-schemaName: AdminOrderItem
* required:
* - order_id
* - item_id
* - version
* - history
* - item
* properties:
* order_id:
* type: string
* title: order_id
* description: The ID of the order this item belongs to.
* item_id:
* type: string
* title: item_id
* description: The ID of the associated line item.
* version:
* type: number
* title: version
* description: The order item's version.
* history:
* type: object
* description: The order item's history.
* required:
* - version
* properties:
* version:
* type: object
* description: The version changes of the item.
* required:
* - from
* - to
* properties:
* from:
* type: number
* title: from
* description: The original version.
* to:
* type: number
* title: to
* description: The new version.
* item:
* $ref: "#/components/schemas/AdminOrderLineItem"
*
*/
www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts
+3 -3
View File
@@ -5,10 +5,8 @@
* x-schemaName: AdminOrderLineItem
* required:
* - title
* - metadata
* - id
* - subtitle
* - thumbnail
* - metadata
* - created_at
* - updated_at
* - item_total
@@ -22,6 +20,8 @@
* - tax_total
* - discount_total
* - discount_tax_total
* - subtitle
* - thumbnail
* - variant_id
* - product_id
* - product_title
www/utils/generated/oas-output/schemas/AdminOrderPreview.ts
+3 -3
View File
@@ -8,17 +8,17 @@
* - order_change
* - currency_code
* - id
* - created_at
* - updated_at
* - email
* - version
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - payment_collections
* - payment_status
* - fulfillment_status
* - summary
* - created_at
* - updated_at
* - original_item_total
* - original_item_subtotal
* - original_item_tax_total
www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts
+4
View File
@@ -37,6 +37,10 @@
* metadata:
* type: object
* description: The item's metadata, can hold custom key-value pairs.
* compare_at_unit_price:
* type: number
* title: compare_at_unit_price
* description: The original price of the item before a promotion or sale.
*
*/
www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts
+4
View File
@@ -16,6 +16,10 @@
* type: number
* title: unit_price
* description: The item's unit price.
* compare_at_unit_price:
* type: number
* title: compare_at_unit_price
* description: The original price of the item before a promotion or sale.
*
*/
www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts
+4
View File
@@ -18,6 +18,10 @@
* type: number
* title: unit_price
* description: The item's unit price.
* compare_at_unit_price:
* type: number
* title: compare_at_unit_price
* description: The original price of the item before a promotion or sale.
*
*/
www/utils/generated/oas-output/schemas/AdminProduct.ts
+4 -4
View File
@@ -13,10 +13,12 @@
* - status
* - description
* - id
* - handle
* - created_at
* - updated_at
* - subtitle
* - is_giftcard
* - thumbnail
* - handle
* - is_giftcard
* - width
* - weight
* - height
@@ -28,8 +30,6 @@
* - type_id
* - discountable
* - external_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* collection:
www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts
+16
View File
@@ -0,0 +1,16 @@
/**
* @schema AdminUpdateTaxRegion
* type: object
* description: The details to update in a tax region.
* x-schemaName: AdminUpdateTaxRegion
* properties:
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* metadata:
* type: object
* description: The tax region's metadata, can hold custom key-value pairs.
*
*/
www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts
-54
View File
@@ -53,63 +53,9 @@
* calculated_price:
* type: object
* description: The calculated price's details.
* properties:
* id:
* type: string
* title: id
* description: The calculated price's ID.
* price_list_id:
* type: string
* title: price_list_id
* description: The ID of the price list that the price belongs to.
* price_list_type:
* type: string
* title: price_list_type
* description: The price list's type. For example, `sale`.
* min_quantity:
* type: number
* title: min_quantity
* description: The minimum quantity required in the cart for this price to apply.
* max_quantity:
* type: number
* title: max_quantity
* description: The maximum quantity required in the cart for this price to apply.
* required:
* - id
* - price_list_id
* - price_list_type
* - min_quantity
* - max_quantity
* original_price:
* type: object
* description: The original price's details.
* properties:
* id:
* type: string
* title: id
* description: The original price's ID.
* price_list_id:
* type: string
* title: price_list_id
* description: The ID of the price list that the price belongs to.
* price_list_type:
* type: string
* title: price_list_type
* description: The price list's type. For example, `sale`.
* min_quantity:
* type: number
* title: min_quantity
* description: The minimum quantity required in the cart for this price to apply.
* max_quantity:
* type: number
* title: max_quantity
* description: The maximum quantity required in the cart for this price to apply.
* required:
* - id
* - price_list_id
* - price_list_type
* - min_quantity
* - max_quantity
*
*/
www/utils/generated/oas-output/schemas/BaseCollection.ts
+45 -1
View File
@@ -1,8 +1,52 @@
/**
* @schema BaseCollection
* type: object
* description: The collection's details.
* description: The product 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 collection's creation date.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The collection's update date.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The collection's deletion date.
* products:
* type: array
* description: The collection's products.
* items:
* $ref: "#/components/schemas/AdminProduct"
* metadata:
* type: object
* description: The collection's metadata, used to store custom key-value pairs.
*
*/
www/utils/generated/oas-output/schemas/BaseOrder.ts
+5 -10
View File
@@ -4,7 +4,6 @@
* description: The order's details.
* x-schemaName: BaseOrder
* required:
* - payment_collections
* - id
* - version
* - region_id
@@ -17,7 +16,6 @@
* - payment_status
* - fulfillment_status
* - summary
* - metadata
* - created_at
* - updated_at
* - original_item_total
@@ -47,20 +45,16 @@
* type: array
* description: The order's payment collections.
* items:
* $ref: "#/components/schemas/AdminPaymentCollection"
* $ref: "#/components/schemas/BasePaymentCollection"
* fulfillments:
* type: array
* description: The order's fulfillments.
* items:
* $ref: "#/components/schemas/BaseOrderFulfillment"
* sales_channel:
* $ref: "#/components/schemas/AdminSalesChannel"
* customer:
* $ref: "#/components/schemas/AdminCustomer"
* shipping_address:
* $ref: "#/components/schemas/AdminOrderAddress"
* $ref: "#/components/schemas/BaseOrderAddress"
* billing_address:
* $ref: "#/components/schemas/AdminOrderAddress"
* $ref: "#/components/schemas/BaseOrderAddress"
* id:
* type: string
* title: id
@@ -239,4 +233,5 @@
* title: original_shipping_tax_total
* description: The tax total of the order's shipping excluding promotions.
*
*/
*/
www/utils/generated/oas-output/schemas/BaseOrderAddress.ts
+1 -3
View File
@@ -1,7 +1,7 @@
/**
* @schema BaseOrderAddress
* type: object
* description: An order address
* description: An order address.
* x-schemaName: BaseOrderAddress
* required:
* - id
@@ -50,8 +50,6 @@
* title: country_code
* description: The address's country code.
* example: us
* country:
* $ref: "#/components/schemas/AdminRegionCountry"
* province:
* type: string
* title: province
www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts
+7 -1
View File
@@ -1,7 +1,7 @@
/**
* @schema BaseOrderFulfillment
* type: object
* description: The fulfillment's fulfillments.
* description: The fulfillment's details.
* x-schemaName: BaseOrderFulfillment
* required:
* - id
@@ -10,6 +10,7 @@
* - shipped_at
* - delivered_at
* - canceled_at
* - requires_shipping
* - data
* - provider_id
* - shipping_option_id
@@ -71,5 +72,10 @@
* format: date-time
* title: updated_at
* description: The date the fulfillment was updated.
* requires_shipping:
* type: boolean
* title: requires_shipping
* description: Whether the fulfillment requires shipping.
*
*/
www/utils/generated/oas-output/schemas/BasePaymentProvider.ts
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* @schema BasePaymentProvider
* type: object
* description: The payment provider's payment providers.
* description: The payment provider's details.
* x-schemaName: BasePaymentProvider
* required:
* - id
www/utils/generated/oas-output/schemas/BaseProductCategory.ts
+78 -1
View File
@@ -1,8 +1,85 @@
/**
* @schema BaseProductCategory
* type: object
* description: The category's categories.
* description: The product category's details.
* x-schemaName: BaseProductCategory
* required:
* - id
* - name
* - description
* - handle
* - is_active
* - is_internal
* - rank
* - parent_category_id
* - parent_category
* - category_children
* - created_at
* - updated_at
* - deleted_at
* properties:
* category_children:
* type: array
* description: The category's children.
* items:
* $ref: "#/components/schemas/BaseProductCategory"
* parent_category:
* $ref: "#/components/schemas/BaseProductCategory"
* products:
* type: array
* description: The category's products.
* items:
* $ref: "#/components/schemas/BaseProduct"
* name:
* type: string
* title: name
* description: The category's name.
* description:
* type: string
* title: description
* description: The category's description.
* id:
* type: string
* title: id
* description: The category's ID.
* metadata:
* type: object
* description: The category's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the category was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the category was updated.
* handle:
* type: string
* title: handle
* description: The category's unique handle.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the category was deleted.
* is_active:
* type: boolean
* title: is_active
* description: Whether the category is active. If disabled, the category isn't shown in the storefront.
* is_internal:
* type: boolean
* title: is_internal
* description: Whether the category is internal. If enabled, the category is only seen by admin users.
* rank:
* type: number
* title: rank
* description: The category's rank among sibling categories.
* parent_category_id:
* type: string
* title: parent_category_id
* description: The ID of the category's parent.
*
*/
www/utils/generated/oas-output/schemas/BaseProductOption.ts
+11 -11
View File
@@ -3,47 +3,47 @@
* type: object
* description: The product option's details.
* x-schemaName: BaseProductOption
* required:
* - id
* - title
* properties:
* id:
* type: string
* title: id
* description: The option's ID.
* description: The product option's ID.
* title:
* type: string
* title: title
* description: The option's title.
* description: The product option's title.
* product:
* $ref: "#/components/schemas/BaseProduct"
* product_id:
* type: string
* title: product_id
* description: The option's product id.
* description: The ID of the product this option belongs to.
* values:
* type: array
* description: The option's values.
* description: The product option's values.
* items:
* $ref: "#/components/schemas/BaseProductOptionValue"
* metadata:
* type: object
* description: The option's metadata.
* description: The product option's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The option's created at.
* description: The date the product option was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The option's updated at.
* description: The date the product option was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The option's deleted at.
* required:
* - id
* - title
* description: The date the product option was deleted.
*
*/
www/utils/generated/oas-output/schemas/BaseProductTag.ts
+33 -1
View File
@@ -1,8 +1,40 @@
/**
* @schema BaseProductTag
* type: object
* description: The tag's tags.
* description: The product tag's details.
* x-schemaName: BaseProductTag
* required:
* - id
* - value
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The tag's ID.
* value:
* type: string
* title: value
* description: The tag's value.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the tag was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the tag was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the tag was deleted.
* metadata:
* type: object
* description: The tag's metadata, can hold custom key-value pairs.
*
*/
www/utils/generated/oas-output/schemas/Order.ts
-88
View File
@@ -33,28 +33,6 @@
* - 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
@@ -230,72 +208,6 @@
* type: number
* title: original_shipping_tax_total
* description: The total taxes of the order's shipping excluding promotions.
* raw_original_item_total:
* type: object
* description: The order's raw original item total.
* raw_original_item_subtotal:
* type: object
* description: The order's raw original item subtotal.
* raw_original_item_tax_total:
* type: object
* description: The order's raw original item tax total.
* raw_item_total:
* type: object
* description: The order's raw item total.
* raw_item_subtotal:
* type: object
* description: The order's raw item subtotal.
* raw_item_tax_total:
* type: object
* description: The order's raw item tax total.
* raw_original_total:
* type: object
* description: The order's raw original total.
* raw_original_subtotal:
* type: object
* description: The order's raw original subtotal.
* raw_original_tax_total:
* type: object
* description: The order's raw original tax total.
* raw_total:
* type: object
* description: The order's raw total.
* raw_subtotal:
* type: object
* description: The order's raw subtotal.
* raw_tax_total:
* type: object
* description: The order's raw tax total.
* raw_discount_total:
* type: object
* description: The order's raw discount total.
* raw_discount_tax_total:
* type: object
* description: The order's raw discount tax total.
* raw_gift_card_total:
* type: object
* description: The order's raw gift card total.
* raw_gift_card_tax_total:
* type: object
* description: The order's raw gift card tax total.
* raw_shipping_total:
* type: object
* description: The order's raw shipping total.
* raw_shipping_subtotal:
* type: object
* description: The order's raw shipping subtotal.
* raw_shipping_tax_total:
* type: object
* description: The order's raw shipping tax total.
* raw_original_shipping_total:
* type: object
* description: The order's raw original shipping total.
* raw_original_shipping_subtotal:
* type: object
* description: The order's raw original shipping subtotal.
* raw_original_shipping_tax_total:
* type: object
* description: The order's raw original shipping tax total.
*
*/
www/utils/generated/oas-output/schemas/OrderClaim.ts
+58 -188
View File
@@ -4,44 +4,14 @@
* description: The order change's claim.
* x-schemaName: OrderClaim
* required:
* - id
* - type
* - order_id
* - order_version
* - display_id
* - claim_items
* - additional_items
* - currency_code
* - id
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - shipping_methods
* - payment_status
* - fulfillment_status
* - summary
* - metadata
* - created_at
* - updated_at
* - original_item_total
* - original_item_subtotal
* - original_item_tax_total
* - item_total
* - item_subtotal
* - item_tax_total
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - gift_card_total
* - gift_card_tax_total
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
* properties:
* id:
* type: string
@@ -72,79 +42,29 @@
* title: no_notification
* description: Whether the customer should be notified about changes in the claim.
* refund_amount:
* type: number
* title: refund_amount
* oneOf:
* - type: string
* title: refund_amount
* description: The claim's refund amount.
* - type: number
* title: refund_amount
* description: The claim's refund amount.
* - type: string
* title: refund_amount
* description: The claim's refund amount.
* - type: number
* title: refund_amount
* description: The claim's refund amount.
* description: The amount to be refunded.
* currency_code:
* type: string
* title: currency_code
* description: The claim's currency code.
* region_id:
* type: string
* title: region_id
* description: The ID of the region associated with the claim.
* customer_id:
* type: string
* title: customer_id
* description: The ID of the customer associated with the claim's order.
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The ID of the sales channel the claim's order is created in.
* email:
* type: string
* title: email
* description: The email associated with the claim's order.
* format: email
* display_id:
* type: number
* title: display_id
* description: The claim's display ID.
* shipping_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* billing_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* shipping_methods:
* type: array
* description: The claim's shipping methods.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethod"
* payment_collections:
* type: array
* description: The claim's payment collections.
* items:
* $ref: "#/components/schemas/BasePaymentCollection"
* payment_status:
* type: string
* description: The claim's payment status.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* fulfillments:
* type: array
* description: The claim's fulfillments.
* items:
* $ref: "#/components/schemas/BaseOrderFulfillment"
* fulfillment_status:
* type: string
* description: The claim's fulfillment status.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* $ref: "#/components/schemas/OrderShippingMethod"
* transactions:
* type: array
* description: The claim's transactions.
@@ -152,9 +72,7 @@
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
* description: Learn more about transactions of orders and associated models.
* items:
* $ref: "#/components/schemas/BaseOrderTransaction"
* summary:
* $ref: "#/components/schemas/BaseOrderSummary"
* $ref: "#/components/schemas/OrderTransaction"
* metadata:
* type: object
* description: The claim's metadata, used to store custom key-value pairs.
@@ -168,94 +86,46 @@
* format: date-time
* title: updated_at
* description: The claim's update date.
* original_item_total:
* type:
* type: string
* description: The claim's type.
* enum:
* - replace
* - refund
* order:
* $ref: "#/components/schemas/Order"
* order_version:
* type: number
* title: original_item_total
* description: The total of the original items in the associated order.
* original_item_subtotal:
* type: number
* title: original_item_subtotal
* description: The subtotal of the original items in the associated order.
* original_item_tax_total:
* type: number
* title: original_item_tax_total
* description: The tax total of the original items in the associated order.
* item_total:
* type: number
* title: item_total
* description: The total of the claim's items.
* item_subtotal:
* type: number
* title: item_subtotal
* description: The subtotal of the claim's items.
* item_tax_total:
* type: number
* title: item_tax_total
* description: The tax total of the claim's items.
* original_total:
* type: number
* title: original_total
* description: The associated order's original total.
* original_subtotal:
* type: number
* title: original_subtotal
* description: The associated order's original subtotal.
* original_tax_total:
* type: number
* title: original_tax_total
* description: The associated order's original tax total.
* total:
* type: number
* title: total
* description: The associated order's total.
* subtotal:
* type: number
* title: subtotal
* description: The claim's subtotal.
* tax_total:
* type: number
* title: tax_total
* description: The claim's tax total.
* discount_total:
* type: number
* title: discount_total
* description: The claim's discount total.
* discount_tax_total:
* type: number
* title: discount_tax_total
* description: The claim's discount tax total.
* gift_card_total:
* type: number
* title: gift_card_total
* description: The claim's gift card total.
* gift_card_tax_total:
* type: number
* title: gift_card_tax_total
* description: The claim's gift card tax total.
* shipping_total:
* type: number
* title: shipping_total
* description: The claim's shipping total.
* shipping_subtotal:
* type: number
* title: shipping_subtotal
* description: The claim's shipping subtotal.
* shipping_tax_total:
* type: number
* title: shipping_tax_total
* description: The claim's shipping tax total.
* original_shipping_total:
* type: number
* title: original_shipping_total
* description: The associated order's original shipping total.
* original_shipping_subtotal:
* type: number
* title: original_shipping_subtotal
* description: The associated order's original shipping subtotal.
* original_shipping_tax_total:
* type: number
* title: original_shipping_tax_total
* description: The associated order's original shipping tax total.
* title: order_version
* description: The claim's order version.
* raw_refund_amount:
* oneOf:
* - type: string
* title: raw_refund_amount
* description: The claim's raw refund amount.
* - type: number
* title: raw_refund_amount
* description: The claim's raw refund amount.
* - type: string
* title: raw_refund_amount
* description: The claim's raw refund amount.
* - type: number
* title: raw_refund_amount
* description: The claim's raw refund amount.
* created_by:
* type: string
* title: created_by
* description: The ID of the user that created the claim.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the claim was deleted.
* canceled_at:
* type: string
* title: canceled_at
* description: The date the claim was canceled.
* format: date-time
*
*/
www/utils/generated/oas-output/schemas/OrderExchange.ts
+44 -198
View File
@@ -4,54 +4,17 @@
* description: The order change's exchange.
* x-schemaName: OrderExchange
* required:
* - order_id
* - return_items
* - additional_items
* - currency_code
* - id
* - region_id
* - customer_id
* - sales_channel_id
* - email
* - shipping_methods
* - payment_status
* - fulfillment_status
* - summary
* - order_id
* - order_version
* - display_id
* - additional_items
* - metadata
* - created_at
* - updated_at
* - original_item_total
* - original_item_subtotal
* - original_item_tax_total
* - item_total
* - item_subtotal
* - item_tax_total
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - gift_card_total
* - gift_card_tax_total
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
* properties:
* order_id:
* type: string
* title: order_id
* description: The ID of the order the exchange is created for.
* return_items:
* type: array
* description: The items returned (inbound) by the exchange.
* items:
* $ref: "#/components/schemas/AdminReturnItem"
* additional_items:
* type: array
* description: The new items (outbound) sent by the exchange.
@@ -66,98 +29,31 @@
* title: difference_due
* description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
* return:
* description: the return associated with the exchange.
* $ref: "#/components/schemas/AdminReturn"
* $ref: "#/components/schemas/Return"
* return_id:
* type: string
* title: return_id
* description: The ID of the associated exchange.
* currency_code:
* type: string
* title: currency_code
* description: The exchange's currency code.
* id:
* type: string
* title: id
* description: The exchange's ID.
* region_id:
* type: string
* title: region_id
* description: The ID of the associated order's region.
* customer_id:
* type: string
* title: customer_id
* description: The ID of the customer that placed the order.
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The ID of the sales channel the associated order belongs to.
* email:
* type: string
* title: email
* description: The email used when placing the order.
* format: email
* display_id:
* type: number
* title: display_id
* description: The exchange's display ID.
* shipping_address:
* description: The shipping address to send new items to.
* $ref: "#/components/schemas/BaseOrderAddress"
* billing_address:
* description: The customer's billing address.
* $ref: "#/components/schemas/BaseOrderAddress"
* shipping_methods:
* type: array
* description: The shipping methods used to send the new (outbound) items.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethod"
* payment_collections:
* type: array
* description: The exchange's payment collections.
* items:
* $ref: "#/components/schemas/BasePaymentCollection"
* payment_status:
* type: string
* description: The exchange's payment status.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* fulfillments:
* type: array
* description: The exchange's fulfillments of new (outbound) items.
* items:
* $ref: "#/components/schemas/BaseOrderFulfillment"
* fulfillment_status:
* type: string
* description: The exchange's fulfillment status.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* $ref: "#/components/schemas/OrderShippingMethod"
* transactions:
* type: array
* description: The exchange's transactions.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
* items:
* $ref: "#/components/schemas/BaseOrderTransaction"
* summary:
* description: The totals summary of the exchange.
* $ref: "#/components/schemas/BaseOrderSummary"
* $ref: "#/components/schemas/OrderTransaction"
* metadata:
* type: object
* description: The exchange's metadata, can hold custom key-value pairs.
@@ -171,94 +67,44 @@
* format: date-time
* title: updated_at
* description: The date that the exchange was updated.
* original_item_total:
* order:
* $ref: "#/components/schemas/Order"
* order_version:
* type: number
* title: original_item_total
* description: The total of the original items in the order.
* original_item_subtotal:
* type: number
* title: original_item_subtotal
* description: The subtotal of the original items in the order.
* original_item_tax_total:
* type: number
* title: original_item_tax_total
* description: The total tax of the original items in the order.
* item_total:
* type: number
* title: item_total
* description: The total of the exchange's new items.
* item_subtotal:
* type: number
* title: item_subtotal
* description: The subtotal of the exchange's new items.
* item_tax_total:
* type: number
* title: item_tax_total
* description: The tax total of the exchange's new items.
* original_total:
* type: number
* title: original_total
* description: The total of the order.
* original_subtotal:
* type: number
* title: original_subtotal
* description: The subtotal of the order.
* original_tax_total:
* type: number
* title: original_tax_total
* description: The tax total of the order.
* total:
* type: number
* title: total
* description: The total of the exchange.
* subtotal:
* type: number
* title: subtotal
* description: The subtotal of the exchange.
* tax_total:
* type: number
* title: tax_total
* description: The tax total of the exchange.
* discount_total:
* type: number
* title: discount_total
* description: The discount total of the exchange.
* discount_tax_total:
* type: number
* title: discount_tax_total
* description: The total taxes on discount of the exchange.
* gift_card_total:
* type: number
* title: gift_card_total
* description: The gift cards total of the exchange.
* gift_card_tax_total:
* type: number
* title: gift_card_tax_total
* description: The total taxes on the gift card of the exchange.
* shipping_total:
* type: number
* title: shipping_total
* description: The exchange's shipping total.
* shipping_subtotal:
* type: number
* title: shipping_subtotal
* description: The exchange's shipping subtotal.
* shipping_tax_total:
* type: number
* title: shipping_tax_total
* description: The exchange's shipping tax total.
* original_shipping_total:
* type: number
* title: original_shipping_total
* description: The order's shipping total.
* original_shipping_subtotal:
* type: number
* title: original_shipping_subtotal
* description: The order's shipping subtotal.
* original_shipping_tax_total:
* type: number
* title: original_shipping_tax_total
* description: The order's shipping tax total.
* title: order_version
* description: The version of the order when the exchange is applied.
* raw_difference_due:
* oneOf:
* - type: string
* title: raw_difference_due
* description: The exchange's raw difference due.
* - type: number
* title: raw_difference_due
* description: The exchange's raw difference due.
* - type: string
* title: raw_difference_due
* description: The exchange's raw difference due.
* - type: number
* title: raw_difference_due
* description: The exchange's raw difference due.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: Whether variants that are out of stock can be added to the exchange as outbound items.
* created_by:
* type: string
* title: created_by
* description: The ID of the user that created the exchange.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the exchange was deleted.
* canceled_at:
* type: string
* title: canceled_at
* description: The date the exchange was canceled.
* format: date-time
*
*/
www/utils/generated/oas-output/schemas/OrderItem.ts
-32
View File
@@ -8,21 +8,13 @@
* - item_id
* - item
* - quantity
* - raw_quantity
* - fulfilled_quantity
* - raw_fulfilled_quantity
* - delivered_quantity
* - raw_delivered_quantity
* - shipped_quantity
* - raw_shipped_quantity
* - return_requested_quantity
* - raw_return_requested_quantity
* - return_received_quantity
* - raw_return_received_quantity
* - return_dismissed_quantity
* - raw_return_dismissed_quantity
* - written_off_quantity
* - raw_written_off_quantity
* - metadata
* - created_at
* - updated_at
@@ -41,58 +33,34 @@
* type: number
* title: quantity
* description: The item's quantity.
* raw_quantity:
* type: object
* description: The item's raw quantity.
* fulfilled_quantity:
* type: number
* title: fulfilled_quantity
* description: The item's fulfilled quantity.
* raw_fulfilled_quantity:
* type: object
* description: The item's raw fulfilled quantity.
* delivered_quantity:
* type: number
* title: delivered_quantity
* description: The item's delivered quantity.
* raw_delivered_quantity:
* type: object
* description: The item's raw delivered quantity.
* shipped_quantity:
* type: number
* title: shipped_quantity
* description: The item's shipped quantity.
* raw_shipped_quantity:
* type: object
* description: The item's raw shipped quantity.
* return_requested_quantity:
* type: number
* title: return_requested_quantity
* description: The item's quantity that's requested to be returned.
* raw_return_requested_quantity:
* type: object
* description: The item's raw return requested quantity.
* return_received_quantity:
* type: number
* title: return_received_quantity
* description: The item's quantity that's received through a return.
* raw_return_received_quantity:
* type: object
* description: The item's raw return received quantity.
* return_dismissed_quantity:
* type: number
* title: return_dismissed_quantity
* description: The item's quantity that's returned but dismissed because it's damaged.
* raw_return_dismissed_quantity:
* type: object
* description: The item's raw return dismissed quantity.
* written_off_quantity:
* type: number
* title: written_off_quantity
* description: The item's quantity that's removed due to an order change.
* raw_written_off_quantity:
* type: object
* description: The item's raw written off quantity.
* metadata:
* type: object
* description: The item's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/OrderLineItem.ts
-239
View File
@@ -10,9 +10,7 @@
* - is_discountable
* - is_tax_inclusive
* - unit_price
* - raw_unit_price
* - quantity
* - raw_quantity
* - detail
* - created_at
* - updated_at
@@ -29,19 +27,6 @@
* - 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
@@ -124,56 +109,14 @@
* type: number
* title: compare_at_unit_price
* description: The original price of the item before a promotion or sale.
* raw_compare_at_unit_price:
* type: object
* description: The item's raw compare at unit price.
* required:
* - value
* properties:
* value:
* oneOf:
* - type: string
* title: value
* description: The raw compare at unit price's value.
* - type: number
* title: value
* description: The raw compare at unit price's value.
* unit_price:
* type: number
* title: unit_price
* description: The item's price for a single quantity.
* raw_unit_price:
* type: object
* description: The item's raw unit price.
* required:
* - value
* properties:
* value:
* oneOf:
* - type: string
* title: value
* description: The raw unit price's value.
* - type: number
* title: value
* description: The raw unit price's value.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* raw_quantity:
* type: object
* description: The item's raw quantity.
* required:
* - value
* properties:
* value:
* oneOf:
* - type: string
* title: value
* description: The raw quantity's value.
* - type: number
* title: value
* description: The raw quantity's value.
* tax_lines:
* type: array
* description: The item's tax lines.
@@ -251,188 +194,6 @@
* type: number
* title: refundable_total_per_unit
* description: The total amount that can be refunded of a single quantity of the item.
* raw_original_total:
* type: object
* description: The item'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 item'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 item'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_item_total:
* type: object
* description: The item'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 item'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 item'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_total:
* type: object
* description: The item'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 item'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 item'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 item'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 item'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_refundable_total:
* type: object
* description: The item's raw refundable total.
* required:
* - value
* properties:
* value:
* oneOf:
* - type: string
* title: value
* description: The raw refundable total's value.
* - type: number
* title: value
* description: The raw refundable total's value.
* raw_refundable_total_per_unit:
* type: object
* description: The item's raw refundable total per unit.
* required:
* - value
* properties:
* value:
* oneOf:
* - type: string
* title: value
* description: The raw refundable total per unit's value.
* - type: number
* title: value
* description: The raw refundable total per unit's value.
*
*/
www/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts
-8
View File
@@ -8,8 +8,6 @@
* - item_id
* - total
* - subtotal
* - raw_total
* - raw_subtotal
* - id
* - code
* - rate
@@ -30,12 +28,6 @@
* type: number
* title: subtotal
* description: The item's total excluding taxes, including promotions.
* raw_total:
* type: object
* description: The tax line's raw total.
* raw_subtotal:
* type: object
* description: The tax line's raw subtotal.
* id:
* type: string
* title: id
www/utils/generated/oas-output/schemas/OrderReturnItem.ts
+17 -12
View File
@@ -5,11 +5,10 @@
* x-schemaName: OrderReturnItem
* required:
* - id
* - quantity
* - received_quantity
* - damaged_quantity
* - item_id
* - return_id
* - order_id
* - item_id
* - quantity
* properties:
* id:
* type: string
@@ -23,18 +22,10 @@
* type: number
* title: received_quantity
* description: The received quantity of the item. This quantity is added to the stocked inventory quantity of the item.
* damaged_quantity:
* type: number
* title: damaged_quantity
* description: The received damaged quantity of the item, which isn't added to the stocked inventory quantity of the item.
* reason_id:
* type: string
* title: reason_id
* description: The ID of the return reason associated with the item.
* note:
* type: string
* title: note
* description: A note about why the item was returned.
* item_id:
* type: string
* title: item_id
@@ -46,6 +37,20 @@
* metadata:
* type: object
* description: The return item's metadata, can hold custom key-value pairs.
* order_id:
* type: string
* title: order_id
* description: The ID of the order the return belongs to.
* 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.
*
*/
www/utils/generated/oas-output/schemas/OrderShippingMethod.ts
-135
View File
@@ -8,7 +8,6 @@
* - order_id
* - name
* - amount
* - raw_amount
* - is_tax_inclusive
* - created_at
* - updated_at
@@ -20,14 +19,6 @@
* - 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
@@ -49,20 +40,6 @@
* type: number
* title: amount
* description: The shipping method's amount.
* raw_amount:
* type: object
* description: The shipping method's raw amount.
* required:
* - value
* properties:
* value:
* oneOf:
* - type: string
* title: value
* description: The raw amount's value.
* - type: number
* title: value
* description: The raw amount's value.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
@@ -131,118 +108,6 @@
* type: number
* title: discount_tax_total
* description: The total taxes of the discount amount.
* raw_original_total:
* type: object
* description: The shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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.
*
*/
www/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts
-8
View File
@@ -8,8 +8,6 @@
* - shipping_method_id
* - total
* - subtotal
* - raw_total
* - raw_subtotal
* - id
* - code
* - rate
@@ -30,12 +28,6 @@
* type: number
* title: subtotal
* description: The shipping method's total excluding taxes, including promotions.
* raw_total:
* type: object
* description: The tax line's raw total.
* raw_subtotal:
* type: object
* description: The tax line's raw subtotal.
* id:
* type: string
* title: id
www/utils/generated/oas-output/schemas/OrderTransaction.ts
+5 -1
View File
@@ -6,6 +6,7 @@
* required:
* - id
* - order_id
* - order
* - amount
* - currency_code
* - reference
@@ -55,5 +56,8 @@
* format: date-time
* title: updated_at
* description: The date that the transaction was updated.
* order:
* $ref: "#/components/schemas/Order"
*
*/
*/
www/utils/generated/oas-output/schemas/Return.ts
+60 -236
View File
@@ -8,54 +8,8 @@
* - status
* - order_id
* - items
* - currency_code
* - created_at
* - updated_at
* - original_item_total
* - original_item_subtotal
* - original_item_tax_total
* - item_total
* - item_subtotal
* - item_tax_total
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - gift_card_total
* - gift_card_tax_total
* - shipping_total
* - shipping_subtotal
* - shipping_tax_total
* - original_shipping_total
* - original_shipping_subtotal
* - original_shipping_tax_total
* - discount_subtotal
* - 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
* - display_id
* - metadata
* properties:
* id:
* type: string
@@ -82,32 +36,6 @@
* description: The return's items.
* items:
* $ref: "#/components/schemas/OrderReturnItem"
* region_id:
* type: string
* title: region_id
* description: The ID of the region this return belongs to.
* customer_id:
* type: string
* title: customer_id
* description: The ID of the customer that placed the order.
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The ID of the associated order's sales channel.
* email:
* type: string
* title: email
* description: The email of the customer that placed the order.
* format: email
* currency_code:
* type: string
* title: currency_code
* description: The return's currency code.
* example: usd
* shipping_address:
* $ref: "#/components/schemas/OrderAddress"
* billing_address:
* $ref: "#/components/schemas/OrderAddress"
* shipping_methods:
* type: array
* description: The return's shipping methods.
@@ -118,9 +46,6 @@
* description: The return's transactions.
* items:
* $ref: "#/components/schemas/OrderTransaction"
* summary:
* type: object
* description: The return's summary.
* metadata:
* type: object
* description: The return's metadata, can hold custom key-value pairs.
@@ -134,171 +59,70 @@
* format: date-time
* title: updated_at
* description: The date the return was updated.
* original_item_total:
* type: number
* title: original_item_total
* description: The return's original item total.
* original_item_subtotal:
* type: number
* title: original_item_subtotal
* description: The return's original item subtotal.
* original_item_tax_total:
* type: number
* title: original_item_tax_total
* description: The return's original item tax total.
* item_total:
* type: number
* title: item_total
* description: The return's item total.
* item_subtotal:
* type: number
* title: item_subtotal
* description: The return's item subtotal.
* item_tax_total:
* type: number
* title: item_tax_total
* description: The return's item tax total.
* original_total:
* type: number
* title: original_total
* description: The return's original total.
* original_subtotal:
* type: number
* title: original_subtotal
* description: The return's original subtotal.
* original_tax_total:
* type: number
* title: original_tax_total
* description: The return's original tax total.
* total:
* type: number
* title: total
* description: The return's total.
* subtotal:
* type: number
* title: subtotal
* description: The return's subtotal.
* tax_total:
* type: number
* title: tax_total
* description: The return's tax total.
* discount_total:
* type: number
* title: discount_total
* description: The return's discount total.
* discount_tax_total:
* type: number
* title: discount_tax_total
* description: The return's discount tax total.
* gift_card_total:
* type: number
* title: gift_card_total
* description: The return's gift card total.
* gift_card_tax_total:
* type: number
* title: gift_card_tax_total
* description: The return's gift card tax total.
* shipping_total:
* type: number
* title: shipping_total
* description: The return's shipping total.
* shipping_subtotal:
* type: number
* title: shipping_subtotal
* description: The return's shipping subtotal.
* shipping_tax_total:
* type: number
* title: shipping_tax_total
* description: The return's shipping tax total.
* original_shipping_total:
* type: number
* title: original_shipping_total
* description: The return's original shipping total.
* original_shipping_subtotal:
* type: number
* title: original_shipping_subtotal
* description: The return's original shipping subtotal.
* original_shipping_tax_total:
* type: number
* title: original_shipping_tax_total
* description: The return's original shipping tax total.
* order_change:
* $ref: "#/components/schemas/OrderChange"
* canceled_at:
* type: string
* title: canceled_at
* description: The date the return was canceled.
* format: date-time
* discount_subtotal:
* raw_refund_amount:
* oneOf:
* - type: string
* title: raw_refund_amount
* description: The return order's raw refund amount.
* - type: number
* title: raw_refund_amount
* description: The return order's raw refund amount.
* - type: string
* title: raw_refund_amount
* description: The return order's raw refund amount.
* - type: number
* title: raw_refund_amount
* description: The return order's raw refund amount.
* order:
* $ref: "#/components/schemas/Order"
* exchange_id:
* type: string
* title: exchange_id
* description: The ID of the exchange this return belongs to, if any.
* exchange:
* $ref: "#/components/schemas/OrderExchange"
* claim_id:
* type: string
* title: claim_id
* description: The ID of the claim this return belongs to, if any.
* claim:
* $ref: "#/components/schemas/OrderClaim"
* display_id:
* type: number
* title: discount_subtotal
* description: The return's discount subtotal.
* raw_original_item_total:
* type: object
* description: The return's raw original item total.
* raw_original_item_subtotal:
* type: object
* description: The return's raw original item subtotal.
* raw_original_item_tax_total:
* type: object
* description: The return's raw original item tax total.
* raw_item_total:
* type: object
* description: The return's raw item total.
* raw_item_subtotal:
* type: object
* description: The return's raw item subtotal.
* raw_item_tax_total:
* type: object
* description: The return's raw item tax total.
* raw_original_total:
* type: object
* description: The return's raw original total.
* raw_original_subtotal:
* type: object
* description: The return's raw original subtotal.
* raw_original_tax_total:
* type: object
* description: The return's raw original tax total.
* raw_total:
* type: object
* description: The return's raw total.
* raw_subtotal:
* type: object
* description: The return's raw subtotal.
* raw_tax_total:
* type: object
* description: The return's raw tax total.
* raw_discount_total:
* type: object
* description: The return's raw discount total.
* raw_discount_tax_total:
* type: object
* description: The return's raw discount tax total.
* raw_gift_card_total:
* type: object
* description: The return's raw gift card total.
* raw_gift_card_tax_total:
* type: object
* description: The return's raw gift card tax total.
* raw_shipping_total:
* type: object
* description: The return's raw shipping total.
* raw_shipping_subtotal:
* type: object
* description: The return's raw shipping subtotal.
* raw_shipping_tax_total:
* type: object
* description: The return's raw shipping tax total.
* raw_original_shipping_total:
* type: object
* description: The return's raw original shipping total.
* raw_original_shipping_subtotal:
* type: object
* description: The return's raw original shipping subtotal.
* raw_original_shipping_tax_total:
* type: object
* description: The return's raw original shipping tax total.
* title: display_id
* description: The return order's display ID.
* location_id:
* type: string
* title: location_id
* description: The ID of the stock location the items are returned to.
* no_notification:
* type: boolean
* title: no_notification
* description: Whether to notify the customer about changes in the return.
* created_by:
* type: string
* title: created_by
* description: The ID of the user that created the return.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the return was deleted.
* requested_at:
* type: string
* title: requested_at
* description: The date the return was requested.
* format: date-time
* received_at:
* type: string
* title: received_at
* description: The date the return was received.
* format: date-time
*
*/
www/utils/generated/oas-output/schemas/StoreCollection.ts
+2 -2
View File
@@ -5,11 +5,11 @@
* x-schemaName: StoreCollection
* required:
* - title
* - metadata
* - id
* - handle
* - metadata
* - created_at
* - updated_at
* - handle
* - deleted_at
* properties:
* id:
www/utils/generated/oas-output/schemas/StoreOrder.ts
+16 -15
View File
@@ -4,19 +4,17 @@
* description: The order's details.
* x-schemaName: StoreOrder
* required:
* - items
* - shipping_methods
* - currency_code
* - id
* - 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
@@ -46,10 +44,6 @@
* type: string
* title: id
* description: The order's ID.
* version:
* type: number
* title: version
* description: The order's version.
* region_id:
* type: string
* title: region_id
@@ -77,24 +71,24 @@
* title: display_id
* description: The order's display ID.
* shipping_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* $ref: "#/components/schemas/StoreOrderAddress"
* billing_address:
* $ref: "#/components/schemas/BaseOrderAddress"
* $ref: "#/components/schemas/StoreOrderAddress"
* items:
* type: array
* description: The order's items.
* items:
* $ref: "#/components/schemas/BaseOrderLineItem"
* $ref: "#/components/schemas/StoreOrderLineItem"
* shipping_methods:
* type: array
* description: The order's shipping methods.
* items:
* $ref: "#/components/schemas/BaseOrderShippingMethod"
* $ref: "#/components/schemas/StoreOrderShippingMethod"
* payment_collections:
* type: array
* description: The order's payment collections.
* items:
* $ref: "#/components/schemas/BasePaymentCollection"
* $ref: "#/components/schemas/StorePaymentCollection"
* payment_status:
* type: string
* description: The order's payment status.
@@ -113,7 +107,7 @@
* type: array
* description: The order's fulfillments.
* items:
* $ref: "#/components/schemas/BaseOrderFulfillment"
* $ref: "#/components/schemas/StoreOrderFulfillment"
* fulfillment_status:
* type: string
* description: The order's fulfillment status.
@@ -229,6 +223,13 @@
* type: number
* title: original_shipping_tax_total
* description: The total taxes of the order's shipping excluding promotions.
* customer:
* $ref: "#/components/schemas/StoreCustomer"
* transactions:
* type: array
* description: The order's transactions.
* items:
* $ref: "#/components/schemas/BaseOrderTransaction"
*
*/
www/utils/generated/oas-output/schemas/StoreOrderAddress.ts
+78
View File
@@ -0,0 +1,78 @@
/**
* @schema StoreOrderAddress
* type: object
* description: An order address
* x-schemaName: StoreOrderAddress
* required:
* - id
* - metadata
* - created_at
* - updated_at
* properties:
* 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
* country:
* $ref: "#/components/schemas/StoreRegionCountry"
* 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
@@ -0,0 +1,81 @@
/**
* @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 items were packed.
* format: date-time
* shipped_at:
* type: string
* title: shipped_at
* description: The date the items were shipped.
* format: date-time
* delivered_at:
* type: string
* title: delivered_at
* description: The date the items were delivered.
* format: date-time
* canceled_at:
* type: string
* title: canceled_at
* description: The date the items were canceled.
* format: date-time
* data:
* type: object
* description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* provider_id:
* type: string
* title: provider_id
* description: The ID of the fulfillment provider used to handle the 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.
* requires_shipping:
* type: boolean
* title: requires_shipping
* description: The fulfillment's requires shipping.
*
*/
www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts
+4016
View File
File diff suppressed because it is too large Load Diff
www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts
+1716
View File
File diff suppressed because it is too large Load Diff
www/utils/generated/oas-output/schemas/StoreProduct.ts
+4 -4
View File
@@ -12,10 +12,12 @@
* - status
* - description
* - id
* - handle
* - created_at
* - updated_at
* - subtitle
* - is_giftcard
* - thumbnail
* - handle
* - is_giftcard
* - width
* - weight
* - height
@@ -27,8 +29,6 @@
* - type_id
* - discountable
* - external_id
* - created_at
* - updated_at
* - deleted_at
* properties:
* categories:
www/utils/generated/oas-output/schemas/StoreProductVariant.ts
+2 -2
View File
@@ -118,6 +118,8 @@
* - length
* - title
* - id
* - created_at
* - updated_at
* - width
* - weight
* - height
@@ -125,8 +127,6 @@
* - hs_code
* - mid_code
* - material
* - created_at
* - updated_at
* - deleted_at
* - sku
* - barcode
www/utils/generated/oas-output/schemas/StoreRegionCountry.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @schema StoreRegionCountry
* type: object
* description: The country's details.
* x-schemaName: StoreRegionCountry
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The country's ID.
* iso_2:
* type: string
* title: iso_2
* description: The country's ISO 2.
* example: us
* iso_3:
* type: string
* title: iso_3
* description: The country's ISO 3.
* example: usa
* num_code:
* type: string
* title: num_code
* description: The country's num code.
* example: 840
* name:
* type: string
* title: name
* description: The country's name.
* display_name:
* type: string
* title: display_name
* description: The country's display name.
*
*/
www/utils/generated/oas-output/schemas/StoreReturn.ts
+2 -2
View File
@@ -5,10 +5,10 @@
* x-schemaName: StoreReturn
* required:
* - items
* - order_id
* - id
* - created_at
* - display_id
* - created_at
* - order_id
* - canceled_at
* - received_at
* properties: