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

chore(docs): Generated API Reference (#4706)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/store/components/schemas/Address.yaml
+10 -2
View File
@@ -1,5 +1,8 @@
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
@@ -72,7 +75,8 @@ properties:
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: ./Country.yaml
province:
@@ -109,3 +113,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/BatchJob.yaml
+5 -2
View File
@@ -1,5 +1,7 @@
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
@@ -47,7 +49,8 @@ properties:
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: ./User.yaml
context:
docs/api/store/components/schemas/Cart.yaml
+31 -15
View File
@@ -1,5 +1,7 @@
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
@@ -35,7 +37,8 @@ properties:
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: ./Address.yaml
shipping_address_id:
@@ -44,12 +47,14 @@ properties:
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: ./Address.yaml
items:
description: Available if the relation `items` is expanded.
description: The line items added to the cart.
type: array
x-expandable: items
items:
$ref: ./LineItem.yaml
region_id:
@@ -57,17 +62,20 @@ properties:
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: ./Region.yaml
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: ./Discount.yaml
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: ./GiftCard.yaml
customer_id:
@@ -76,16 +84,19 @@ properties:
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
type: object
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
type: object
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:
type: object
payment_id:
@@ -94,12 +105,14 @@ properties:
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
type: object
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: ./ShippingMethod.yaml
type:
@@ -144,10 +157,9 @@ properties:
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: ./SalesChannel.yaml
created_at:
description: The date with timezone at which the resource was created.
@@ -168,6 +180,10 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
shipping_total:
description: The total of shipping
type: integer
docs/api/store/components/schemas/ClaimImage.yaml
+7 -2
View File
@@ -1,5 +1,5 @@
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
@@ -18,8 +18,9 @@ properties:
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
type: object
url:
description: The URL of the image
@@ -44,3 +45,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ClaimItem.yaml
+20 -9
View File
@@ -1,7 +1,7 @@
title: Claim Item
description: >-
Represents a claimed item along with information about the reasons for the
claim.
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
@@ -21,15 +21,17 @@ properties:
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: ./ClaimImage.yaml
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
type: object
item_id:
@@ -37,7 +39,10 @@ properties:
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: ./LineItem.yaml
variant_id:
@@ -45,7 +50,10 @@ properties:
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: ./ProductVariant.yaml
reason:
@@ -68,10 +76,9 @@ properties:
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: ./ClaimTag.yaml
created_at:
@@ -93,3 +100,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ClaimOrder.yaml
+24 -11
View File
@@ -1,8 +1,8 @@
title: Claim Order
title: Claim
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.
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
@@ -53,15 +53,17 @@ properties:
- 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: ./ClaimItem.yaml
additional_items:
description: >-
Refers to the new items to be shipped when the claim order has the type
The details of the new items to be shipped when the claim's type is
`replace`
type: array
x-expandable: additional_items
items:
$ref: ./LineItem.yaml
order_id:
@@ -69,13 +71,15 @@ properties:
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
type: object
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
The details of the return associated with the claim if the claim's type is
`replace`.
x-expandable: return_order
nullable: true
type: object
shipping_address_id:
@@ -84,17 +88,22 @@ properties:
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: ./Address.yaml
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: ./ShippingMethod.yaml
fulfillments:
description: The fulfillments of the new items to be shipped
type: array
x-expandable: fulfillments
items:
type: object
refund_amount:
@@ -126,6 +135,10 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
no_notification:
description: >-
Flag for describing whether or not notifications related to this should be
docs/api/store/components/schemas/ClaimTag.yaml
+4
View File
@@ -38,3 +38,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/Country.yaml
+2 -1
View File
@@ -52,6 +52,7 @@ properties:
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
type: object
docs/api/store/components/schemas/Currency.yaml
+2 -1
View File
@@ -27,6 +27,7 @@ properties:
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
docs/api/store/components/schemas/CustomShippingOption.yaml
+11 -7
View File
@@ -1,8 +1,8 @@
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
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
@@ -29,9 +29,8 @@ properties:
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: ./ShippingOption.yaml
cart_id:
@@ -40,7 +39,8 @@ properties:
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: ./Cart.yaml
created_at:
@@ -62,3 +62,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/Customer.yaml
+13 -7
View File
@@ -1,5 +1,5 @@
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
@@ -38,12 +38,14 @@ properties:
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: ./Address.yaml
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: ./Address.yaml
phone:
@@ -56,15 +58,15 @@ properties:
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:
type: object
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: ./CustomerGroup.yaml
created_at:
@@ -86,3 +88,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/CustomerGroup.yaml
+11 -7
View File
@@ -1,5 +1,7 @@
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
@@ -18,17 +20,15 @@ properties:
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:
type: object
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:
type: object
created_at:
@@ -50,3 +50,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/Discount.yaml
+16 -7
View File
@@ -1,5 +1,5 @@
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
@@ -35,12 +35,17 @@ properties:
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: ./DiscountRule.yaml
is_disabled:
@@ -57,7 +62,8 @@ properties:
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
type: object
starts_at:
@@ -75,10 +81,9 @@ properties:
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: ./Region.yaml
usage_limit:
@@ -110,3 +115,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/DiscountCondition.yaml
+27 -17
View File
@@ -16,7 +16,11 @@ properties:
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
@@ -25,7 +29,10 @@ properties:
- 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
@@ -35,43 +42,42 @@ properties:
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: ./DiscountRule.yaml
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: ./Product.yaml
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: ./ProductType.yaml
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: ./ProductTag.yaml
product_collections:
description: >-
Product collections associated with this condition if type =
product_collections. Available if the relation `product_collections` is
expanded.
Product collections associated with this condition if `type` is
`product_collections`.
type: array
x-expandable: product_collections
items:
$ref: ./ProductCollection.yaml
customer_groups:
description: >-
Customer groups associated with this condition if type = customer_groups.
Available if the relation `customer_groups` is expanded.
Customer groups associated with this condition if `type` is
`customer_groups`.
type: array
x-expandable: customer_groups
items:
$ref: ./CustomerGroup.yaml
created_at:
@@ -93,3 +99,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/DiscountConditionCustomerGroup.yaml
+4
View File
@@ -38,3 +38,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/DiscountConditionProduct.yaml
+9 -3
View File
@@ -1,5 +1,5 @@
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
@@ -17,11 +17,13 @@ properties:
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: ./Product.yaml
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: ./DiscountCondition.yaml
created_at:
@@ -38,3 +40,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/DiscountConditionProductCollection.yaml
+11 -3
View File
@@ -1,5 +1,7 @@
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
@@ -17,11 +19,13 @@ properties:
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: ./ProductCollection.yaml
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: ./DiscountCondition.yaml
created_at:
@@ -38,3 +42,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/DiscountConditionProductTag.yaml
+9 -3
View File
@@ -1,5 +1,5 @@
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
@@ -17,11 +17,13 @@ properties:
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: ./ProductTag.yaml
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: ./DiscountCondition.yaml
created_at:
@@ -38,3 +40,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/DiscountConditionProductType.yaml
+11 -3
View File
@@ -1,5 +1,7 @@
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
@@ -17,11 +19,13 @@ properties:
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: ./ProductType.yaml
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: ./DiscountCondition.yaml
created_at:
@@ -38,3 +42,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/DiscountRule.yaml
+8 -5
View File
@@ -1,7 +1,5 @@
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
@@ -50,9 +48,10 @@ properties:
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.
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:
type: object
created_at:
@@ -74,3 +73,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/DraftOrder.yaml
+20 -5
View File
@@ -1,5 +1,8 @@
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
@@ -20,7 +23,9 @@ properties:
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
@@ -36,16 +41,22 @@ properties:
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
type: object
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
type: object
canceled_at:
@@ -86,3 +97,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/Fulfillment.yaml
+29 -21
View File
@@ -1,12 +1,10 @@
title: Fulfillment
description: >-
Fulfillments are created once store operators can prepare the purchased goods.
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 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.
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
@@ -30,61 +28,67 @@ properties:
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
type: object
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
type: object
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
type: object
provider_id:
description: >-
The id of the Fulfillment Provider responsible for handling the
fulfillment
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: ./FulfillmentProvider.yaml
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.
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: ./FulfillmentItem.yaml
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.
Fulfillment. These will usually be provided by the Fulfillment Provider.
type: array
x-expandable: tracking_links
items:
$ref: ./TrackingLink.yaml
tracking_numbers:
@@ -141,3 +145,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/FulfillmentItem.yaml
+7 -7
View File
@@ -1,7 +1,5 @@
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
@@ -9,19 +7,21 @@ required:
- 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
type: object
item:
description: Available if the relation `item` is expanded.
description: The details of the line item.
x-expandable: item
nullable: true
$ref: ./LineItem.yaml
quantity:
docs/api/store/components/schemas/FulfillmentProvider.yaml
+8 -5
View File
@@ -1,18 +1,21 @@
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`.
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
docs/api/store/components/schemas/GiftCard.yaml
+10 -4
View File
@@ -37,20 +37,22 @@ properties:
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: ./Region.yaml
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
type: object
is_disabled:
@@ -88,3 +90,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/GiftCardTransaction.yaml
+6 -4
View File
@@ -1,7 +1,7 @@
title: Gift Card Transaction
description: >-
Gift Card Transactions are created once a Customer uses a Gift Card to pay for
their Order
their Order.
type: object
required:
- amount
@@ -21,15 +21,17 @@ properties:
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
type: object
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
type: object
amount:
docs/api/store/components/schemas/Image.yaml
+7 -1
View File
@@ -1,5 +1,7 @@
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
@@ -36,3 +38,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/Invite.yaml
+8 -2
View File
@@ -1,5 +1,7 @@
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
@@ -22,7 +24,7 @@ properties:
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:
@@ -60,3 +62,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/LineItem.yaml
+37 -24
View File
@@ -1,9 +1,9 @@
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.
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
@@ -36,67 +36,76 @@ properties:
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
type: object
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
type: object
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
type: object
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
type: object
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: ./LineItemTaxLine.yaml
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: ./LineItemAdjustment.yaml
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
type: object
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:
@@ -148,9 +157,8 @@ properties:
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: ./ProductVariant.yaml
quantity:
@@ -211,7 +219,8 @@ properties:
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:
@@ -228,3 +237,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/LineItemAdjustment.yaml
+9 -3
View File
@@ -1,5 +1,5 @@
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
@@ -18,7 +18,8 @@ properties:
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
type: object
description:
@@ -31,7 +32,8 @@ properties:
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: ./Discount.yaml
amount:
@@ -44,3 +46,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/LineItemTaxLine.yaml
+7 -2
View File
@@ -1,5 +1,5 @@
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
@@ -33,7 +33,8 @@ properties:
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
type: object
created_at:
@@ -50,3 +51,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/MoneyAmount.yaml
+17 -14
View File
@@ -1,10 +1,11 @@
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.
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
@@ -24,14 +25,15 @@ properties:
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: ./Currency.yaml
amount:
@@ -55,23 +57,23 @@ properties:
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
type: object
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
type: object
region_id:
@@ -80,7 +82,8 @@ properties:
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
type: object
created_at:
docs/api/store/components/schemas/Note.yaml
+6 -4
View File
@@ -1,7 +1,8 @@
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.
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
@@ -31,12 +32,13 @@ properties:
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: ./User.yaml
created_at:
docs/api/store/components/schemas/Notification.yaml
+15 -13
View File
@@ -1,9 +1,8 @@
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.
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
@@ -36,18 +35,20 @@ properties:
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: ./Customer.yaml
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
email address, but can represent other addresses such as a chat bot user
ID.
type: string
example: user@example.com
data:
@@ -62,23 +63,24 @@ properties:
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
type: object
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:
type: object
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: ./NotificationProvider.yaml
created_at:
docs/api/store/components/schemas/NotificationProvider.yaml
+8 -5
View File
@@ -1,18 +1,21 @@
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`.
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
docs/api/store/components/schemas/OAuth.yaml
+3 -1
View File
@@ -1,5 +1,7 @@
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
docs/api/store/components/schemas/Order.yaml
+54 -52
View File
@@ -1,5 +1,8 @@
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
@@ -75,7 +78,8 @@ properties:
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
type: object
customer_id:
@@ -83,7 +87,8 @@ properties:
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
type: object
email:
@@ -96,7 +101,8 @@ properties:
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: ./Address.yaml
shipping_address_id:
@@ -105,15 +111,17 @@ properties:
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: ./Address.yaml
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: ./Region.yaml
currency_code:
@@ -124,7 +132,8 @@ properties:
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: ./Currency.yaml
tax_rate:
@@ -133,96 +142,85 @@ properties:
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: ./Discount.yaml
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: ./GiftCard.yaml
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: ./ShippingMethod.yaml
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:
type: object
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:
type: object
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:
type: object
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:
type: object
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:
type: object
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:
type: object
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
type: object
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: ./LineItem.yaml
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:
type: object
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: ./GiftCardTransaction.yaml
canceled_at:
@@ -252,14 +250,13 @@ properties:
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: ./SalesChannel.yaml
shipping_total:
@@ -308,9 +305,10 @@ properties:
example: 0
returnable_items:
description: >-
The items that are returnable as part of the order, order swaps or order
claims
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: ./LineItem.yaml
created_at:
@@ -327,3 +325,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/OrderEdit.yaml
+17 -5
View File
@@ -1,5 +1,8 @@
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
@@ -29,11 +32,13 @@ properties:
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
type: object
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: ./OrderItemChange.yaml
@@ -135,8 +140,12 @@ properties:
- 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: ./LineItem.yaml
payment_collection_id:
@@ -145,7 +154,10 @@ properties:
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: ./PaymentCollection.yaml
created_at:
docs/api/store/components/schemas/OrderItemChange.yaml
+14 -4
View File
@@ -1,5 +1,8 @@
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
@@ -27,7 +30,8 @@ properties:
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
type: object
original_line_item_id:
@@ -36,7 +40,10 @@ properties:
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: ./LineItem.yaml
line_item_id:
@@ -45,7 +52,10 @@ properties:
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: ./LineItem.yaml
created_at:
docs/api/store/components/schemas/Payment.yaml
+24 -10
View File
@@ -1,7 +1,9 @@
title: Payment
description: >-
Payments represent an amount authorized with a given payment method, Payments
can be captured, canceled or refunded.
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
@@ -25,29 +27,36 @@ properties:
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
type: object
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
type: object
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
type: object
amount:
@@ -55,14 +64,15 @@ properties:
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: ./Currency.yaml
amount_refunded:
@@ -117,3 +127,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/PaymentCollection.yaml
+22 -7
View File
@@ -1,5 +1,8 @@
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
@@ -46,32 +49,40 @@ properties:
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: ./Region.yaml
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: ./Currency.yaml
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: ./PaymentSession.yaml
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: ./Payment.yaml
created_by:
@@ -96,3 +107,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/PaymentProvider.yaml
+8 -5
View File
@@ -1,18 +1,21 @@
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`.
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
docs/api/store/components/schemas/PaymentSession.yaml
+9 -7
View File
@@ -1,11 +1,12 @@
title: Payment Session
description: >-
Payment Sessions are created when a Customer initilizes the checkout flow, and
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, who is responsible for the communication
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
capture/refunds/etc.
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
@@ -26,16 +27,17 @@ properties:
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: ./Cart.yaml
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:
docs/api/store/components/schemas/PriceList.yaml
+7 -8
View File
@@ -1,6 +1,6 @@
title: Price List
description: >-
Price Lists represents a set of prices that overrides the default price for
A Price List represents a set of prices that override the default price for
one or more product variants.
type: object
required:
@@ -52,22 +52,21 @@ properties:
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: ./CustomerGroup.yaml
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: ./MoneyAmount.yaml
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.
docs/api/store/components/schemas/Product.yaml
+45 -29
View File
@@ -1,8 +1,10 @@
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.
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
@@ -70,8 +72,9 @@ properties:
- 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: ./Image.yaml
thumbnail:
@@ -81,38 +84,49 @@ properties:
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.
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: ./ProductOption.yaml
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.
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: ./ProductVariant.yaml
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: ./ProductCategory.yaml
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.
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: ./ShippingProfile.yaml
profiles:
description: Available if the relation `profiles` is expanded.
nullable: true
type: array
items:
$ref: ./ShippingProfile.yaml
weight:
description: >-
The weight of the Product Variant. May be used in shipping rate
@@ -172,30 +186,29 @@ properties:
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: ./ProductCollection.yaml
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: ./ProductType.yaml
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: ./ProductTag.yaml
discountable:
@@ -210,10 +223,9 @@ properties:
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: ./SalesChannel.yaml
created_at:
@@ -235,3 +247,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ProductCategory.yaml
+11 -9
View File
@@ -1,6 +1,9 @@
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
@@ -48,8 +51,9 @@ properties:
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:
type: object
parent_category_id:
@@ -58,16 +62,14 @@ properties:
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
type: object
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:
type: object
created_at:
docs/api/store/components/schemas/ProductCollection.yaml
+10 -4
View File
@@ -1,5 +1,8 @@
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
@@ -26,10 +29,9 @@ properties:
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:
type: object
created_at:
@@ -51,3 +53,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ProductOption.yaml
+12 -8
View File
@@ -1,8 +1,8 @@
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.
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
@@ -22,18 +22,18 @@ properties:
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: ./ProductOptionValue.yaml
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
type: object
created_at:
@@ -55,3 +55,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ProductOptionValue.yaml
+16 -10
View File
@@ -1,7 +1,7 @@
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.
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
@@ -20,26 +20,28 @@ properties:
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`).
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
type: object
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
type: object
created_at:
@@ -61,3 +63,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ProductTag.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
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
@@ -36,3 +36,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ProductTaxRate.yaml
+10 -4
View File
@@ -1,7 +1,7 @@
title: Product Tax Rate
description: >-
Associates a tax rate with a product to indicate that the product is taxed in
a certain way
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
@@ -15,7 +15,8 @@ properties:
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: ./Product.yaml
rate_id:
@@ -23,7 +24,8 @@ properties:
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: ./TaxRate.yaml
created_at:
@@ -40,3 +42,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ProductType.yaml
+5 -1
View File
@@ -1,5 +1,5 @@
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
@@ -36,3 +36,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ProductTypeTaxRate.yaml
+10 -4
View File
@@ -1,7 +1,7 @@
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
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
@@ -15,7 +15,8 @@ properties:
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: ./ProductType.yaml
rate_id:
@@ -23,7 +24,8 @@ properties:
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: ./TaxRate.yaml
created_at:
@@ -40,3 +42,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ProductVariant.yaml
+19 -12
View File
@@ -1,8 +1,9 @@
title: Product Variant
description: >-
Product Variants represent a Product with a specific set of Product Option
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.
is given by the number of available Product Option combinations. A product
must at least have one product variant.
type: object
required:
- allow_backorder
@@ -39,19 +40,21 @@ properties:
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
type: object
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.
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: ./MoneyAmount.yaml
sku:
@@ -158,16 +161,16 @@ properties:
example: null
options:
description: >-
The Product Option Values specified for the Product Variant. Available if
the relation `options` is expanded.
The details of the product options that this product variant defines
values for.
type: array
x-expandable: options
items:
$ref: ./ProductOptionValue.yaml
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: ./ProductVariantInventoryItem.yaml
created_at:
@@ -189,6 +192,10 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
purchasable:
description: |
Only used with the inventory modules.
docs/api/store/components/schemas/ProductVariantInventoryItem.yaml
+5 -6
View File
@@ -1,7 +1,7 @@
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.
A Product Variant Inventory Item links variants with inventory items and
denotes the required quantity of the variant.
type: object
required:
- created_at
@@ -23,13 +23,12 @@ properties:
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
type: object
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:
docs/api/store/components/schemas/PublishableApiKey.yaml
+7 -2
View File
@@ -1,7 +1,12 @@
title: Publishable API key
description: >-
Publishable API key defines scopes (i.e. resources) that are available within
a request.
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
docs/api/store/components/schemas/PublishableApiKeySalesChannel.yaml
+4 -2
View File
@@ -1,5 +1,7 @@
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
docs/api/store/components/schemas/Refund.yaml
+12 -6
View File
@@ -1,8 +1,8 @@
title: Refund
description: >-
Refund represent an amount of money transfered back to the Customer for a
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 a store operator.
can also be initiated by an admin for an order.
type: object
required:
- amount
@@ -21,21 +21,23 @@ properties:
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
type: object
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
type: object
amount:
@@ -82,3 +84,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/Region.yaml
+24 -15
View File
@@ -1,7 +1,7 @@
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
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
@@ -30,14 +30,15 @@ properties:
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: ./Currency.yaml
tax_rate:
@@ -46,9 +47,10 @@ properties:
example: 0
tax_rates:
description: >-
The tax rates that are included in the Region. Available if the relation
`tax_rates` is expanded.
The details of the tax rates used in the region, aside from the default
rate.
type: array
x-expandable: tax_rates
items:
$ref: ./TaxRate.yaml
tax_code:
@@ -67,10 +69,9 @@ properties:
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: ./Country.yaml
tax_provider_id:
@@ -79,26 +80,30 @@ properties:
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: ./TaxProvider.yaml
payment_providers:
description: >-
The Payment Providers that can be used to process Payments in the Region.
Available if the relation `payment_providers` is expanded.
The details of the payment providers that can be used to process payments
in the region.
type: array
x-expandable: payment_providers
items:
$ref: ./PaymentProvider.yaml
fulfillment_providers:
description: >-
The Fulfillment Providers that can be used to fulfill orders in the
Region. Available if the relation `fulfillment_providers` is expanded.
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: ./FulfillmentProvider.yaml
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.
@@ -119,3 +124,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/Return.yaml
+23 -16
View File
@@ -1,8 +1,8 @@
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.
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
@@ -34,44 +34,47 @@ properties:
- 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: ./ReturnItem.yaml
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
type: object
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
type: object
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
type: object
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.
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: ./ShippingMethod.yaml
shipping_data:
@@ -82,7 +85,7 @@ properties:
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
@@ -123,3 +126,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ReturnItem.yaml
+15 -8
View File
@@ -1,7 +1,7 @@
title: Return Item
description: >-
Correlates a Line Item with a Return, keeping track of the quantity of the
Line Item that will be returned.
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
@@ -15,23 +15,25 @@ required:
- 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
type: object
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: ./LineItem.yaml
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:
@@ -56,7 +58,8 @@ properties:
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: ./ReturnReason.yaml
note:
@@ -70,3 +73,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ReturnReason.yaml
+10 -4
View File
@@ -1,7 +1,7 @@
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.
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
@@ -37,11 +37,13 @@ properties:
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
type: object
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
type: object
created_at:
description: The date with timezone at which the resource was created.
@@ -62,3 +64,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/SalesChannel.yaml
+16 -4
View File
@@ -1,5 +1,8 @@
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
@@ -28,10 +31,9 @@ properties:
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: ./SalesChannelLocation.yaml
created_at:
@@ -47,3 +49,13 @@ properties:
nullable: true
type: string
format: date-time
metadata:
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/SalesChannelLocation.yaml
+5 -6
View File
@@ -1,5 +1,5 @@
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
@@ -14,16 +14,15 @@ properties:
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
type: object
created_at:
docs/api/store/components/schemas/ShippingMethod.yaml
+27 -18
View File
@@ -1,9 +1,10 @@
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.
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
@@ -21,61 +22,68 @@ properties:
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
type: object
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
type: object
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
type: object
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
type: object
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
type: object
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: ./ShippingOption.yaml
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: ./ShippingMethodTaxLine.yaml
price:
@@ -93,8 +101,9 @@ properties:
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
docs/api/store/components/schemas/ShippingMethodTaxLine.yaml
+9 -2
View File
@@ -1,5 +1,7 @@
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
@@ -33,7 +35,8 @@ properties:
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
type: object
created_at:
@@ -50,3 +53,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ShippingOption.yaml
+24 -15
View File
@@ -1,6 +1,6 @@
title: Shipping Option
description: >-
Shipping Options represent a way in which an Order or Return can be shipped.
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
@@ -34,32 +34,36 @@ properties:
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
type: object
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: ./ShippingProfile.yaml
provider_id:
description: >-
The id of the Fulfillment Provider, that will be used to process
Fulfillments from the Shipping Option.
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: ./FulfillmentProvider.yaml
price_type:
@@ -91,10 +95,10 @@ properties:
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.
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: ./ShippingOptionRequirement.yaml
data:
@@ -104,8 +108,9 @@ properties:
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.
@@ -126,3 +131,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ShippingOptionRequirement.yaml
+5 -6
View File
@@ -1,7 +1,7 @@
title: Shipping Option Requirement
description: >-
A requirement that a Cart must satisfy for the Shipping Option to be available
to the Cart.
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
@@ -15,13 +15,12 @@ properties:
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
type: object
type:
docs/api/store/components/schemas/ShippingProfile.yaml
+15 -7
View File
@@ -1,7 +1,10 @@
title: Shipping Profile
description: >-
Shipping Profiles have a set of defined Shipping Options that can be used to
fulfill a given set of Products.
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
@@ -34,17 +37,18 @@ properties:
example: default
products:
description: >-
The Products that the Shipping Profile defines Shipping Options for.
Available if the relation `products` is expanded.
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:
type: object
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.
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:
type: object
created_at:
@@ -66,3 +70,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/ShippingTaxRate.yaml
+11 -7
View File
@@ -1,7 +1,5 @@
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
@@ -11,19 +9,21 @@ required:
- 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: ./ShippingOption.yaml
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: ./TaxRate.yaml
created_at:
@@ -40,3 +40,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/Store.yaml
+15 -9
View File
@@ -1,5 +1,8 @@
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
@@ -29,14 +32,14 @@ properties:
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: ./Currency.yaml
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: ./Currency.yaml
swap_link_template:
@@ -64,14 +67,13 @@ properties:
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: ./SalesChannel.yaml
created_at:
@@ -88,3 +90,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/StoreAuthRes.yaml
+1
View File
@@ -9,4 +9,5 @@ required:
- customer
properties:
customer:
description: Customer's details.
$ref: ./Customer.yaml
docs/api/store/components/schemas/StoreCartShippingOptionsListRes.yaml
+1
View File
@@ -9,5 +9,6 @@ required:
properties:
shipping_options:
type: array
description: An array of shipping options details.
items:
$ref: ./PricedShippingOption.yaml
docs/api/store/components/schemas/StoreCartsRes.yaml
+2
View File
@@ -24,6 +24,7 @@ x-expanded-relations:
- items
- items.variant
- items.variant.product
- items.variant.product.profiles
- items.tax_lines
- items.adjustments
- gift_cards
@@ -58,4 +59,5 @@ required:
- cart
properties:
cart:
description: Cart details.
$ref: ./Cart.yaml
docs/api/store/components/schemas/StoreCollectionsListRes.yaml
+4 -1
View File
@@ -7,6 +7,7 @@ required:
properties:
collections:
type: array
description: An array of product collections details
items:
$ref: ./ProductCollection.yaml
count:
@@ -14,7 +15,9 @@ properties:
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
description: >-
The number of product collections skipped when retrieving the product
collections.
limit:
type: integer
description: The number of items per page
docs/api/store/components/schemas/StoreCollectionsRes.yaml
+1
View File
@@ -3,4 +3,5 @@ required:
- collection
properties:
collection:
description: Product collection details.
$ref: ./ProductCollection.yaml
docs/api/store/components/schemas/StoreCompleteCartRes.yaml
+8 -4
View File
@@ -5,7 +5,13 @@ required:
properties:
type:
type: string
description: The type of the data property.
description: >-
The type of the data property. If the cart completion fails, type will be
`cart` and the data object will be the cart's details. If the cart
completion is successful and the cart is used for checkout, type will be
`order` and the data object will be the order's details. If the cart
completion is successful and the cart is used for swap creation, type will
be `swap` and the data object will be the swap's details.
enum:
- order
- cart
@@ -26,7 +32,5 @@ properties:
- $ref: ./Cart.yaml
- type: object
allOf:
- description: >-
When cart is used for a swap and it has been completed
successfully.
- description: Cart was used for a swap and it has been completed successfully.
- $ref: ./Swap.yaml
docs/api/store/components/schemas/StoreCustomersListOrdersRes.yaml
+3 -1
View File
@@ -35,6 +35,7 @@ x-expanded-relations:
- items.tax_lines
- items.variant
- items.variant.product
- items.variant.product.profiles
- refunds
- region
- shipping_address
@@ -88,13 +89,14 @@ required:
properties:
orders:
type: array
description: An array of orders details.
items:
$ref: ./Order.yaml
count:
description: The total number of items available
type: integer
offset:
description: The number of items skipped before these items
description: The number of orders skipped when retrieving the orders.
type: integer
limit:
description: The number of items per page
docs/api/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml
+2 -1
View File
@@ -4,6 +4,7 @@ required:
properties:
payment_methods:
type: array
description: An array of saved payment method details.
items:
type: object
required:
@@ -11,7 +12,7 @@ properties:
- data
properties:
provider_id:
description: The id of the Payment Provider where the payment method is saved.
description: The ID of the Payment Provider where the payment method is saved.
type: string
data:
description: >-
docs/api/store/components/schemas/StoreCustomersRes.yaml
+1
View File
@@ -8,4 +8,5 @@ required:
- customer
properties:
customer:
description: Customer details.
$ref: ./Customer.yaml
docs/api/store/components/schemas/StoreCustomersResetPasswordRes.yaml
+1
View File
@@ -3,4 +3,5 @@ required:
- customer
properties:
customer:
description: Customer details.
$ref: ./Customer.yaml
docs/api/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml
+1
View File
@@ -8,4 +8,5 @@ required:
- product_category
properties:
product_category:
description: Product category details.
$ref: ./ProductCategory.yaml
docs/api/store/components/schemas/StoreGetProductCategoriesRes.yaml
+4 -1
View File
@@ -12,6 +12,7 @@ required:
properties:
product_categories:
type: array
description: An array of product categories details.
items:
$ref: ./ProductCategory.yaml
count:
@@ -19,7 +20,9 @@ properties:
description: The total number of items available
offset:
type: integer
description: The number of items skipped before these items
description: >-
The number of product categories skipped when retrieving the product
categories.
limit:
type: integer
description: The number of items per page
docs/api/store/components/schemas/StoreGiftCardsRes.yaml
+1
View File
@@ -3,4 +3,5 @@ required:
- gift_card
properties:
gift_card:
description: Gift card details.
$ref: ./GiftCard.yaml
docs/api/store/components/schemas/StoreOrderEditsRes.yaml
+1
View File
@@ -38,4 +38,5 @@ required:
- order_edit
properties:
order_edit:
description: Order edit details.
$ref: ./OrderEdit.yaml
docs/api/store/components/schemas/StoreOrdersRes.yaml
+2
View File
@@ -37,6 +37,7 @@ x-expanded-relations:
- items.tax_lines
- items.variant
- items.variant.product
- items.variant.product.profiles
- refunds
- region
- shipping_methods
@@ -83,4 +84,5 @@ x-expanded-relations:
- swaps.additional_items.total
properties:
order:
description: Order details.
$ref: ./Order.yaml
docs/api/store/components/schemas/StorePaymentCollectionsRes.yaml
+1
View File
@@ -11,4 +11,5 @@ required:
- payment_collection
properties:
payment_collection:
description: Payment collection's details.
$ref: ./PaymentCollection.yaml
docs/api/store/components/schemas/StorePaymentCollectionsSessionRes.yaml
+1
View File
@@ -3,4 +3,5 @@ required:
- payment_session
properties:
payment_session:
description: Payment session's details.
$ref: ./PaymentSession.yaml
docs/api/store/components/schemas/StorePostCartReq.yaml
+25 -9
View File
@@ -2,21 +2,37 @@ type: object
properties:
region_id:
type: string
description: The ID of the Region to create the Cart in.
description: >-
The ID of the Region to create the Cart in. Setting the cart's region can
affect the pricing of the items in the cart as well as the used currency.
If this parameter is not provided, the first region in the store is used
by default.
sales_channel_id:
type: string
description: '[EXPERIMENTAL] The ID of the Sales channel to create the Cart in.'
description: >-
The ID of the Sales channel to create the Cart in. The cart's sales
channel affects which products can be added to the cart. If a product does
not exist in the cart's sales channel, it cannot be added to the cart. If
you add a publishable API key in the header of this request and specify a
sales channel ID, the specified sales channel must be within the scope of
the publishable API key's resources. If you add a publishable API key in
the header of this request, you don't specify a sales channel ID, and the
publishable API key is associated with one sales channel, that sales
channel will be attached to the cart. If no sales channel is passed and no
publishable API key header is passed or the publishable API key isn't
associated with any sales channel, the cart will not be associated with
any sales channel.
country_code:
type: string
description: The 2 character ISO country code to create the Cart in.
description: >-
The 2 character ISO country code to create the Cart in. Setting this
parameter will set the country code of the shipping address.
externalDocs:
url: >-
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
description: See a list of codes.
items:
description: >-
An optional array of `variant_id`, `quantity` pairs to generate Line Items
from.
description: An array of product variants to generate line items from.
type: array
items:
type: object
@@ -25,14 +41,14 @@ properties:
- quantity
properties:
variant_id:
description: The id of the Product Variant to generate a Line Item from.
description: The ID of the Product Variant.
type: string
quantity:
description: The quantity of the Product Variant to add
description: The quantity to add into the cart.
type: integer
context:
description: >-
An optional object to provide context to the Cart. The `context` field is
An object to provide context to the Cart. The `context` field is
automatically populated with `ip` and `user_agent`
type: object
example:
docs/api/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml
+5 -1
View File
@@ -4,9 +4,13 @@ required:
properties:
quantity:
type: number
description: The quantity to set the Line Item to.
description: The quantity of the line item in the cart.
metadata:
type: object
description: >-
An optional key-value map with additional details about the Line Item. If
omitted, the metadata will remain unchanged."
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/StorePostCartsCartLineItemsReq.yaml
+4
View File
@@ -12,3 +12,7 @@ properties:
metadata:
type: object
description: An optional key-value map with additional details about the Line Item.
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/StorePostCartsCartReq.yaml
+19 -7
View File
@@ -2,10 +2,14 @@ type: object
properties:
region_id:
type: string
description: The id of the Region to create the Cart in.
description: >-
The ID of the Region to create the Cart in. Setting the cart's region can
affect the pricing of the items in the cart as well as the used currency.
country_code:
type: string
description: The 2 character ISO country code to create the Cart in.
description: >-
The 2 character ISO country code to create the Cart in. Setting this
parameter will set the country code of the shipping address.
externalDocs:
url: >-
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
@@ -16,7 +20,13 @@ properties:
format: email
sales_channel_id:
type: string
description: The ID of the Sales channel to update the Cart with.
description: >-
The ID of the Sales channel to create the Cart in. The cart's sales
channel affects which products can be added to the cart. If a product does
not exist in the cart's sales channel, it cannot be added to the cart. If
you add a publishable API key in the header of this request and specify a
sales channel ID, the specified sales channel must be within the scope of
the publishable API key's resources.
billing_address:
description: The Address to be used for billing purposes.
anyOf:
@@ -25,7 +35,7 @@ properties:
- type: string
description: The billing address ID
shipping_address:
description: The Address to be used for shipping.
description: The Address to be used for shipping purposes.
anyOf:
- $ref: ./AddressPayload.yaml
description: A full shipping address object.
@@ -40,7 +50,7 @@ properties:
- code
properties:
code:
description: The code that a Gift Card is identified by.
description: The code of a gift card.
type: string
discounts:
description: An array of Discount codes to add to the Cart.
@@ -51,13 +61,15 @@ properties:
- code
properties:
code:
description: The code that a Discount is identified by.
description: The code of the discount.
type: string
customer_id:
description: The ID of the Customer to associate the Cart with.
type: string
context:
description: An optional object to provide context to the Cart.
description: >-
An object to provide context to the Cart. The `context` field is
automatically populated with `ip` and `user_agent`
type: object
example:
ip: '::1'
docs/api/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml
+3 -3
View File
@@ -4,10 +4,10 @@ required:
properties:
option_id:
type: string
description: ID of the shipping option to create the method from
description: ID of the shipping option to create the method from.
data:
type: object
description: >-
Used to hold any data that the shipping method may need to process the
fulfillment of the order. Look at the documentation for your installed
fulfillment providers to find out what to send.
fulfillment of the order. This depends on the fulfillment provider you're
using.
docs/api/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml
+1 -1
View File
@@ -3,5 +3,5 @@ required:
- token
properties:
token:
description: The invite token provided by the admin.
description: The claim token generated by previous request to the Claim Order endpoint.
type: string
docs/api/store/components/schemas/StorePostCustomersCustomerAddressesReq.yaml
+1 -1
View File
@@ -3,5 +3,5 @@ required:
- address
properties:
address:
description: The Address to add to the Customer.
description: The Address to add to the Customer's saved addresses.
$ref: ./AddressCreatePayload.yaml
docs/api/store/components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml
+1 -1
View File
@@ -3,7 +3,7 @@ required:
- order_ids
properties:
order_ids:
description: The ids of the orders to claim
description: The ID of the orders to claim
type: array
items:
type: string
docs/api/store/components/schemas/StorePostCustomersCustomerPasswordTokenReq.yaml
+1 -1
View File
@@ -3,6 +3,6 @@ required:
- email
properties:
email:
description: The email of the customer.
description: The customer's email.
type: string
format: email
docs/api/store/components/schemas/StorePostCustomersCustomerReq.yaml
+11 -7
View File
@@ -1,27 +1,31 @@
type: object
properties:
first_name:
description: The Customer's first name.
description: The customer's first name.
type: string
last_name:
description: The Customer's last name.
description: The customer's last name.
type: string
billing_address:
description: The Address to be used for billing purposes.
description: The address to be used for billing purposes.
anyOf:
- $ref: ./AddressPayload.yaml
description: The full billing address object
- type: string
description: The ID of an existing billing address
password:
description: The Customer's password.
description: The customer's password.
type: string
phone:
description: The Customer's phone number.
description: The customer's phone number.
type: string
email:
description: The email of the customer.
description: The customer's email.
type: string
metadata:
description: Metadata about the customer.
description: Additional custom data about the customer.
type: object
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
docs/api/store/components/schemas/StorePostCustomersReq.yaml
+5 -5
View File
@@ -6,19 +6,19 @@ required:
- password
properties:
first_name:
description: The Customer's first name.
description: The customer's first name.
type: string
last_name:
description: The Customer's last name.
description: The customer's last name.
type: string
email:
description: The email of the customer.
description: The customer's email.
type: string
format: email
password:
description: The Customer's password.
description: The customer's password.
type: string
format: password
phone:
description: The Customer's phone number.
description: The customer's phone number.
type: string
docs/api/store/components/schemas/StorePostCustomersResetPasswordReq.yaml
+2 -2
View File
@@ -5,11 +5,11 @@ required:
- token
properties:
email:
description: The email of the customer.
description: The customer's email.
type: string
format: email
password:
description: The Customer's password.
description: The customer's password.
type: string
format: password
token:

Some files were not shown because too many files have changed in this diff Show More