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

chore(oas): improvements to examples and descriptions (#4545)

Browse Source 
* improve curl examples in OAS

* update tags

* fix oas errors

* update tags and their descriptions

* updated oas of endpoints

* improved oas of all admin endpoints

* improved store OAS comments

* improved models OAS comments

* small change
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-07-26 20:13:44 +03:00
1 parent caea44ebfd
commit 8a1aac028e
831 files changed
+5871 -4324
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

packages/medusa/src/models/address.ts
+3 -2
View File
@@ -69,7 +69,7 @@ export class Address extends SoftDeletableEntity {
/**
* @schema Address
* title: "Address"
* description: "An address."
* description: "An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity."
* type: object
* required:
* - address_1
@@ -141,7 +141,8 @@ export class Address extends SoftDeletableEntity {
* description: See a list of codes.
* example: st
* country:
* description: A country object. Available if the relation `country` is expanded.
* description: A country object.
* x-expandable: "country"
* nullable: true
* $ref: "#/components/schemas/Country"
* province:
packages/medusa/src/models/batch-job.ts
+3 -2
View File
@@ -105,7 +105,7 @@ export class BatchJob extends SoftDeletableEntity {
/**
* @schema BatchJob
* title: "Batch Job"
* description: "A Batch Job."
* description: "A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not."
* type: object
* required:
* - canceled_at
@@ -153,7 +153,8 @@ export class BatchJob extends SoftDeletableEntity {
* type: string
* example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
* created_by_user:
* description: A user object. Available if the relation `created_by_user` is expanded.
* description: The details of the user that created the batch job.
* x-expandable: "created_by_user"
* nullable: true
* $ref: "#/components/schemas/User"
* context:
packages/medusa/src/models/cart.ts
+25 -13
View File
@@ -1,7 +1,7 @@
/**
* @schema Cart
* title: "Cart"
* description: "Represents a user cart"
* description: "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim."
* type: object
* required:
* - billing_address_id
@@ -37,7 +37,8 @@
* type: string
* example: addr_01G8ZH853YPY9B94857DY91YGW
* billing_address:
* description: Available if the relation `billing_address` is expanded.
* description: The details of the billing address associated with the cart.
* x-expandable: "billing_address"
* nullable: true
* $ref: "#/components/schemas/Address"
* shipping_address_id:
@@ -46,12 +47,14 @@
* type: string
* example: addr_01G8ZH853YPY9B94857DY91YGW
* shipping_address:
* description: Available if the relation `shipping_address` is expanded.
* description: The details of the shipping address associated with the cart.
* x-expandable: "shipping_address"
* nullable: true
* $ref: "#/components/schemas/Address"
* items:
* description: Available if the relation `items` is expanded.
* description: The line items added to the cart.
* type: array
* x-expandable: "items"
* items:
* $ref: "#/components/schemas/LineItem"
* region_id:
@@ -59,17 +62,20 @@
* type: string
* example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
* region:
* description: A region object. Available if the relation `region` is expanded.
* description: The details of the region associated with the cart.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Region"
* discounts:
* description: Available if the relation `discounts` is expanded.
* description: An array of details of all discounts applied to the cart.
* type: array
* x-expandable: "discounts"
* items:
* $ref: "#/components/schemas/Discount"
* gift_cards:
* description: Available if the relation `gift_cards` is expanded.
* description: An array of details of all gift cards applied to the cart.
* type: array
* x-expandable: "gift_cards"
* items:
* $ref: "#/components/schemas/GiftCard"
* customer_id:
@@ -78,16 +84,19 @@
* type: string
* example: cus_01G2SG30J8C85S4A5CHM2S1NS2
* customer:
* description: A customer object. Available if the relation `customer` is expanded.
* description: The details of the customer the cart belongs to.
* x-expandable: "customer"
* nullable: true
* $ref: "#/components/schemas/Customer"
* payment_session:
* description: The selected payment session in the cart.
* description: The details of the selected payment session in the cart.
* x-expandable: "payment_session"
* nullable: true
* $ref: "#/components/schemas/PaymentSession"
* payment_sessions:
* description: The payment sessions created on the cart.
* description: The details of all payment sessions created on the cart.
* type: array
* x-expandable: "payment_sessions"
* items:
* $ref: "#/components/schemas/PaymentSession"
* payment_id:
@@ -96,12 +105,14 @@
* type: string
* example: pay_01G8ZCC5W42ZNY842124G7P5R9
* payment:
* description: Available if the relation `payment` is expanded.
* description: The details of the payment associated with the cart.
* nullable: true
* x-expandable: "payment"
* $ref: "#/components/schemas/Payment"
* shipping_methods:
* description: The shipping methods added to the cart.
* description: The details of the shipping methods added to the cart.
* type: array
* x-expandable: "shipping_methods"
* items:
* $ref: "#/components/schemas/ShippingMethod"
* type:
@@ -144,8 +155,9 @@
* type: string
* example: null
* sales_channel:
* description: A sales channel object. Available if the relation `sales_channel` is expanded.
* description: The details of the sales channel associated with the cart.
* nullable: true
* x-expandable: "sales_channel"
* $ref: "#/components/schemas/SalesChannel"
* created_at:
* description: The date with timezone at which the resource was created.
packages/medusa/src/models/claim-image.ts
+3 -2
View File
@@ -37,7 +37,7 @@ export class ClaimImage extends SoftDeletableEntity {
/**
* @schema ClaimImage
* title: "Claim Image"
* description: "Represents photo documentation of a claim."
* description: "The details of an image attached to a claim."
* type: object
* required:
* - claim_item_id
@@ -56,8 +56,9 @@ export class ClaimImage extends SoftDeletableEntity {
* description: The ID of the claim item associated with the image
* type: string
* claim_item:
* description: A claim item object. Available if the relation `claim_item` is expanded.
* description: The details of the claim item this image is associated with.
* nullable: true
* x-expandable: "claim_item"
* $ref: "#/components/schemas/ClaimItem"
* url:
* description: The URL of the image
packages/medusa/src/models/claim-item.ts
+11 -6
View File
@@ -92,7 +92,7 @@ export class ClaimItem extends SoftDeletableEntity {
/**
* @schema ClaimItem
* title: "Claim Item"
* description: "Represents a claimed item along with information about the reasons for the claim."
* description: "A claim item is an item created as part of a claim. It references an item in the order that should be exchanged or refunded."
* type: object
* required:
* - claim_order_id
@@ -112,15 +112,17 @@ export class ClaimItem extends SoftDeletableEntity {
* type: string
* example: citm_01G8ZH853Y6TFXWPG5EYE81X63
* images:
* description: Available if the relation `images` is expanded.
* description: The claim images that are attached to the claim item.
* type: array
* x-expandable: "images"
* items:
* $ref: "#/components/schemas/ClaimImage"
* claim_order_id:
* description: The ID of the claim this item is associated with.
* type: string
* claim_order:
* description: A claim order object. Available if the relation `claim_order` is expanded.
* description: The details of the claim this item belongs to.
* x-expandable: "claim_order"
* nullable: true
* $ref: "#/components/schemas/ClaimOrder"
* item_id:
@@ -128,7 +130,8 @@ export class ClaimItem extends SoftDeletableEntity {
* type: string
* example: item_01G8ZM25TN49YV9EQBE2NC27KC
* item:
* description: Available if the relation `item` is expanded.
* description: The details of the line item in the original order that this claim item refers to.
* x-expandable: "item"
* nullable: true
* $ref: "#/components/schemas/LineItem"
* variant_id:
@@ -136,7 +139,8 @@ export class ClaimItem extends SoftDeletableEntity {
* type: string
* example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
* variant:
* description: A variant object. Available if the relation `variant` is expanded.
* description: The details of the product variant to potentially replace the item in the original order.
* x-expandable: "variant"
* nullable: true
* $ref: "#/components/schemas/ProductVariant"
* reason:
@@ -157,8 +161,9 @@ export class ClaimItem extends SoftDeletableEntity {
* type: integer
* example: 1
* tags:
* description: User defined tags for easy filtering and grouping. Available if the relation 'tags' is expanded.
* description: User defined tags for easy filtering and grouping.
* type: array
* x-expandable: "tags"
* items:
* $ref: "#/components/schemas/ClaimTag"
* created_at:
packages/medusa/src/models/claim-order.ts
+15 -8
View File
@@ -132,8 +132,8 @@ export class ClaimOrder extends SoftDeletableEntity {
/**
* @schema ClaimOrder
* title: "Claim Order"
* description: "Claim Orders represent a group of faulty or missing items. Each claim order consists of a subset of items associated with an original order, and can contain additional information about fulfillments and returns."
* title: "Claim"
* description: "A Claim represents a group of faulty or missing items. It consists of claim items that refer to items in the original order that should be replaced or refunded. It also includes details related to shipping and fulfillment."
* type: object
* required:
* - canceled_at
@@ -184,13 +184,15 @@ export class ClaimOrder extends SoftDeletableEntity {
* - requires_action
* default: not_fulfilled
* claim_items:
* description: The items that have been claimed
* description: The details of the items that should be replaced or refunded.
* type: array
* x-expandable: "claim_items"
* items:
* $ref: "#/components/schemas/ClaimItem"
* additional_items:
* description: Refers to the new items to be shipped when the claim order has the type `replace`
* description: The details of the new items to be shipped when the claim's type is `replace`
* type: array
* x-expandable: "additional_items"
* items:
* $ref: "#/components/schemas/LineItem"
* order_id:
@@ -198,11 +200,13 @@ export class ClaimOrder extends SoftDeletableEntity {
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that this claim was created for.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* return_order:
* description: A return object. Holds information about the return if the claim is to be returned. Available if the relation 'return_order' is expanded
* description: The details of the return associated with the claim if the claim's type is `replace`.
* x-expandable: "return_order"
* nullable: true
* $ref: "#/components/schemas/Return"
* shipping_address_id:
@@ -211,17 +215,20 @@ export class ClaimOrder extends SoftDeletableEntity {
* type: string
* example: addr_01G8ZH853YPY9B94857DY91YGW
* shipping_address:
* description: Available if the relation `shipping_address` is expanded.
* description: The details of the address that new items should be shipped to.
* x-expandable: "shipping_address"
* nullable: true
* $ref: "#/components/schemas/Address"
* shipping_methods:
* description: The shipping methods that the claim order will be shipped with.
* description: The details of the shipping methods that the claim order will be shipped with.
* type: array
* x-expandable: "shipping_methods"
* items:
* $ref: "#/components/schemas/ShippingMethod"
* fulfillments:
* description: The fulfillments of the new items to be shipped
* type: array
* x-expandable: "fulfillments"
* items:
* $ref: "#/components/schemas/Fulfillment"
* refund_amount:
packages/medusa/src/models/country.ts
+2 -1
View File
@@ -92,7 +92,8 @@ export class Country {
* type: string
* example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
* region:
* description: A region object. Available if the relation `region` is expanded.
* description: The details of the region the country is associated with.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Region"
*/
packages/medusa/src/models/currency.ts
+2 -1
View File
@@ -51,7 +51,8 @@ export class Currency {
* type: string
* example: US Dollar
* includes_tax:
* description: "[EXPERIMENTAL] Does the currency prices include tax"
* description: "Whether the currency prices include tax"
* type: boolean
* x-featureFlag: "tax_inclusive_pricing"
* default: false
*/
packages/medusa/src/models/custom-shipping-option.ts
+5 -3
View File
@@ -48,7 +48,7 @@ export class CustomShippingOption extends SoftDeletableEntity {
/**
* @schema CustomShippingOption
* title: "Custom Shipping Option"
* description: "Custom Shipping Options are 'overriden' Shipping Options. Store managers can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option"
* description: "Custom Shipping Options are overriden Shipping Options. Admins can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option."
* type: object
* required:
* - cart_id
@@ -73,7 +73,8 @@ export class CustomShippingOption extends SoftDeletableEntity {
* type: string
* example: so_01G1G5V27GYX4QXNARRQCW1N8T
* shipping_option:
* description: A shipping option object. Available if the relation `shipping_option` is expanded.
* description: The details of the overriden shipping options.
* x-expandable: "shipping_option"
* nullable: true
* $ref: "#/components/schemas/ShippingOption"
* cart_id:
@@ -82,7 +83,8 @@ export class CustomShippingOption extends SoftDeletableEntity {
* type: string
* example: cart_01G8ZH853Y6TFXWPG5EYE81X63
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart this shipping option belongs to.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* created_at:
packages/medusa/src/models/customer-group.ts
+5 -3
View File
@@ -34,7 +34,7 @@ export class CustomerGroup extends SoftDeletableEntity {
/**
* @schema CustomerGroup
* title: "Customer Group"
* description: "Represents a customer group"
* description: "A customer group that can be used to organize customers into groups of similar traits."
* type: object
* required:
* - created_at
@@ -53,13 +53,15 @@ export class CustomerGroup extends SoftDeletableEntity {
* type: string
* example: VIP
* customers:
* description: The customers that belong to the customer group. Available if the relation `customers` is expanded.
* description: The details of the customers that belong to the customer group.
* type: array
* x-expandable: "customers"
* items:
* $ref: "#/components/schemas/Customer"
* price_lists:
* description: The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded.
* description: The price lists that are associated with the customer group.
* type: array
* x-expandable: "price_lists"
* items:
* $ref: "#/components/schemas/PriceList"
* created_at:
packages/medusa/src/models/customer.ts
+9 -5
View File
@@ -82,7 +82,7 @@ export class Customer extends SoftDeletableEntity {
/**
* @schema Customer
* title: "Customer"
* description: "Represents a customer"
* description: "A customer can make purchases in your store and manage their profile."
* type: object
* required:
* - billing_address_id
@@ -121,12 +121,14 @@ export class Customer extends SoftDeletableEntity {
* type: string
* example: addr_01G8ZH853YPY9B94857DY91YGW
* billing_address:
* description: Available if the relation `billing_address` is expanded.
* description: The details of the billing address associated with the customer.
* x-expandable: "billing_address"
* nullable: true
* $ref: "#/components/schemas/Address"
* shipping_addresses:
* description: Available if the relation `shipping_addresses` is expanded.
* description: The details of the shipping addresses associated with the customer.
* type: array
* x-expandable: "shipping_addresses"
* items:
* $ref: "#/components/schemas/Address"
* phone:
@@ -139,13 +141,15 @@ export class Customer extends SoftDeletableEntity {
* type: boolean
* default: false
* orders:
* description: Available if the relation `orders` is expanded.
* description: The details of the orders this customer placed.
* type: array
* x-expandable: "orders"
* items:
* $ref: "#/components/schemas/Order"
* groups:
* description: The customer groups the customer belongs to. Available if the relation `groups` is expanded.
* description: The customer groups the customer belongs to.
* type: array
* x-expandable: "groups"
* items:
* $ref: "#/components/schemas/CustomerGroup"
* created_at:
packages/medusa/src/models/discount-condition-product-collection.ts
+5 -3
View File
@@ -40,7 +40,7 @@ export class DiscountConditionProductCollection {
/**
* @schema DiscountConditionProductCollection
* title: "Product Collection Discount Condition"
* description: "Associates a discount condition with a product collection"
* description: "This represents the association between a discount condition and a product collection"
* type: object
* required:
* - condition_id
@@ -58,11 +58,13 @@ export class DiscountConditionProductCollection {
* type: string
* example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
* product_collection:
* description: Available if the relation `product_collection` is expanded.
* description: The details of the product collection.
* x-expandable: "product_collection"
* nullable: true
* $ref: "#/components/schemas/ProductCollection"
* discount_condition:
* description: Available if the relation `discount_condition` is expanded.
* description: The details of the discount condition.
* x-expandable: "discount_condition"
* nullable: true
* $ref: "#/components/schemas/DiscountCondition"
* created_at:
packages/medusa/src/models/discount-condition-product-tag.ts
+5 -3
View File
@@ -40,7 +40,7 @@ export class DiscountConditionProductTag {
/**
* @schema DiscountConditionProductTag
* title: "Product Tag Discount Condition"
* description: "Associates a discount condition with a product tag"
* description: "This represents the association between a discount condition and a product tag"
* type: object
* required:
* - condition_id
@@ -58,11 +58,13 @@ export class DiscountConditionProductTag {
* type: string
* example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
* product_tag:
* description: Available if the relation `product_tag` is expanded.
* description: The details of the product tag.
* x-expandable: "product_tag"
* nullable: true
* $ref: "#/components/schemas/ProductTag"
* discount_condition:
* description: Available if the relation `discount_condition` is expanded.
* description: The details of the discount condition.
* x-expandable: "discount_condition"
* nullable: true
* $ref: "#/components/schemas/DiscountCondition"
* created_at:
packages/medusa/src/models/discount-condition-product-type.ts
+5 -3
View File
@@ -40,7 +40,7 @@ export class DiscountConditionProductType {
/**
* @schema DiscountConditionProductType
* title: "Product Type Discount Condition"
* description: "Associates a discount condition with a product type"
* description: "This represents the association between a discount condition and a product type"
* type: object
* required:
* - condition_id
@@ -58,11 +58,13 @@ export class DiscountConditionProductType {
* type: string
* example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
* product_type:
* description: Available if the relation `product_type` is expanded.
* description: The details of the product type.
* x-expandable: "product_type"
* nullable: true
* $ref: "#/components/schemas/ProductType"
* discount_condition:
* description: Available if the relation `discount_condition` is expanded.
* description: The details of the discount condition.
* x-expandable: "discount_condition"
* nullable: true
* $ref: "#/components/schemas/DiscountCondition"
* created_at:
packages/medusa/src/models/discount-condition-product.ts
+5 -3
View File
@@ -40,7 +40,7 @@ export class DiscountConditionProduct {
/**
* @schema DiscountConditionProduct
* title: "Product Discount Condition"
* description: "Associates a discount condition with a product"
* description: "This represents the association between a discount condition and a product"
* type: object
* required:
* - condition_id
@@ -58,11 +58,13 @@ export class DiscountConditionProduct {
* type: string
* example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
* product:
* description: Available if the relation `product` is expanded.
* description: The details of the product.
* x-expandable: "product"
* nullable: true
* $ref: "#/components/schemas/Product"
* discount_condition:
* description: Available if the relation `discount_condition` is expanded.
* description: The details of the discount condition.
* x-expandable: "discount_condition"
* nullable: true
* $ref: "#/components/schemas/DiscountCondition"
* created_at:
packages/medusa/src/models/discount-condition.ts
+16 -8
View File
@@ -157,7 +157,8 @@ export class DiscountCondition extends SoftDeletableEntity {
* type: string
* example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
* type:
* description: "The type of the Condition"
* description: "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`,
* that means the `products` relation will hold the products associated with this condition and other relations will be empty."
* type: string
* enum:
* - products
@@ -166,7 +167,8 @@ export class DiscountCondition extends SoftDeletableEntity {
* - product_tags
* - customer_groups
* operator:
* description: "The operator of the Condition"
* description: "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that
* discountable resources are everything but the specified resources."
* type: string
* enum:
* - in
@@ -176,32 +178,38 @@ export class DiscountCondition extends SoftDeletableEntity {
* type: string
* example: dru_01F0YESMVK96HVX7N419E3CJ7C
* discount_rule:
* description: Available if the relation `discount_rule` is expanded.
* description: The details of the discount rule associated with the condition.
* x-expandable: "discount_rule"
* nullable: true
* $ref: "#/components/schemas/DiscountRule"
* products:
* description: products associated with this condition if type = products. Available if the relation `products` is expanded.
* description: products associated with this condition if `type` is `products`.
* type: array
* x-expandable: "products"
* items:
* $ref: "#/components/schemas/Product"
* product_types:
* description: Product types associated with this condition if type = product_types. Available if the relation `product_types` is expanded.
* description: Product types associated with this condition if `type` is `product_types`.
* type: array
* x-expandable: "product_types"
* items:
* $ref: "#/components/schemas/ProductType"
* product_tags:
* description: Product tags associated with this condition if type = product_tags. Available if the relation `product_tags` is expanded.
* description: Product tags associated with this condition if `type` is `product_tags`.
* type: array
* x-expandable: "product_tags"
* items:
* $ref: "#/components/schemas/ProductTag"
* product_collections:
* description: Product collections associated with this condition if type = product_collections. Available if the relation `product_collections` is expanded.
* description: Product collections associated with this condition if `type` is `product_collections`.
* type: array
* x-expandable: "product_collections"
* items:
* $ref: "#/components/schemas/ProductCollection"
* customer_groups:
* description: Customer groups associated with this condition if type = customer_groups. Available if the relation `customer_groups` is expanded.
* description: Customer groups associated with this condition if `type` is `customer_groups`.
* type: array
* x-expandable: "customer_groups"
* items:
* $ref: "#/components/schemas/CustomerGroup"
* created_at:
packages/medusa/src/models/discount-rule.ts
+3 -2
View File
@@ -52,7 +52,7 @@ export class DiscountRule extends SoftDeletableEntity {
/**
* @schema DiscountRule
* title: "Discount Rule"
* description: "Holds the rules that governs how a Discount is calculated when applied to a Cart."
* description: "A discount rule defines how a Discount is calculated when applied to a Cart."
* type: object
* required:
* - allocation
@@ -95,8 +95,9 @@ export class DiscountRule extends SoftDeletableEntity {
* - item
* example: total
* conditions:
* description: A set of conditions that can be used to limit when the discount can be used. Available if the relation `conditions` is expanded.
* description: The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.
* type: array
* x-expandable: "conditions"
* items:
* $ref: "#/components/schemas/DiscountCondition"
* created_at:
packages/medusa/src/models/discount.ts
+8 -5
View File
@@ -91,7 +91,7 @@ export class Discount extends SoftDeletableEntity {
/**
* @schema Discount
* title: "Discount"
* description: "Represents a discount that can be applied to a cart for promotional purposes."
* description: "A discount can be applied to a cart for promotional purposes."
* type: object
* required:
* - code
@@ -123,12 +123,13 @@ export class Discount extends SoftDeletableEntity {
* type: boolean
* example: false
* rule_id:
* description: The Discount Rule that governs the behaviour of the Discount
* description: The ID of the discount rule that defines how the discount will be applied to a cart.
* nullable: true
* type: string
* example: dru_01F0YESMVK96HVX7N419E3CJ7C
* rule:
* description: Available if the relation `rule` is expanded.
* description: The details of the discount rule that defines how the discount will be applied to a cart..
* x-expandable: "rule"
* nullable: true
* $ref: "#/components/schemas/DiscountRule"
* is_disabled:
@@ -141,7 +142,8 @@ export class Discount extends SoftDeletableEntity {
* type: string
* example: disc_01G8ZH853YPY9B94857DY91YGW
* parent_discount:
* description: Available if the relation `parent_discount` is expanded.
* description: The details of the parent discount that this discount was created from.
* x-expandable: "parent_discount"
* nullable: true
* $ref: "#/components/schemas/Discount"
* starts_at:
@@ -159,8 +161,9 @@ export class Discount extends SoftDeletableEntity {
* type: string
* example: P3Y6M4DT12H30M5S
* regions:
* description: The Regions in which the Discount can be used. Available if the relation `regions` is expanded.
* description: The details of the regions in which the Discount can be used.
* type: array
* x-expandable: "regions"
* items:
* $ref: "#/components/schemas/Region"
* usage_limit:
packages/medusa/src/models/draft-order.ts
+7 -5
View File
@@ -81,7 +81,7 @@ export class DraftOrder extends BaseEntity {
/**
* @schema DraftOrder
* title: "DraftOrder"
* description: "Represents a draft order"
* description: "A draft order is created by an admin without direct involvement of the customer. Once its payment is marked as captured, it is transformed into an order."
* type: object
* required:
* - canceled_at
@@ -102,7 +102,7 @@ export class DraftOrder extends BaseEntity {
* type: string
* example: dorder_01G8TJFKBG38YYFQ035MSVG03C
* status:
* description: The status of the draft order
* description: The status of the draft order. It's changed to `completed` when it's transformed to an order.
* type: string
* enum:
* - open
@@ -118,16 +118,18 @@ export class DraftOrder extends BaseEntity {
* type: string
* example: cart_01G8ZH853Y6TFXWPG5EYE81X63
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart associated with the draft order.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* order_id:
* description: The ID of the order associated with the draft order.
* description: The ID of the order created from the draft order when its payment is captured.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order created from the draft order when its payment is captured.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* canceled_at:
packages/medusa/src/models/fulfillment-item.ts
+7 -5
View File
@@ -26,7 +26,7 @@ export class FulfillmentItem {
/**
* @schema FulfillmentItem
* title: "Fulfillment Item"
* description: "Correlates a Line Item with a Fulfillment, keeping track of the quantity of the Line Item."
* description: "This represents the association between a Line Item and a Fulfillment."
* type: object
* required:
* - fulfillment_id
@@ -34,19 +34,21 @@ export class FulfillmentItem {
* - quantity
* properties:
* fulfillment_id:
* description: The id of the Fulfillment that the Fulfillment Item belongs to.
* description: The ID of the Fulfillment that the Fulfillment Item belongs to.
* type: string
* example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
* item_id:
* description: The id of the Line Item that the Fulfillment Item references.
* description: The ID of the Line Item that the Fulfillment Item references.
* type: string
* example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
* fulfillment:
* description: A fulfillment object. Available if the relation `fulfillment` is expanded.
* description: The details of the fulfillment.
* x-expandable: "fulfillment"
* nullable: true
* $ref: "#/components/schemas/Fulfillment"
* item:
* description: Available if the relation `item` is expanded.
* description: The details of the line item.
* x-expandable: "item"
* nullable: true
* $ref: "#/components/schemas/LineItem"
* quantity:
packages/medusa/src/models/fulfillment-provider.ts
+4 -3
View File
@@ -12,18 +12,19 @@ export class FulfillmentProvider {
/**
* @schema FulfillmentProvider
* title: "Fulfillment Provider"
* description: "Represents a fulfillment provider plugin and holds its installation status."
* description: "A fulfillment provider represents a fulfillment service installed in the Medusa backend, either through a plugin or backend customizations.
* It holds the fulfillment service's installation status."
* type: object
* required:
* - id
* - is_installed
* properties:
* id:
* description: The id of the fulfillment provider as given by the plugin.
* description: The ID of the fulfillment provider as given by the fulfillment service.
* type: string
* example: manual
* is_installed:
* description: Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`.
* description: Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.
* type: boolean
* default: true
*/
packages/medusa/src/models/fulfillment.ts
+18 -12
View File
@@ -96,7 +96,7 @@ export class Fulfillment extends BaseEntity {
/**
* @schema Fulfillment
* title: "Fulfillment"
* description: "Fulfillments are created once store operators can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a provider, which is typically an external shipping aggregator, shipping partner og 3PL, most plugins will have asynchronous communications with these providers through webhooks in order to automatically update and synchronize the state of Fulfillments."
* description: "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns."
* type: object
* required:
* - canceled_at
@@ -120,53 +120,59 @@ export class Fulfillment extends BaseEntity {
* type: string
* example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
* claim_order_id:
* description: The id of the Claim that the Fulfillment belongs to.
* description: The ID of the Claim that the Fulfillment belongs to.
* nullable: true
* type: string
* example: null
* claim_order:
* description: A claim order object. Available if the relation `claim_order` is expanded.
* description: The details of the claim that the fulfillment may belong to.
* x-expandable: "claim_order"
* nullable: true
* $ref: "#/components/schemas/ClaimOrder"
* swap_id:
* description: The id of the Swap that the Fulfillment belongs to.
* description: The ID of the Swap that the Fulfillment belongs to.
* nullable: true
* type: string
* example: null
* swap:
* description: A swap object. Available if the relation `swap` is expanded.
* description: The details of the swap that the fulfillment may belong to.
* x-expandable: "swap"
* nullable: true
* $ref: "#/components/schemas/Swap"
* order_id:
* description: The id of the Order that the Fulfillment belongs to.
* description: The ID of the Order that the Fulfillment belongs to.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that the fulfillment may belong to.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* provider_id:
* description: The id of the Fulfillment Provider responsible for handling the fulfillment
* description: The ID of the Fulfillment Provider responsible for handling the fulfillment.
* type: string
* example: manual
* provider:
* description: Available if the relation `provider` is expanded.
* description: The details of the fulfillment provider responsible for handling the fulfillment.
* x-expandable: "provider"
* nullable: true
* $ref: "#/components/schemas/FulfillmentProvider"
* location_id:
* description: The id of the stock location the fulfillment will be shipped from
* description: The ID of the stock location the fulfillment will be shipped from
* nullable: true
* type: string
* example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
* items:
* description: The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled. Available if the relation `items` is expanded.
* description: The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.
* type: array
* x-expandable: "items"
* items:
* $ref: "#/components/schemas/FulfillmentItem"
* tracking_links:
* description: The Tracking Links that can be used to track the status of the Fulfillment, these will usually be provided by the Fulfillment Provider. Available if the relation `tracking_links` is expanded.
* description: The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.
* type: array
* x-expandable: "tracking_links"
* items:
* $ref: "#/components/schemas/TrackingLink"
* tracking_numbers:
packages/medusa/src/models/gift-card-transaction.ts
+6 -4
View File
@@ -57,7 +57,7 @@ export class GiftCardTransaction {
/**
* @schema GiftCardTransaction
* title: "Gift Card Transaction"
* description: "Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order"
* description: "Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order."
* type: object
* required:
* - amount
@@ -77,15 +77,17 @@ export class GiftCardTransaction {
* type: string
* example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
* gift_card:
* description: A gift card object. Available if the relation `gift_card` is expanded.
* description: The details of the gift card associated used in this transaction.
* x-expandable: "gift_card"
* nullable: true
* $ref: "#/components/schemas/GiftCard"
* order_id:
* description: The ID of the Order that the Gift Card was used to pay for.
* description: The ID of the order that the gift card was used for payment.
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that the gift card was used for payment.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* amount:
packages/medusa/src/models/gift-card.ts
+6 -4
View File
@@ -99,20 +99,22 @@ export class GiftCard extends SoftDeletableEntity {
* type: integer
* example: 10
* region_id:
* description: The id of the Region in which the Gift Card is available.
* description: The ID of the region this gift card is available in.
* type: string
* example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
* region:
* description: A region object. Available if the relation `region` is expanded.
* description: The details of the region this gift card is available in.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Region"
* order_id:
* description: The id of the Order that the Gift Card was purchased in.
* description: The ID of the order that the gift card was purchased in.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that the gift card was purchased in.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Order"
* is_disabled:
packages/medusa/src/models/image.ts
+1 -1
View File
@@ -21,7 +21,7 @@ export class Image extends SoftDeletableEntity {
/**
* @schema Image
* title: "Image"
* description: "Images holds a reference to a URL at which the image file can be found."
* description: "An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service."
* type: object
* required:
* - created_at
packages/medusa/src/models/invite.ts
+2 -2
View File
@@ -40,7 +40,7 @@ export class Invite extends SoftDeletableEntity {
/**
* @schema Invite
* title: "Invite"
* description: "Represents an invite"
* description: "An invite is created when an admin user invites a new user to join the store's team. Once the invite is accepted, it's deleted."
* type: object
* required:
* - accepted
@@ -63,7 +63,7 @@ export class Invite extends SoftDeletableEntity {
* type: string
* format: email
* role:
* description: The user's role.
* description: The user's role. These roles don't change the privileges of the user.
* nullable: true
* type: string
* enum:
packages/medusa/src/models/line-item-adjustment.ts
+5 -3
View File
@@ -55,7 +55,7 @@ export class LineItemAdjustment {
/**
* @schema LineItemAdjustment
* title: "Line Item Adjustment"
* description: "Represents a Line Item Adjustment"
* description: "A Line Item Adjustment includes details on discounts applied on a line item."
* type: object
* required:
* - amount
@@ -74,7 +74,8 @@ export class LineItemAdjustment {
* type: string
* example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
* item:
* description: Available if the relation `item` is expanded.
* description: The details of the line item.
* x-expandable: "item"
* nullable: true
* $ref: "#/components/schemas/LineItem"
* description:
@@ -87,7 +88,8 @@ export class LineItemAdjustment {
* type: string
* example: disc_01F0YESMW10MGHWJKZSDDMN0VN
* discount:
* description: Available if the relation `discount` is expanded.
* description: The details of the discount associated with the adjustment.
* x-expandable: "discount"
* nullable: true
* $ref: "#/components/schemas/Discount"
* amount:
packages/medusa/src/models/line-item-tax-line.ts
+3 -2
View File
@@ -32,7 +32,7 @@ export class LineItemTaxLine extends TaxLine {
/**
* @schema LineItemTaxLine
* title: "Line Item Tax Line"
* description: "Represents a Line Item Tax Line"
* description: "A Line Item Tax Line represents the taxes applied on a line item."
* type: object
* required:
* - code
@@ -66,7 +66,8 @@ export class LineItemTaxLine extends TaxLine {
* type: string
* example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
* item:
* description: Available if the relation `item` is expanded.
* description: The details of the line item.
* x-expandable: "item"
* nullable: true
* $ref: "#/components/schemas/LineItem"
* created_at:
packages/medusa/src/models/line-item.ts
+26 -17
View File
@@ -161,7 +161,7 @@ export class LineItem extends BaseEntity {
/**
* @schema LineItem
* title: "Line Item"
* description: "Line Items represent purchasable units that can be added to a Cart for checkout. When Line Items are purchased they will get copied to the resulting order and can eventually be referenced in Fulfillments and Returns. Line Items may also be created when processing Swaps and Claims."
* description: "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits."
* type: object
* required:
* - allow_discounts
@@ -194,65 +194,72 @@ export class LineItem extends BaseEntity {
* type: string
* example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
* cart_id:
* description: The ID of the Cart that the Line Item belongs to.
* description: The ID of the cart that the line item may belongs to.
* nullable: true
* type: string
* example: cart_01G8ZH853Y6TFXWPG5EYE81X63
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart that the line item may belongs to.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* order_id:
* description: The ID of the Order that the Line Item belongs to.
* description: The ID of the order that the line item may belongs to.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that the line item may belongs to.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* swap_id:
* description: The id of the Swap that the Line Item belongs to.
* description: The ID of the swap that the line item may belong to.
* nullable: true
* type: string
* example: null
* swap:
* description: A swap object. Available if the relation `swap` is expanded.
* description: The details of the swap that the line item may belong to.
* x-expandable: "swap"
* nullable: true
* $ref: "#/components/schemas/Swap"
* claim_order_id:
* description: The id of the Claim that the Line Item belongs to.
* description: The ID of the claim that the line item may belong to.
* nullable: true
* type: string
* example: null
* claim_order:
* description: A claim order object. Available if the relation `claim_order` is expanded.
* description: The details of the claim that the line item may belong to.
* x-expandable: "claim_order"
* nullable: true
* $ref: "#/components/schemas/ClaimOrder"
* tax_lines:
* description: Available if the relation `tax_lines` is expanded.
* description: The details of the item's tax lines.
* x-expandable: "tax_lines"
* type: array
* items:
* $ref: "#/components/schemas/LineItemTaxLine"
* adjustments:
* description: Available if the relation `adjustments` is expanded.
* description: The details of the item's adjustments, which are available when a discount is applied on the item.
* x-expandable: "adjustments"
* type: array
* items:
* $ref: "#/components/schemas/LineItemAdjustment"
* original_item_id:
* description: The id of the original line item
* description: The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.
* nullable: true
* type: string
* order_edit_id:
* description: The ID of the order edit to which a cloned item belongs
* description: The ID of the order edit that the item may belong to.
* nullable: true
* type: string
* order_edit:
* description: The order edit joined. Available if the relation `order_edit` is expanded.
* description: The details of the order edit.
* x-expandable: "order_edit"
* nullable: true
* $ref: "#/components/schemas/OrderEdit"
* title:
* description: The title of the Line Item, this should be easily identifiable by the Customer.
* description: The title of the Line Item.
* type: string
* example: Medusa Coffee Mug
* description:
@@ -297,7 +304,8 @@ export class LineItem extends BaseEntity {
* type: string
* example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
* variant:
* description: A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded.
* description: The details of the product variant that this item was created from.
* x-expandable: "variant"
* nullable: true
* $ref: "#/components/schemas/ProductVariant"
* quantity:
@@ -356,7 +364,8 @@ export class LineItem extends BaseEntity {
* type: integer
* example: 0
* includes_tax:
* description: "[EXPERIMENTAL] Indicates if the line item unit_price include tax"
* description: "Indicates if the line item unit_price include tax"
* x-featureFlag: "tax_inclusive_pricing"
* type: boolean
* default: false
* created_at:
packages/medusa/src/models/money-amount.ts
+12 -8
View File
@@ -70,7 +70,7 @@ export class MoneyAmount extends SoftDeletableEntity {
/**
* @schema MoneyAmount
* title: "Money Amount"
* description: "Money Amounts represents an amount that a given Product Variant can be purcased for. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used the amount will be in the currency defined for the Reigon."
* description: "A Money Amount represent a price amount, for example, a product variant's price or a price in a price list. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used, the amount will be in the currency defined for the Region."
* type: object
* required:
* - amount
@@ -90,14 +90,15 @@ export class MoneyAmount extends SoftDeletableEntity {
* type: string
* example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
* currency_code:
* description: The 3 character currency code that the Money Amount is given in.
* description: The 3 character currency code that the money amount may belong to.
* type: string
* example: usd
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
* description: See a list of codes.
* currency:
* description: Available if the relation `currency` is expanded.
* description: The details of the currency that the money amount may belong to.
* x-expandable: "currency"
* nullable: true
* $ref: "#/components/schemas/Currency"
* amount:
@@ -115,21 +116,23 @@ export class MoneyAmount extends SoftDeletableEntity {
* type: integer
* example: 1
* price_list_id:
* description: The ID of the price list associated with the money amount
* description: The ID of the price list that the money amount may belong to.
* nullable: true
* type: string
* example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
* price_list:
* description: Available if the relation `price_list` is expanded.
* description: The details of the price list that the money amount may belong to.
* x-expandable: "price_list"
* nullable: true
* $ref: "#/components/schemas/PriceList"
* variant_id:
* description: The id of the Product Variant contained in the Line Item.
* description: The ID of the Product Variant contained in the Line Item.
* nullable: true
* type: string
* example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
* variant:
* description: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded.
* description: The details of the product variant that the money amount may belong to.
* x-expandable: "variant"
* nullable: true
* $ref: "#/components/schemas/ProductVariant"
* region_id:
@@ -138,7 +141,8 @@ export class MoneyAmount extends SoftDeletableEntity {
* type: string
* example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
* region:
* description: A region object. Available if the relation `region` is expanded.
* description: The details of the region that the money amount may belong to.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Region"
* created_at:
packages/medusa/src/models/note.ts
+4 -3
View File
@@ -44,7 +44,7 @@ export class Note extends SoftDeletableEntity {
/**
* @schema Note
* title: "Note"
* description: "Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these."
* description: "A Note is an element that can be used in association with different resources to allow admin users to describe additional information. For example, they can be used to add additional information about orders."
* type: object
* required:
* - author_id
@@ -74,12 +74,13 @@ export class Note extends SoftDeletableEntity {
* type: string
* example: This order must be fulfilled on Monday
* author_id:
* description: The ID of the author (user)
* description: The ID of the user that created the note.
* nullable: true
* type: string
* example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
* author:
* description: Available if the relation `author` is expanded.
* description: The details of the user that created the note.
* x-expandable: "author"
* nullable: true
* $ref: "#/components/schemas/User"
* created_at:
packages/medusa/src/models/notification-provider.ts
+4 -3
View File
@@ -12,18 +12,19 @@ export class NotificationProvider {
/**
* @schema NotificationProvider
* title: "Notification Provider"
* description: "Represents a notification provider plugin and holds its installation status."
* description: "A notification provider represents a notification service installed in the Medusa backend, either through a plugin or backend customizations.
* It holds the notification service's installation status."
* type: object
* required:
* - id
* - is_installed
* properties:
* id:
* description: The id of the notification provider as given by the plugin.
* description: The ID of the notification provider as given by the notification service.
* type: string
* example: sendgrid
* is_installed:
* description: Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`.
* description: Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.
* type: boolean
* default: true
*/
packages/medusa/src/models/notification.ts
+12 -8
View File
@@ -67,7 +67,7 @@ export class Notification extends BaseEntity {
/**
* @schema Notification
* title: "Notification"
* description: "Notifications a communications sent via Notification Providers as a reaction to internal events such as `order.placed`. Notifications can be used to show a chronological timeline for communications sent to a Customer regarding an Order, and enables resends."
* description: "A notification is an alert sent, typically to customers, using the installed Notification Provider as a reaction to internal events such as `order.placed`. Notifications can be resent."
* type: object
* required:
* - created_at
@@ -100,16 +100,17 @@ export class Notification extends BaseEntity {
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* customer_id:
* description: The ID of the Customer that the Notification was sent to.
* description: The ID of the customer that this notification was sent to.
* nullable: true
* type: string
* example: cus_01G2SG30J8C85S4A5CHM2S1NS2
* customer:
* description: A customer object. Available if the relation `customer` is expanded.
* description: The details of the customer that this notification was sent to.
* x-expandable: "customer"
* nullable: true
* $ref: "#/components/schemas/Customer"
* to:
* description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id
* description: The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.
* type: string
* example: user@example.com
* data:
@@ -122,21 +123,24 @@ export class Notification extends BaseEntity {
* type: string
* example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
* parent_notification:
* description: Available if the relation `parent_notification` is expanded.
* description: The details of the parent notification.
* x-expandable: "parent_notification"
* nullable: true
* $ref: "#/components/schemas/Notification"
* resends:
* description: The resends that have been completed after the original Notification. Available if the relation `resends` is expanded.
* description: The details of all resends of the notification.
* type: array
* x-expandable: "resends"
* items:
* $ref: "#/components/schemas/Notification"
* provider_id:
* description: The id of the Notification Provider that handles the Notification.
* description: The ID of the notification provider used to send the notification.
* nullable: true
* type: string
* example: sengrid
* provider:
* description: Available if the relation `provider` is expanded.
* description: The notification provider used to send the notification.
* x-expandable: "provider"
* nullable: true
* $ref: "#/components/schemas/NotificationProvider"
* created_at:
packages/medusa/src/models/oauth.ts
+1 -1
View File
@@ -33,7 +33,7 @@ export class Oauth {
/**
* @schema OAuth
* title: "OAuth"
* description: "Represent an OAuth app"
* description: "An Oauth app is typically created by a plugin to handle authentication to third-party services."
* type: object
* required:
* - application_name
packages/medusa/src/models/order-edit.ts
+9 -5
View File
@@ -123,7 +123,7 @@ export class OrderEdit extends BaseEntity {
/**
* @schema OrderEdit
* title: "Order Edit"
* description: "Order edit keeps track of order items changes."
* description: "Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order. Once the order edit is confirmed, the changes are reflected on the original order."
* type: object
* required:
* - canceled_at
@@ -153,11 +153,13 @@ export class OrderEdit extends BaseEntity {
* type: string
* example: order_01G2SG30J8C85S4A5CHM2S1NS2
* order:
* description: Available if the relation `order` is expanded.
* description: The details of the order that this order edit was created for.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* changes:
* description: Available if the relation `changes` is expanded.
* description: The details of all the changes on the original order's line items.
* x-expandable: "changes"
* type: array
* items:
* $ref: "#/components/schemas/OrderItemChange"
@@ -251,8 +253,9 @@ export class OrderEdit extends BaseEntity {
* - created
* - canceled
* items:
* description: Available if the relation `items` is expanded.
* description: The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.
* type: array
* x-expandable: "items"
* items:
* $ref: "#/components/schemas/LineItem"
* payment_collection_id:
@@ -261,7 +264,8 @@ export class OrderEdit extends BaseEntity {
* type: string
* example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
* payment_collection:
* description: Available if the relation `payment_collection` is expanded.
* description: The details of the payment collection used to authorize additional payment if necessary.
* x-expandable: "payment_collection"
* nullable: true
* $ref: "#/components/schemas/PaymentCollection"
* created_at:
packages/medusa/src/models/order-item-change.ts
+7 -4
View File
@@ -60,7 +60,7 @@ export class OrderItemChange extends SoftDeletableEntity {
/**
* @schema OrderItemChange
* title: "Order Item Change"
* description: "Represents an order edit item change"
* description: "An order item change is a change made within an order edit to an order's items. These changes are not reflected on the original order until the order edit is confirmed."
* type: object
* required:
* - created_at
@@ -88,7 +88,8 @@ export class OrderItemChange extends SoftDeletableEntity {
* type: string
* example: oe_01G2SG30J8C85S4A5CHM2S1NS2
* order_edit:
* description: Available if the relation `order_edit` is expanded.
* description: The details of the order edit the item change is associated with.
* x-expandable: "order_edit"
* nullable: true
* $ref: "#/components/schemas/OrderEdit"
* original_line_item_id:
@@ -97,7 +98,8 @@ export class OrderItemChange extends SoftDeletableEntity {
* type: string
* example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
* original_line_item:
* description: Available if the relation `original_line_item` is expanded.
* description: The details of the original line item this item change references. This is used if the item change updates or deletes the original item.
* x-expandable: "original_line_item"
* nullable: true
* $ref: "#/components/schemas/LineItem"
* line_item_id:
@@ -106,7 +108,8 @@ export class OrderItemChange extends SoftDeletableEntity {
* type: string
* example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
* line_item:
* description: Available if the relation `line_item` is expanded.
* description: The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.
* x-expandable: "line_item"
* nullable: true
* $ref: "#/components/schemas/LineItem"
* created_at:
packages/medusa/src/models/order.ts
+46 -25
View File
@@ -270,7 +270,7 @@ export class Order extends BaseEntity {
/**
* @schema Order
* title: "Order"
* description: "Represents an order"
* description: "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user."
* type: object
* required:
* - billing_address_id
@@ -346,7 +346,8 @@ export class Order extends BaseEntity {
* type: string
* example: cart_01G8ZH853Y6TFXWPG5EYE81X63
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart associated with the order.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* customer_id:
@@ -354,7 +355,8 @@ export class Order extends BaseEntity {
* type: string
* example: cus_01G2SG30J8C85S4A5CHM2S1NS2
* customer:
* description: A customer object. Available if the relation `customer` is expanded.
* description: The details of the customer associated with the order.
* x-expandable: "customer"
* nullable: true
* $ref: "#/components/schemas/Customer"
* email:
@@ -367,7 +369,8 @@ export class Order extends BaseEntity {
* type: string
* example: addr_01G8ZH853YPY9B94857DY91YGW
* billing_address:
* description: Available if the relation `billing_address` is expanded.
* description: The details of the billing address associated with the order.
* x-expandable: "billing_address"
* nullable: true
* $ref: "#/components/schemas/Address"
* shipping_address_id:
@@ -376,15 +379,17 @@ export class Order extends BaseEntity {
* type: string
* example: addr_01G8ZH853YPY9B94857DY91YGW
* shipping_address:
* description: Available if the relation `shipping_address` is expanded.
* description: The details of the shipping address associated with the order.
* x-expandable: "shipping_address"
* nullable: true
* $ref: "#/components/schemas/Address"
* region_id:
* description: The region's ID
* description: The ID of the region this order was created in.
* type: string
* example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
* region:
* description: A region object. Available if the relation `region` is expanded.
* description: The details of the region this order was created in.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Region"
* currency_code:
@@ -395,7 +400,8 @@ export class Order extends BaseEntity {
* url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
* description: See a list of codes.
* currency:
* description: Available if the relation `currency` is expanded.
* description: The details of the currency used in the order.
* x-expandable: "currency"
* nullable: true
* $ref: "#/components/schemas/Currency"
* tax_rate:
@@ -404,72 +410,85 @@ export class Order extends BaseEntity {
* type: number
* example: 0
* discounts:
* description: The discounts used in the order. Available if the relation `discounts` is expanded.
* description: The details of the discounts applied on the order.
* type: array
* x-expandable: "discounts"
* items:
* $ref: "#/components/schemas/Discount"
* gift_cards:
* description: The gift cards used in the order. Available if the relation `gift_cards` is expanded.
* description: The details of the gift card used in the order.
* type: array
* x-expandable: "gift_cards"
* items:
* $ref: "#/components/schemas/GiftCard"
* shipping_methods:
* description: The shipping methods used in the order. Available if the relation `shipping_methods` is expanded.
* description: The details of the shipping methods used in the order.
* type: array
* x-expandable: "shipping_methods"
* items:
* $ref: "#/components/schemas/ShippingMethod"
* payments:
* description: The payments used in the order. Available if the relation `payments` is expanded.
* description: The details of the payments used in the order.
* type: array
* x-expandable: "payments"
* items:
* $ref: "#/components/schemas/Payment"
* fulfillments:
* description: The fulfillments used in the order. Available if the relation `fulfillments` is expanded.
* description: The details of the fulfillments created for the order.
* type: array
* x-expandable: "fulfillments"
* items:
* $ref: "#/components/schemas/Fulfillment"
* returns:
* description: The returns associated with the order. Available if the relation `returns` is expanded.
* description: The details of the returns created for the order.
* type: array
* x-expandable: "returns"
* items:
* $ref: "#/components/schemas/Return"
* claims:
* description: The claims associated with the order. Available if the relation `claims` is expanded.
* description: The details of the claims created for the order.
* type: array
* x-expandable: "claims"
* items:
* $ref: "#/components/schemas/ClaimOrder"
* refunds:
* description: The refunds associated with the order. Available if the relation `refunds` is expanded.
* description: The details of the refunds created for the order.
* type: array
* x-expandable: "refunds"
* items:
* $ref: "#/components/schemas/Refund"
* swaps:
* description: The swaps associated with the order. Available if the relation `swaps` is expanded.
* description: The details of the swaps created for the order.
* type: array
* x-expandable: "swaps"
* items:
* $ref: "#/components/schemas/Swap"
* draft_order_id:
* description: The ID of the draft order this order is associated with.
* description: The ID of the draft order this order was created from.
* nullable: true
* type: string
* example: null
* draft_order:
* description: A draft order object. Available if the relation `draft_order` is expanded.
* description: The details of the draft order this order was created from.
* x-expandable: "draft_order"
* nullable: true
* $ref: "#/components/schemas/DraftOrder"
* items:
* description: The line items that belong to the order. Available if the relation `items` is expanded.
* description: The details of the line items that belong to the order.
* x-expandable: "items"
* type: array
* items:
* $ref: "#/components/schemas/LineItem"
* edits:
* description: Order edits done on the order. Available if the relation `edits` is expanded.
* description: The details of the order edits done on the order.
* type: array
* x-expandable: "edits"
* items:
* $ref: "#/components/schemas/OrderEdit"
* gift_card_transactions:
* description: The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded.
* description: The gift card transactions made in the order.
* type: array
* x-expandable: "gift_card_transactions"
* items:
* $ref: "#/components/schemas/GiftCardTransaction"
* canceled_at:
@@ -495,12 +514,13 @@ export class Order extends BaseEntity {
* type: string
* example: null
* sales_channel_id:
* description: The ID of the sales channel this order is associated with.
* description: The ID of the sales channel this order belongs to.
* nullable: true
* type: string
* example: null
* sales_channel:
* description: A sales channel object. Available if the relation `sales_channel` is expanded.
* description: The details of the sales channel this order belongs to.
* x-expandable: "sales_channel"
* nullable: true
* $ref: "#/components/schemas/SalesChannel"
* shipping_total:
@@ -548,8 +568,9 @@ export class Order extends BaseEntity {
* type: integer
* example: 0
* returnable_items:
* description: The items that are returnable as part of the order, order swaps or order claims
* description: The details of the line items that are returnable as part of the order, swaps, or claims
* type: array
* x-expandable: "returnable_items"
* items:
* $ref: "#/components/schemas/LineItem"
* created_at:
packages/medusa/src/models/payment-collection.ts
+11 -7
View File
@@ -102,7 +102,7 @@ export class PaymentCollection extends SoftDeletableEntity {
/**
* @schema PaymentCollection
* title: "Payment Collection"
* description: "Payment Collection"
* description: "A payment collection allows grouping and managing a list of payments at one. This can be helpful when making additional payment for order edits or integrating installment payments."
* type: object
* required:
* - amount
@@ -149,32 +149,36 @@ export class PaymentCollection extends SoftDeletableEntity {
* nullable: true
* type: integer
* region_id:
* description: The region's ID
* description: The ID of the region this payment collection is associated with.
* type: string
* example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
* region:
* description: Available if the relation `region` is expanded.
* description: The details of the region this payment collection is associated with.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Region"
* currency_code:
* description: The 3 character ISO code for the currency.
* description: The 3 character ISO code for the currency this payment collection is associated with.
* type: string
* example: usd
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
* description: See a list of codes.
* currency:
* description: Available if the relation `currency` is expanded.
* description: The details of the currency this payment collection is associated with.
* x-expandable: "currency"
* nullable: true
* $ref: "#/components/schemas/Currency"
* payment_sessions:
* description: Available if the relation `payment_sessions` is expanded.
* description: The details of the payment sessions created as part of the payment collection.
* type: array
* x-expandable: "payment_sessions"
* items:
* $ref: "#/components/schemas/PaymentSession"
* payments:
* description: Available if the relation `payments` is expanded.
* description: The details of the payments created as part of the payment collection.
* type: array
* x-expandable: "payments"
* items:
* $ref: "#/components/schemas/Payment"
* created_by:
packages/medusa/src/models/payment-provider.ts
+4 -3
View File
@@ -12,18 +12,19 @@ export class PaymentProvider {
/**
* @schema PaymentProvider
* title: "Payment Provider"
* description: "Represents a Payment Provider plugin and holds its installation status."
* description: "A payment provider represents a payment service installed in the Medusa backend, either through a plugin or backend customizations.
* It holds the payment service's installation status."
* type: object
* required:
* - id
* - is_installed
* properties:
* id:
* description: The id of the payment provider as given by the plugin.
* description: The ID of the payment provider as given by the payment service.
* type: string
* example: manual
* is_installed:
* description: Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`.
* description: Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.
* type: boolean
* default: true
*/
packages/medusa/src/models/payment-session.ts
+5 -4
View File
@@ -70,7 +70,7 @@ export class PaymentSession extends BaseEntity {
/**
* @schema PaymentSession
* title: "Payment Session"
* description: "Payment Sessions are created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, who is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for capture/refunds/etc."
* description: "A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections."
* type: object
* required:
* - amount
@@ -91,16 +91,17 @@ export class PaymentSession extends BaseEntity {
* type: string
* example: ps_01G901XNSRM2YS3ASN9H5KG3FZ
* cart_id:
* description: The id of the Cart that the Payment Session is created for.
* description: The ID of the cart that the payment session was created for.
* nullable: true
* type: string
* example: cart_01G8ZH853Y6TFXWPG5EYE81X63
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart that the payment session was created for.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* provider_id:
* description: The id of the Payment Provider that is responsible for the Payment Session
* description: The ID of the Payment Provider that is responsible for the Payment Session
* type: string
* example: manual
* is_selected:
packages/medusa/src/models/payment.ts
+13 -9
View File
@@ -89,7 +89,7 @@ export class Payment extends BaseEntity {
/**
* @schema Payment
* title: "Payment"
* description: "Payments represent an amount authorized with a given payment method, Payments can be captured, canceled or refunded."
* description: "A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources."
* type: object
* required:
* - amount
@@ -113,29 +113,32 @@ export class Payment extends BaseEntity {
* type: string
* example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE
* swap_id:
* description: The ID of the Swap that the Payment is used for.
* description: The ID of the swap that this payment was potentially created for.
* nullable: true
* type: string
* example: null
* swap:
* description: A swap object. Available if the relation `swap` is expanded.
* description: The details of the swap that this payment was potentially created for.
* x-expandable: "swap"
* nullable: true
* $ref: "#/components/schemas/Swap"
* cart_id:
* description: The id of the Cart that the Payment Session is created for.
* description: The ID of the cart that the payment session was potentially created for.
* nullable: true
* type: string
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart that the payment session was potentially created for.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* order_id:
* description: The ID of the Order that the Payment is used for.
* description: The ID of the order that the payment session was potentially created for.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that the payment session was potentially created for.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* amount:
@@ -143,14 +146,15 @@ export class Payment extends BaseEntity {
* type: integer
* example: 100
* currency_code:
* description: The 3 character ISO currency code that the Payment is completed in.
* description: The 3 character ISO currency code of the payment.
* type: string
* example: usd
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
* description: See a list of codes.
* currency:
* description: Available if the relation `currency` is expanded.
* description: The details of the currency of the payment.
* x-expandable: "currency"
* nullable: true
* $ref: "#/components/schemas/Currency"
* amount_refunded:
packages/medusa/src/models/price-list.ts
+7 -4
View File
@@ -72,7 +72,7 @@ export class PriceList extends SoftDeletableEntity {
/**
* @schema PriceList
* title: "Price List"
* description: "Price Lists represents a set of prices that overrides the default price for one or more product variants."
* description: "A Price List represents a set of prices that override the default price for one or more product variants."
* type: object
* required:
* - created_at
@@ -123,18 +123,21 @@ export class PriceList extends SoftDeletableEntity {
* type: string
* format: date-time
* customer_groups:
* description: The Customer Groups that the Price List applies to. Available if the relation `customer_groups` is expanded.
* description: The details of the customer groups that the Price List can apply to.
* type: array
* x-expandable: "customer_groups"
* items:
* $ref: "#/components/schemas/CustomerGroup"
* prices:
* description: The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded.
* description: The prices that belong to the price list, represented as a Money Amount.
* type: array
* x-expandable: "prices"
* items:
* $ref: "#/components/schemas/MoneyAmount"
* includes_tax:
* description: "[EXPERIMENTAL] Does the price list prices include tax"
* description: "Whether the price list prices include tax"
* type: boolean
* x-featureFlag: "tax_inclusive_pricing"
* default: false
* created_at:
* description: The date with timezone at which the resource was created.
packages/medusa/src/models/product-category.ts
+9 -5
View File
@@ -84,9 +84,10 @@ export class ProductCategory extends BaseEntity {
/**
* @schema ProductCategory
* title: "ProductCategory"
* description: "Represents a product category"
* title: "Product Category"
* description: "A product category can be used to categorize products into a hierarchy of categories."
* x-resourceId: ProductCategory
* x-featureFlag: "product_categories"
* type: object
* required:
* - category_children
@@ -130,8 +131,9 @@ export class ProductCategory extends BaseEntity {
* description: An integer that depicts the rank of category in a tree node
* default: 0
* category_children:
* description: Available if the relation `category_children` are expanded.
* description: The details of the category's children.
* type: array
* x-expandable: "category_children"
* items:
* $ref: "#/components/schemas/ProductCategory"
* parent_category_id:
@@ -140,12 +142,14 @@ export class ProductCategory extends BaseEntity {
* type: string
* default: null
* parent_category:
* description: A product category object. Available if the relation `parent_category` is expanded.
* description: The details of the parent of this category.
* x-expandable: "parent_category"
* nullable: true
* $ref: "#/components/schemas/ProductCategory"
* products:
* description: Products associated with category. Available if the relation `products` is expanded.
* description: The details of the products that belong to this category.
* type: array
* x-expandable: "products"
* items:
* $ref: "#/components/schemas/Product"
* created_at:
packages/medusa/src/models/product-collection.ts
+3 -2
View File
@@ -35,7 +35,7 @@ export class ProductCollection extends SoftDeletableEntity {
/**
* @schema ProductCollection
* title: "Product Collection"
* description: "Product Collections represents a group of Products that are related."
* description: "A Product Collection allows grouping together products for promotional purposes. For example, an admin can create a Summer collection, add products to it, and showcase it on the storefront."
* type: object
* required:
* - created_at
@@ -60,8 +60,9 @@ export class ProductCollection extends SoftDeletableEntity {
* type: string
* example: summer-collection
* products:
* description: The Products contained in the Product Collection. Available if the relation `products` is expanded.
* description: The details of the products that belong to this product collection.
* type: array
* x-expandable: "products"
* items:
* $ref: "#/components/schemas/Product"
* created_at:
packages/medusa/src/models/product-option-value.ts
+8 -6
View File
@@ -48,7 +48,7 @@ export class ProductOptionValue extends SoftDeletableEntity {
/**
* @schema ProductOptionValue
* title: "Product Option Value"
* description: "A value given to a Product Variant's option set. Product Variant have a Product Option Value for each of the Product Options defined on the Product."
* description: "An option value is one of the possible values of a Product Option. Product Variants specify a unique combination of product option values."
* type: object
* required:
* - created_at
@@ -65,23 +65,25 @@ export class ProductOptionValue extends SoftDeletableEntity {
* type: string
* example: optval_01F0YESHR7S6ECD03RF6W12DSJ
* value:
* description: The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be `Small`, `Medium` or `Large`).
* description: The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is "Size" this value could be `Small`, `Medium` or `Large`).
* type: string
* example: large
* option_id:
* description: The ID of the Product Option that the Product Option Value is defined for.
* description: The ID of the Product Option that the Product Option Value belongs to.
* type: string
* example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
* option:
* description: Available if the relation `option` is expanded.
* description: The details of the product option that the Product Option Value belongs to.
* x-expandable: "option"
* nullable: true
* $ref: "#/components/schemas/ProductOption"
* variant_id:
* description: The ID of the Product Variant that the Product Option Value is defined for.
* description: The ID of the product variant that uses this product option value.
* type: string
* example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
* variant:
* description: Available if the relation `variant` is expanded.
* description: The details of the product variant that uses this product option value.
* x-expandable: "variant"
* nullable: true
* $ref: "#/components/schemas/ProductVariant"
* created_at:
packages/medusa/src/models/product-option.ts
+6 -4
View File
@@ -42,7 +42,7 @@ export class ProductOption extends SoftDeletableEntity {
/**
* @schema ProductOption
* title: "Product Option"
* description: "Product Options define properties that may vary between different variants of a Product. Common Product Options are \"Size\" and \"Color\", but Medusa doesn't limit what Product Options that can be defined."
* description: A Product Option defines properties that may vary between different variants of a Product. Common Product Options are "Size" and "Color". Admins are free to create any product options.
* type: object
* required:
* - created_at
@@ -62,16 +62,18 @@ export class ProductOption extends SoftDeletableEntity {
* type: string
* example: Size
* values:
* description: The Product Option Values that are defined for the Product Option. Available if the relation `values` is expanded.
* description: The details of the values of the product option.
* type: array
* x-expandable: "values"
* items:
* $ref: "#/components/schemas/ProductOptionValue"
* product_id:
* description: The ID of the Product that the Product Option is defined for.
* description: The ID of the product that this product option belongs to.
* type: string
* example: prod_01G1G5V2MBA328390B5AXJ610F
* product:
* description: A product object. Available if the relation `product` is expanded.
* description: The details of the product that this product option belongs to.
* x-expandable: "product"
* nullable: true
* $ref: "#/components/schemas/Product"
* created_at:
packages/medusa/src/models/product-tag.ts
+1 -1
View File
@@ -21,7 +21,7 @@ export class ProductTag extends SoftDeletableEntity {
/**
* @schema ProductTag
* title: "Product Tag"
* description: "Product Tags can be added to Products for easy filtering and grouping."
* description: "A Product Tag can be added to Products for easy filtering and grouping."
* type: object
* required:
* - created_at
packages/medusa/src/models/product-tax-rate.ts
+5 -3
View File
@@ -41,7 +41,7 @@ export class ProductTaxRate {
/**
* @schema ProductTaxRate
* title: "Product Tax Rate"
* description: "Associates a tax rate with a product to indicate that the product is taxed in a certain way"
* description: "This represents the association between a tax rate and a product to indicate that the product is taxed in a way different than the default."
* type: object
* required:
* - created_at
@@ -55,7 +55,8 @@ export class ProductTaxRate {
* type: string
* example: prod_01G1G5V2MBA328390B5AXJ610F
* product:
* description: Available if the relation `product` is expanded.
* description: The details of the product.
* x-expandable: "product"
* nullable: true
* $ref: "#/components/schemas/Product"
* rate_id:
@@ -63,7 +64,8 @@ export class ProductTaxRate {
* type: string
* example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
* tax_rate:
* description: Available if the relation `tax_rate` is expanded.
* description: The details of the tax rate.
* x-expandable: "tax_rate"
* nullable: true
* $ref: "#/components/schemas/TaxRate"
* created_at:
packages/medusa/src/models/product-type-tax-rate.ts
+5 -3
View File
@@ -40,7 +40,7 @@ export class ProductTypeTaxRate {
/**
* @schema ProductTypeTaxRate
* title: "Product Type Tax Rate"
* description: "Associates a tax rate with a product type to indicate that the product type is taxed in a certain way"
* description: "This represents the association between a tax rate and a product type to indicate that the product type is taxed in a different way than the default."
* type: object
* required:
* - created_at
@@ -54,7 +54,8 @@ export class ProductTypeTaxRate {
* type: string
* example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
* product_type:
* description: Available if the relation `product_type` is expanded.
* description: The details of the product type.
* x-expandable: "product_type"
* nullable: true
* $ref: "#/components/schemas/ProductType"
* rate_id:
@@ -62,7 +63,8 @@ export class ProductTypeTaxRate {
* type: string
* example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
* tax_rate:
* description: Available if the relation `tax_rate` is expanded.
* description: The details of the tax rate.
* x-expandable: "tax_rate"
* nullable: true
* $ref: "#/components/schemas/TaxRate"
* created_at:
packages/medusa/src/models/product-type.ts
+1 -1
View File
@@ -21,7 +21,7 @@ export class ProductType extends SoftDeletableEntity {
/**
* @schema ProductType
* title: "Product Type"
* description: "Product Type can be added to Products for filtering and reporting purposes."
* description: "A Product Type can be added to Products for filtering and reporting purposes."
* type: object
* required:
* - created_at
packages/medusa/src/models/product-variant-inventory-item.ts
+4 -3
View File
@@ -36,7 +36,7 @@ export class ProductVariantInventoryItem extends SoftDeletableEntity {
/**
* @schema ProductVariantInventoryItem
* title: "Product Variant Inventory Item"
* description: "Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant."
* description: "A Product Variant Inventory Item links variants with inventory items and denotes the required quantity of the variant."
* type: object
* required:
* - created_at
@@ -58,11 +58,12 @@ export class ProductVariantInventoryItem extends SoftDeletableEntity {
* description: The id of the variant.
* type: string
* variant:
* description: A ProductVariant object. Available if the relation `variant` is expanded.
* description: The details of the product variant.
* x-expandable: "variant"
* nullable: true
* $ref: "#/components/schemas/ProductVariant"
* required_quantity:
* description: The quantity of an inventory item required for one quantity of the variant.
* description: The quantity of an inventory item required for the variant.
* type: integer
* default: 1
* created_at:
packages/medusa/src/models/product-variant.ts
+10 -6
View File
@@ -114,7 +114,7 @@ export class ProductVariant extends SoftDeletableEntity {
/**
* @schema ProductVariant
* title: "Product Variant"
* description: "Product Variants represent a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations."
* description: "A Product Variant represents a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations. A product must at least have one product variant."
* type: object
* required:
* - allow_backorder
@@ -149,16 +149,18 @@ export class ProductVariant extends SoftDeletableEntity {
* type: string
* example: Small
* product_id:
* description: The ID of the Product that the Product Variant belongs to.
* description: The ID of the product that the product variant belongs to.
* type: string
* example: prod_01G1G5V2MBA328390B5AXJ610F
* product:
* description: A product object. Available if the relation `product` is expanded.
* description: The details of the product that the product variant belongs to.
* x-expandable: "product"
* nullable: true
* $ref: "#/components/schemas/Product"
* prices:
* description: The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded.
* description: The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.
* type: array
* x-expandable: "prices"
* items:
* $ref: "#/components/schemas/MoneyAmount"
* sku:
@@ -239,13 +241,15 @@ export class ProductVariant extends SoftDeletableEntity {
* type: number
* example: null
* options:
* description: The Product Option Values specified for the Product Variant. Available if the relation `options` is expanded.
* description: The details of the product options that this product variant defines values for.
* type: array
* x-expandable: "options"
* items:
* $ref: "#/components/schemas/ProductOptionValue"
* inventory_items:
* description: The Inventory Items related to the product variant. Available if the relation `inventory_items` is expanded.
* description: The details inventory items of the product variant.
* type: array
* x-expandable: "inventory_items"
* items:
* $ref: "#/components/schemas/ProductVariantInventoryItem"
* created_at:
packages/medusa/src/models/product.ts
+23 -13
View File
@@ -224,7 +224,7 @@ export class Product extends SoftDeletableEntity {
/**
* @schema Product
* title: "Product"
* description: "Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by."
* description: "A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level."
* type: object
* required:
* - collection_id
@@ -289,8 +289,9 @@ export class Product extends SoftDeletableEntity {
* - rejected
* default: draft
* images:
* description: Images of the Product. Available if the relation `images` is expanded.
* description: The details of the product's images.
* type: array
* x-expandable: "images"
* items:
* $ref: "#/components/schemas/Image"
* thumbnail:
@@ -299,26 +300,31 @@ export class Product extends SoftDeletableEntity {
* type: string
* format: uri
* options:
* description: The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values. Available if the relation `options` is expanded.
* description: The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.
* type: array
* x-expandable: "options"
* items:
* $ref: "#/components/schemas/ProductOption"
* variants:
* description: The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values. Available if the relation `variants` is expanded.
* description: The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.
* type: array
* x-expandable: "variants"
* items:
* $ref: "#/components/schemas/ProductVariant"
* categories:
* description: The product's associated categories. Available if the relation `categories` are expanded.
* description: The details of the product categories that this product belongs to.
* type: array
* x-expandable: "categories"
* x-featureFlag: "product_categories"
* items:
* $ref: "#/components/schemas/ProductCategory"
* profile_id:
* description: The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products.
* description: The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.
* type: string
* example: sp_01G1G5V239ENSZ5MV4JAR737BM
* profile:
* description: Available if the relation `profile` is expanded.
* description: The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.
* x-expandable: "profile"
* nullable: true
* $ref: "#/components/schemas/ShippingProfile"
* profiles:
@@ -368,26 +374,29 @@ export class Product extends SoftDeletableEntity {
* type: string
* example: null
* collection_id:
* description: The Product Collection that the Product belongs to
* description: The ID of the product collection that the product belongs to.
* nullable: true
* type: string
* example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
* collection:
* description: A product collection object. Available if the relation `collection` is expanded.
* description: The details of the product collection that the product belongs to.
* x-expandable: "collection"
* nullable: true
* $ref: "#/components/schemas/ProductCollection"
* type_id:
* description: The Product type that the Product belongs to
* description: The ID of the product type that the product belongs to.
* nullable: true
* type: string
* example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
* type:
* description: Available if the relation `type` is expanded.
* description: The details of the product type that the product belongs to.
* x-expandable: "type"
* nullable: true
* $ref: "#/components/schemas/ProductType"
* tags:
* description: The Product Tags assigned to the Product. Available if the relation `tags` is expanded.
* description: The details of the product tags used in this product.
* type: array
* x-expandable: "type"
* items:
* $ref: "#/components/schemas/ProductTag"
* discountable:
@@ -400,8 +409,9 @@ export class Product extends SoftDeletableEntity {
* type: string
* example: null
* sales_channels:
* description: The sales channels the product is associated with. Available if the relation `sales_channels` is expanded.
* description: The details of the sales channels this product is available in.
* type: array
* x-expandable: "sales_channels"
* items:
* $ref: "#/components/schemas/SalesChannel"
* created_at:
packages/medusa/src/models/publishable-api-key-sales-channel.ts
+2 -2
View File
@@ -11,8 +11,8 @@ export class PublishableApiKeySalesChannel {
/**
* @schema PublishableApiKeySalesChannel
* title: "Publishable API key sales channel"
* description: "Holds mapping between Publishable API keys and Sales Channels"
* title: "Publishable API Key Sales Channel"
* description: "This represents the association between the Publishable API keys and Sales Channels"
* type: object
* required:
* - publishable_key_id
packages/medusa/src/models/publishable-api-key.ts
+1 -1
View File
@@ -26,7 +26,7 @@ export class PublishableApiKey extends BaseEntity {
/**
* @schema PublishableApiKey
* title: "Publishable API key"
* description: "Publishable API key defines scopes (i.e. resources) that are available within a request."
* description: "A Publishable API key defines scopes that resources are available in. Then, it can be used in request to infer the resources without having to directly pass them. For example, a publishable API key can be associated with one or more sales channels. Then, when the publishable API key is passed in the header of a request, it is inferred what sales channel is being used without having to pass the sales channel as a query or body parameter of the request. Publishable API keys can only be used with sales channels, at the moment."
* type: object
* required:
* - created_at
packages/medusa/src/models/refund.ts
+7 -5
View File
@@ -64,7 +64,7 @@ export class Refund extends BaseEntity {
/**
* @schema Refund
* title: "Refund"
* description: "Refund represent an amount of money transfered back to the Customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by a store operator."
* description: "A refund represents an amount of money transfered back to the customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by an admin for an order."
* type: object
* required:
* - amount
@@ -83,21 +83,23 @@ export class Refund extends BaseEntity {
* type: string
* example: ref_01G1G5V27GYX4QXNARRQCW1N8T
* order_id:
* description: The id of the Order that the Refund is related to.
* description: The ID of the order this refund was created for.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order this refund was created for.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* payment_id:
* description: The payment's ID if available
* description: The payment's ID, if available.
* nullable: true
* type: string
* example: pay_01G8ZCC5W42ZNY842124G7P5R9
* payment:
* description: Available if the relation `payment` is expanded.
* description: The details of the payment associated with the refund.
* x-expandable: "payment"
* nullable: true
* $ref: "#/components/schemas/Payment"
* amount:
packages/medusa/src/models/region.ts
+16 -9
View File
@@ -107,7 +107,7 @@ export class Region extends SoftDeletableEntity {
/**
* @schema Region
* title: "Region"
* description: "Regions hold settings for how Customers in a given geographical location shop. The is, for example, where currencies and tax rates are defined. A Region can consist of multiple countries to accomodate common shopping settings across countries."
* description: "A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries."
* type: object
* required:
* - automatic_taxes
@@ -132,14 +132,15 @@ export class Region extends SoftDeletableEntity {
* type: string
* example: EU
* currency_code:
* description: The 3 character currency code that the Region uses.
* description: The 3 character currency code used in the region.
* type: string
* example: usd
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
* description: See a list of codes.
* currency:
* description: Available if the relation `currency` is expanded.
* description: The details of the currency used in the region.
* x-expandable: "currency"
* nullable: true
* $ref: "#/components/schemas/Currency"
* tax_rate:
@@ -147,8 +148,9 @@ export class Region extends SoftDeletableEntity {
* type: number
* example: 0
* tax_rates:
* description: The tax rates that are included in the Region. Available if the relation `tax_rates` is expanded.
* description: The details of the tax rates used in the region, aside from the default rate.
* type: array
* x-expandable: "tax_rates"
* items:
* $ref: "#/components/schemas/TaxRate"
* tax_code:
@@ -165,8 +167,9 @@ export class Region extends SoftDeletableEntity {
* type: boolean
* default: true
* countries:
* description: The countries that are included in the Region. Available if the relation `countries` is expanded.
* description: The details of the countries included in this region.
* type: array
* x-expandable: "countries"
* items:
* $ref: "#/components/schemas/Country"
* tax_provider_id:
@@ -175,22 +178,26 @@ export class Region extends SoftDeletableEntity {
* type: string
* example: null
* tax_provider:
* description: Available if the relation `tax_provider` is expanded.
* description: The details of the tax provider used in the region.
* x-expandable: "tax_provider"
* nullable: true
* $ref: "#/components/schemas/TaxProvider"
* payment_providers:
* description: The Payment Providers that can be used to process Payments in the Region. Available if the relation `payment_providers` is expanded.
* description: The details of the payment providers that can be used to process payments in the region.
* type: array
* x-expandable: "payment_providers"
* items:
* $ref: "#/components/schemas/PaymentProvider"
* fulfillment_providers:
* description: The Fulfillment Providers that can be used to fulfill orders in the Region. Available if the relation `fulfillment_providers` is expanded.
* description: The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.
* type: array
* x-expandable: "fulfillment_providers"
* items:
* $ref: "#/components/schemas/FulfillmentProvider"
* includes_tax:
* description: "[EXPERIMENTAL] Does the prices for the region include tax"
* description: "Whether the prices for the region include tax"
* type: boolean
* x-featureFlag: "tax_inclusive_pricing"
* default: false
* created_at:
* description: The date with timezone at which the resource was created.
packages/medusa/src/models/return-item.ts
+10 -7
View File
@@ -50,7 +50,7 @@ export class ReturnItem {
/**
* @schema ReturnItem
* title: "Return Item"
* description: "Correlates a Line Item with a Return, keeping track of the quantity of the Line Item that will be returned."
* description: "A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it."
* type: object
* required:
* - is_requested
@@ -64,23 +64,25 @@ export class ReturnItem {
* - return_id
* properties:
* return_id:
* description: The id of the Return that the Return Item belongs to.
* description: The ID of the Return that the Return Item belongs to.
* type: string
* example: ret_01F0YET7XPCMF8RZ0Y151NZV2V
* item_id:
* description: The id of the Line Item that the Return Item references.
* description: The ID of the Line Item that the Return Item references.
* type: string
* example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
* return_order:
* description: Available if the relation `return_order` is expanded.
* description: Details of the Return that the Return Item belongs to.
* x-expandable: "return_order"
* nullable: true
* $ref: "#/components/schemas/Return"
* item:
* description: Available if the relation `item` is expanded.
* description: The details of the line item in the original order to be returned.
* x-expandable: "item"
* nullable: true
* $ref: "#/components/schemas/LineItem"
* quantity:
* description: The quantity of the Line Item that is included in the Return.
* description: The quantity of the Line Item to be returned.
* type: integer
* example: 1
* is_requested:
@@ -103,7 +105,8 @@ export class ReturnItem {
* type: string
* example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ
* reason:
* description: Available if the relation `reason` is expanded.
* description: The details of the reason for returning the item.
* x-expandable: "reason"
* nullable: true
* $ref: "#/components/schemas/ReturnReason"
* note:
packages/medusa/src/models/return-reason.ts
+5 -3
View File
@@ -50,7 +50,7 @@ export class ReturnReason extends SoftDeletableEntity {
/**
* @schema ReturnReason
* title: "Return Reason"
* description: "A Reason for why a given product is returned. A Return Reason can be used on Return Items in order to indicate why a Line Item was returned."
* description: "A Return Reason is a value defined by an admin. It can be used on Return Items in order to indicate why a Line Item was returned."
* type: object
* required:
* - created_at
@@ -86,11 +86,13 @@ export class ReturnReason extends SoftDeletableEntity {
* type: string
* example: null
* parent_return_reason:
* description: Available if the relation `parent_return_reason` is expanded.
* description: The details of the parent reason.
* x-expandable: "parent_return_reason"
* nullable: true
* $ref: "#/components/schemas/ReturnReason"
* return_reason_children:
* description: Available if the relation `return_reason_children` is expanded.
* description: The details of the child reasons.
* x-expandable: "return_reason_children"
* $ref: "#/components/schemas/ReturnReason"
* created_at:
* description: The date with timezone at which the resource was created.
packages/medusa/src/models/return.ts
+15 -10
View File
@@ -100,7 +100,7 @@ export class Return extends BaseEntity {
/**
* @schema Return
* title: "Return"
* description: "Return orders hold information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can be used as part of a Swap."
* description: "A Return holds information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can also be used as part of a Swap or a Claim."
* type: object
* required:
* - claim_order_id
@@ -132,39 +132,44 @@ export class Return extends BaseEntity {
* - canceled
* default: requested
* items:
* description: The Return Items that will be shipped back to the warehouse. Available if the relation `items` is expanded.
* description: The details of the items that the customer is returning.
* type: array
* x-expandable: "items"
* items:
* $ref: "#/components/schemas/ReturnItem"
* swap_id:
* description: The ID of the Swap that the Return is a part of.
* description: The ID of the swap that the return may belong to.
* nullable: true
* type: string
* example: null
* swap:
* description: A swap object. Available if the relation `swap` is expanded.
* description: The details of the swap that the return may belong to.
* x-expandable: "swap"
* nullable: true
* $ref: "#/components/schemas/Swap"
* claim_order_id:
* description: The ID of the Claim that the Return is a part of.
* description: The ID of the claim that the return may belong to.
* nullable: true
* type: string
* example: null
* claim_order:
* description: A claim order object. Available if the relation `claim_order` is expanded.
* description: The details of the claim that the return may belong to.
* x-expandable: "claim_order"
* nullable: true
* $ref: "#/components/schemas/ClaimOrder"
* order_id:
* description: The ID of the Order that the Return is made from.
* description: The ID of the order that the return was created for.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that the return was created for.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* shipping_method:
* description: The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded.
* description: The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.
* x-expandable: "shipping_method"
* nullable: true
* $ref: "#/components/schemas/ShippingMethod"
* shipping_data:
@@ -173,7 +178,7 @@ export class Return extends BaseEntity {
* type: object
* example: {}
* location_id:
* description: The id of the stock location the return will be added back.
* description: The ID of the stock location the return will be added back.
* nullable: true
* type: string
* example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
packages/medusa/src/models/sales-channel-location.ts
+5 -4
View File
@@ -28,7 +28,7 @@ export class SalesChannelLocation extends SoftDeletableEntity {
/**
* @schema SalesChannelLocation
* title: "Sales Channel Stock Location"
* description: "Sales Channel Stock Location link sales channels with stock locations."
* description: "This represents the association between a sales channel and a stock locations."
* type: object
* required:
* - created_at
@@ -43,14 +43,15 @@ export class SalesChannelLocation extends SoftDeletableEntity {
* type: string
* example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A
* sales_channel_id:
* description: "The id of the Sales Channel"
* description: "The ID of the Sales Channel"
* type: string
* example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
* location_id:
* description: "The id of the Location Stock."
* description: "The ID of the Location Stock."
* type: string
* sales_channel:
* description: The sales channel the location is associated with. Available if the relation `sales_channel` is expanded.
* description: The details of the sales channel the location is associated with.
* x-expandable: "sales_channel"
* nullable: true
* $ref: "#/components/schemas/SalesChannel"
* created_at:
packages/medusa/src/models/sales-channel.ts
+3 -2
View File
@@ -37,7 +37,7 @@ export class SalesChannel extends SoftDeletableEntity {
/**
* @schema SalesChannel
* title: "Sales Channel"
* description: "A Sales Channel"
* description: "A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another."
* type: object
* required:
* - created_at
@@ -66,8 +66,9 @@ export class SalesChannel extends SoftDeletableEntity {
* type: boolean
* default: false
* locations:
* description: The Stock Locations related to the sales channel. Available if the relation `locations` is expanded.
* description: The details of the stock locations related to the sales channel.
* type: array
* x-expandable: "locations"
* items:
* $ref: "#/components/schemas/SalesChannelLocation"
* created_at:
packages/medusa/src/models/shipping-method-tax-line.ts
+3 -2
View File
@@ -32,7 +32,7 @@ export class ShippingMethodTaxLine extends TaxLine {
/**
* @schema ShippingMethodTaxLine
* title: "Shipping Method Tax Line"
* description: "Shipping Method Tax Line"
* description: "A Shipping Method Tax Line represents the taxes applied on a shipping method in a cart."
* type: object
* required:
* - code
@@ -66,7 +66,8 @@ export class ShippingMethodTaxLine extends TaxLine {
* type: string
* example: sm_01F0YET7DR2E7CYVSDHM593QG2
* shipping_method:
* description: Available if the relation `shipping_method` is expanded.
* description: The details of the associated shipping method.
* x-expandable: "shipping_method"
* nullable: true
* $ref: "#/components/schemas/ShippingMethod"
* created_at:
packages/medusa/src/models/shipping-method.ts
+23 -15
View File
@@ -107,7 +107,7 @@ export class ShippingMethod {
/**
* @schema ShippingMethod
* title: "Shipping Method"
* description: "Shipping Methods represent a way in which an Order or Return can be shipped. Shipping Methods are built from a Shipping Option, but may contain additional details, that can be necessary for the Fulfillment Provider to handle the shipment."
* description: "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of."
* type: object
* required:
* - cart_id
@@ -125,61 +125,68 @@ export class ShippingMethod {
* type: string
* example: sm_01F0YET7DR2E7CYVSDHM593QG2
* shipping_option_id:
* description: The id of the Shipping Option that the Shipping Method is built from.
* description: The ID of the Shipping Option that the Shipping Method is built from.
* type: string
* example: so_01G1G5V27GYX4QXNARRQCW1N8T
* order_id:
* description: The id of the Order that the Shipping Method is used on.
* description: The ID of the order that the shipping method is used in.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that the shipping method is used in.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* claim_order_id:
* description: The id of the Claim that the Shipping Method is used on.
* description: The ID of the claim that the shipping method is used in.
* nullable: true
* type: string
* example: null
* claim_order:
* description: A claim order object. Available if the relation `claim_order` is expanded.
* description: The details of the claim that the shipping method is used in.
* x-expandable: "claim_order"
* nullable: true
* $ref: "#/components/schemas/ClaimOrder"
* cart_id:
* description: The id of the Cart that the Shipping Method is used on.
* description: The ID of the cart that the shipping method is used in.
* nullable: true
* type: string
* example: cart_01G8ZH853Y6TFXWPG5EYE81X63
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart that the shipping method is used in.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* swap_id:
* description: The id of the Swap that the Shipping Method is used on.
* description: The ID of the swap that the shipping method is used in.
* nullable: true
* type: string
* example: null
* swap:
* description: A swap object. Available if the relation `swap` is expanded.
* description: The details of the swap that the shipping method is used in.
* x-expandable: "swap"
* nullable: true
* $ref: "#/components/schemas/Swap"
* return_id:
* description: The id of the Return that the Shipping Method is used on.
* description: The ID of the return that the shipping method is used in.
* nullable: true
* type: string
* example: null
* return_order:
* description: A return object. Available if the relation `return_order` is expanded.
* description: The details of the return that the shipping method is used in.
* x-expandable: "return_order"
* nullable: true
* $ref: "#/components/schemas/Return"
* shipping_option:
* description: Available if the relation `shipping_option` is expanded.
* description: The details of the shipping option the method was created from.
* x-expandable: "shipping_option"
* nullable: true
* $ref: "#/components/schemas/ShippingOption"
* tax_lines:
* description: Available if the relation `tax_lines` is expanded.
* description: The details of the tax lines applied on the shipping method.
* type: array
* x-expandable: "tax_lines"
* items:
* $ref: "#/components/schemas/ShippingMethodTaxLine"
* price:
@@ -191,8 +198,9 @@ export class ShippingMethod {
* type: object
* example: {}
* includes_tax:
* description: "[EXPERIMENTAL] Indicates if the shipping method price include tax"
* description: "Whether the shipping method price include tax"
* type: boolean
* x-featureFlag: "tax_inclusive_pricing"
* default: false
* subtotal:
* description: The subtotal of the shipping
packages/medusa/src/models/shipping-option-requirement.ts
+4 -3
View File
@@ -49,7 +49,7 @@ export class ShippingOptionRequirement {
/**
* @schema ShippingOptionRequirement
* title: "Shipping Option Requirement"
* description: "A requirement that a Cart must satisfy for the Shipping Option to be available to the Cart."
* description: "A shipping option requirement defines conditions that a Cart must satisfy for the Shipping Option to be available for usage in the Cart."
* type: object
* required:
* - amount
@@ -63,11 +63,12 @@ export class ShippingOptionRequirement {
* type: string
* example: sor_01G1G5V29AB4CTNDRFSRWSRKWD
* shipping_option_id:
* description: The id of the Shipping Option that the hipping option requirement belongs to
* description: The ID of the shipping option that the requirements belong to.
* type: string
* example: so_01G1G5V27GYX4QXNARRQCW1N8T
* shipping_option:
* description: Available if the relation `shipping_option` is expanded.
* description: The details of the shipping option that the requirements belong to.
* x-expandable: "shipping_option"
* nullable: true
* $ref: "#/components/schemas/ShippingOption"
* type:
packages/medusa/src/models/shipping-option.ts
+14 -9
View File
@@ -89,7 +89,7 @@ export class ShippingOption extends SoftDeletableEntity {
/**
* @schema ShippingOption
* title: "Shipping Option"
* description: "Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information."
* description: "A Shipping Option represents a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information."
* type: object
* required:
* - admin_only
@@ -116,27 +116,30 @@ export class ShippingOption extends SoftDeletableEntity {
* type: string
* example: PostFake Standard
* region_id:
* description: The region's ID
* description: The ID of the region this shipping option can be used in.
* type: string
* example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
* region:
* description: A region object. Available if the relation `region` is expanded.
* description: The details of the region this shipping option can be used in.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Region"
* profile_id:
* description: The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products.
* description: The ID of the Shipping Profile that the shipping option belongs to.
* type: string
* example: sp_01G1G5V239ENSZ5MV4JAR737BM
* profile:
* description: Available if the relation `profile` is expanded.
* description: The details of the shipping profile that the shipping option belongs to.
* x-expandable: "profile"
* nullable: true
* $ref: "#/components/schemas/ShippingProfile"
* provider_id:
* description: The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option.
* description: The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.
* type: string
* example: manual
* provider:
* description: Available if the relation `provider` is expanded.
* description: The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.
* x-expandable: "provider"
* nullable: true
* $ref: "#/components/schemas/FulfillmentProvider"
* price_type:
@@ -160,8 +163,9 @@ export class ShippingOption extends SoftDeletableEntity {
* type: boolean
* default: false
* requirements:
* description: The requirements that must be satisfied for the Shipping Option to be available for a Cart. Available if the relation `requirements` is expanded.
* description: The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.
* type: array
* x-expandable: "requirements"
* items:
* $ref: "#/components/schemas/ShippingOptionRequirement"
* data:
@@ -169,8 +173,9 @@ export class ShippingOption extends SoftDeletableEntity {
* type: object
* example: {}
* includes_tax:
* description: "[EXPERIMENTAL] Does the shipping option price include tax"
* description: "Whether the shipping option price include tax"
* type: boolean
* x-featureFlag: "tax_inclusive_pricing"
* default: false
* created_at:
* description: The date with timezone at which the resource was created.
packages/medusa/src/models/shipping-profile.ts
+6 -3
View File
@@ -55,7 +55,8 @@ export class ShippingProfile extends SoftDeletableEntity {
/**
* @schema ShippingProfile
* title: "Shipping Profile"
* description: "Shipping Profiles have a set of defined Shipping Options that can be used to fulfill a given set of Products."
* description: "A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products. For example, gift cards are shipped differently than physical products,
* so a shipping profile with the type `gift_card` groups together the shipping options that can only be used for gift cards."
* type: object
* required:
* - created_at
@@ -83,13 +84,15 @@ export class ShippingProfile extends SoftDeletableEntity {
* - custom
* example: default
* products:
* description: The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.
* description: The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.
* type: array
* x-expandable: "products"
* items:
* $ref: "#/components/schemas/Product"
* shipping_options:
* description: The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded.
* description: The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.
* type: array
* x-expandable: "shipping_options"
* items:
* $ref: "#/components/schemas/ShippingOption"
* created_at:
packages/medusa/src/models/shipping-tax-rate.ts
+7 -5
View File
@@ -40,7 +40,7 @@ export class ShippingTaxRate {
/**
* @schema ShippingTaxRate
* title: "Shipping Tax Rate"
* description: "Associates a tax rate with a shipping option to indicate that the shipping option is taxed in a certain way"
* description: "This represents the tax rates applied on a shipping option."
* type: object
* required:
* - created_at
@@ -50,19 +50,21 @@ export class ShippingTaxRate {
* - updated_at
* properties:
* shipping_option_id:
* description: The ID of the Shipping Option
* description: The ID of the shipping option.
* type: string
* example: so_01G1G5V27GYX4QXNARRQCW1N8T
* shipping_option:
* description: Available if the relation `shipping_option` is expanded.
* description: The details of the shipping option.
* x-expandable: "shipping_option"
* nullable: true
* $ref: "#/components/schemas/ShippingOption"
* rate_id:
* description: The ID of the Tax Rate
* description: The ID of the associated tax rate.
* type: string
* example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
* tax_rate:
* description: Available if the relation `tax_rate` is expanded.
* description: The details of the associated tax rate.
* x-expandable: "tax_rate"
* nullable: true
* $ref: "#/components/schemas/TaxRate"
* created_at:
packages/medusa/src/models/store.ts
+8 -5
View File
@@ -78,7 +78,7 @@ export class Store extends BaseEntity {
/**
* @schema Store
* title: "Store"
* description: "Holds settings for the Store, such as name, currencies, etc."
* description: "A store holds the main settings of the commerce shop. By default, only one store is created and used within the Medusa backend. It holds settings related to the name of the store, available currencies, and more."
* type: object
* required:
* - created_at
@@ -108,12 +108,14 @@ export class Store extends BaseEntity {
* url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
* description: See a list of codes.
* default_currency:
* description: Available if the relation `default_currency` is expanded.
* description: The details of the store's default currency.
* x-expandable: "default_currency"
* nullable: true
* $ref: "#/components/schemas/Currency"
* currencies:
* description: The currencies that are enabled for the Store. Available if the relation `currencies` is expanded.
* description: The details of the enabled currencies in the store.
* type: array
* x-expandable: "currencies"
* items:
* $ref: "#/components/schemas/Currency"
* swap_link_template:
@@ -137,12 +139,13 @@ export class Store extends BaseEntity {
* type: string
* example: null
* default_sales_channel_id:
* description: The sales channel ID the cart is associated with.
* description: The ID of the store's default sales channel.
* nullable: true
* type: string
* example: null
* default_sales_channel:
* description: A sales channel object. Available if the relation `default_sales_channel` is expanded.
* description: The details of the store's default sales channel.
* x-expandable: "default_sales_channel"
* nullable: true
* $ref: "#/components/schemas/SalesChannel"
* created_at:
packages/medusa/src/models/swap.ts
+20 -12
View File
@@ -121,7 +121,7 @@ export class Swap extends SoftDeletableEntity {
/**
* @schema Swap
* title: "Swap"
* description: "Swaps can be created when a Customer wishes to exchange Products that they have purchased to different Products. Swaps consist of a Return of previously purchased Products and a Fulfillment of new Products, the amount paid for the Products being returned will be used towards payment for the new Products. In the case where the amount paid for the the Products being returned exceed the amount to be paid for the new Products, a Refund will be issued for the difference."
* description: "A swap can be created when a Customer wishes to exchange Products that they have purchased with different Products. It consists of a Return of previously purchased Products and a Fulfillment of new Products. It also includes information on any additional payment or refund required based on the difference between the exchanged products."
* type: object
* required:
* - allow_backorder
@@ -171,33 +171,38 @@ export class Swap extends SoftDeletableEntity {
* - requires_action
* example: not_paid
* order_id:
* description: The ID of the Order where the Line Items to be returned where purchased.
* description: The ID of the order that the swap belongs to.
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order that the swap belongs to.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* additional_items:
* description: The new Line Items to ship to the Customer. Available if the relation `additional_items` is expanded.
* description: The details of the new products to send to the customer, represented as line items.
* type: array
* x-expandable: "additional_items"
* items:
* $ref: "#/components/schemas/LineItem"
* return_order:
* description: A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded.
* description: The details of the return that belongs to the swap, which holds the details on the items being returned.
* x-expandable: "return_order"
* nullable: true
* $ref: "#/components/schemas/Return"
* fulfillments:
* description: The Fulfillments used to send the new Line Items. Available if the relation `fulfillments` is expanded.
* description: The details of the fulfillments that are used to send the new items to the customer.
* x-expandable: "fulfillments"
* type: array
* items:
* $ref: "#/components/schemas/Fulfillment"
* payment:
* description: The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded.
* description: The details of the additional payment authorized by the customer when `difference_due` is positive.
* x-expandable: "payment"
* nullable: true
* $ref: "#/components/schemas/Payment"
* difference_due:
* description: The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products.
* description: The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.
* nullable: true
* type: integer
* example: 0
@@ -207,21 +212,24 @@ export class Swap extends SoftDeletableEntity {
* type: string
* example: addr_01G8ZH853YPY9B94857DY91YGW
* shipping_address:
* description: Available if the relation `shipping_address` is expanded.
* description: The details of the shipping address that the new items should be sent to.
* x-expandable: "shipping_address"
* nullable: true
* $ref: "#/components/schemas/Address"
* shipping_methods:
* description: The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded.
* description: The details of the shipping methods used to fulfill the additional items purchased.
* type: array
* x-expandable: "shipping_methods"
* items:
* $ref: "#/components/schemas/ShippingMethod"
* cart_id:
* description: The id of the Cart that the Customer will use to confirm the Swap.
* description: The ID of the cart that the customer uses to complete the swap.
* nullable: true
* type: string
* example: cart_01G8ZH853Y6TFXWPG5EYE81X63
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart that the customer uses to complete the swap.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* confirmed_at:
packages/medusa/src/models/tax-line.ts
+1 -1
View File
@@ -19,7 +19,7 @@ export class TaxLine extends BaseEntity {
/**
* @schema TaxLine
* title: "Tax Line"
* description: "Line item that specifies an amount of tax to add to a line item."
* description: "A tax line represents the taxes amount applied to a line item."
* type: object
* required:
* - code
packages/medusa/src/models/tax-provider.ts
+4 -3
View File
@@ -12,18 +12,19 @@ export class TaxProvider {
/**
* @schema TaxProvider
* title: "Tax Provider"
* description: "The tax service used to calculate taxes"
* description: "A tax provider represents a tax service installed in the Medusa backend, either through a plugin or backend customizations.
* It holds the tax service's installation status."
* type: object
* required:
* - id
* - is_installed
* properties:
* id:
* description: The id of the tax provider as given by the plugin.
* description: The ID of the tax provider as given by the tax service.
* type: string
* example: manual
* is_installed:
* description: Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`.
* description: Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.
* type: boolean
* default: true
*/
packages/medusa/src/models/tax-rate.ts
+10 -6
View File
@@ -93,7 +93,7 @@ export class TaxRate extends BaseEntity {
/**
* @schema TaxRate
* title: "Tax Rate"
* description: "A Tax Rate can be used to associate a certain rate to charge on products within a given Region"
* description: "A Tax Rate can be used to define a custom rate to charge on specified products, product types, and shipping options within a given region."
* type: object
* required:
* - code
@@ -124,26 +124,30 @@ export class TaxRate extends BaseEntity {
* type: string
* example: Tax Example
* region_id:
* description: The id of the Region that the rate belongs to
* description: The ID of the region that the rate belongs to.
* type: string
* example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
* region:
* description: A region object. Available if the relation `region` is expanded.
* description: The details of the region that the rate belongs to.
* x-expandable: "region"
* nullable: true
* $ref: "#/components/schemas/Region"
* products:
* description: The products that belong to this tax rate. Available if the relation `products` is expanded.
* description: The details of the products that belong to this tax rate.
* type: array
* x-expandable: "products"
* items:
* $ref: "#/components/schemas/Product"
* product_types:
* description: The product types that belong to this tax rate. Available if the relation `product_types` is expanded.
* description: The details of the product types that belong to this tax rate.
* type: array
* x-expandable: "product_types"
* items:
* $ref: "#/components/schemas/ProductType"
* shipping_options:
* description: The details of the shipping options that belong to this tax rate.
* type: array
* description: The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded.
* x-expandable: "shipping_options"
* items:
* $ref: "#/components/schemas/ShippingOption"
* product_count:
packages/medusa/src/models/tracking-link.ts
+4 -3
View File
@@ -35,7 +35,7 @@ export class TrackingLink extends SoftDeletableEntity {
/**
* @schema TrackingLink
* title: "Tracking Link"
* description: "Tracking Link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment."
* description: "A tracking link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment. Typically, the tracking link is provided from the third-party service integrated through the used fulfillment provider."
* type: object
* required:
* - created_at
@@ -62,11 +62,12 @@ export class TrackingLink extends SoftDeletableEntity {
* type: string
* format: RH370168054CN
* fulfillment_id:
* description: The id of the Fulfillment that the Tracking Link references.
* description: The ID of the fulfillment that the tracking link belongs to.
* type: string
* example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
* fulfillment:
* description: Available if the relation `fulfillment` is expanded.
* description: The details of the fulfillment that the tracking link belongs to.
* x-expandable: "fulfillment"
* nullable: true
* $ref: "#/components/schemas/Fulfillment"
* idempotency_key:
packages/medusa/src/models/user.ts
+1 -1
View File
@@ -48,7 +48,7 @@ export class User extends SoftDeletableEntity {
/**
* @schema User
* title: "User"
* description: "Represents a User who can manage store settings."
* description: "A User is an administrator who can manage store settings and data."
* type: object
* required:
* - api_token