Defines values for BatchJobStatus.

Defines values for BatchJobStatus.

Defines values for BatchJobStatus.

Defines values for BatchJobStatus.

Defines values for BatchJobStatus.

Defines values for BatchJobStatus.

Defines values for BatchJobStatus.

Defines values for CartType.

Defines values for CartType.

Defines values for CartType.

Defines values for CartType.

Defines values for CartType.

Defines values for ClaimStatus.

Defines values for ClaimStatus.

Defines values for DiscountConditionType.

Defines values for DiscountConditionType.

Defines values for DiscountConditionType.

Defines values for DiscountConditionType.

Defines values for DiscountConditionType.

Defines values for DiscountConditionType.

Defines values for DiscountConditionType.

Defines values for DraftOrderStatus.

Defines values for DraftOrderStatus.

Defines values for PriceListStatus.

Defines values for PriceListStatus.

Enum values for ReturnStatus.

Enum values for ReturnStatus.

Enum values for ReturnStatus.

Enum values for ReturnStatus.

Defines values for ShippingOptionPriceType.

Defines values for ShippingOptionPriceType.

Defines values for ShippingOptionRequirementType.

Defines values for ShippingOptionRequirementType.

Defines values for ShippingProfileType.

Defines values for ShippingProfileType.

Defines values for ShippingProfileType.

Defines values for UserRole.

Defines values for UserRole.

Defines values for UserRole.

@oas:schema:Address title: "Address" description: "An address is used across the Medusa backend within other schemas and object types.

BatchJobResult - The result of the batch job.

@oas:schema:Cart title: "Cart" description: "A cart represents a virtual shopping bag.

@oas:schema:ClaimItem title: "Claim Item" description: "A claim item is an item created as part of a claim.

@oas:schema:ClaimOrder title: "Claim" description: "A Claim represents a group of faulty or missing items.

@oas:schema:ClaimTag title: "Claim Tag" description: "Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping." type: object required: - created_at - deleted_at - id - metadata - updated_at - value properties: id: description: The claim tag's ID type: string example: ctag_01G8ZCC5Y63B95V6B5SHBZ91S4 value: description: The value that the claim tag holds type: string example: Damaged created_at: description: The date with timezone at which the resource was created.

@oas:schema:CustomShippingOption title: "Custom Shipping Option" description: "Custom Shipping Options are overridden Shipping Options.

@oas:schema:Discount title: "Discount" description: "A discount can be applied to a cart for promotional purposes." type: object required: - code - created_at - deleted_at - ends_at - id - is_disabled - is_dynamic - metadata - parent_discount_id - rule_id - starts_at - updated_at - usage_count - usage_limit - valid_duration properties: id: description: The discount's ID type: string example: disc_01F0YESMW10MGHWJKZSDDMN0VN code: description: A unique code for the discount - this will be used by the customer to apply the discount type: string example: 10DISC is_dynamic: description: A flag to indicate if multiple instances of the discount can be generated.

@oas:schema:DiscountCondition title: "Discount Condition" description: "Holds rule conditions for when a discount is applicable" type: object required: - created_at - deleted_at - discount_rule_id - id - metadata - operator - type - updated_at properties: id: description: The discount condition's ID type: string example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A type: description: "The type of the condition.

@oas:schema:DiscountConditionCustomerGroup title: "Product Tag Discount Condition" description: "Associates a discount condition with a customer group" type: object required: - condition_id - created_at - customer_group_id - metadata - updated_at properties: customer_group_id: description: The ID of the Product Tag type: string example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63 condition_id: description: The ID of the Discount Condition type: string example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A customer_group: description: Available if the relation `customer_group` is expanded.

@oas:schema:DiscountConditionProduct title: "Product Discount Condition" description: "This represents the association between a discount condition and a product" type: object required: - condition_id - created_at - metadata - product_id - updated_at properties: product_id: description: The ID of the Product Tag type: string example: prod_01G1G5V2MBA328390B5AXJ610F condition_id: description: The ID of the Discount Condition type: string example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A product: description: The details of the product.

@oas:schema:DiscountConditionProductCollection title: "Product Collection Discount Condition" description: "This represents the association between a discount condition and a product collection" type: object required: - condition_id - created_at - metadata - product_collection_id - updated_at properties: product_collection_id: description: The ID of the Product Collection type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG condition_id: description: The ID of the Discount Condition type: string example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A product_collection: description: The details of the product collection.

@oas:schema:DiscountConditionProductTag title: "Product Tag Discount Condition" description: "This represents the association between a discount condition and a product tag" type: object required: - condition_id - created_at - metadata - product_tag_id - updated_at properties: product_tag_id: description: The ID of the Product Tag type: string example: ptag_01F0YESHPZYY3H4SJ3A5918SBN condition_id: description: The ID of the Discount Condition type: string example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A product_tag: description: The details of the product tag.

@oas:schema:DiscountConditionProductType title: "Product Type Discount Condition" description: "This represents the association between a discount condition and a product type" type: object required: - condition_id - created_at - metadata - product_type_id - updated_at properties: product_type_id: description: The ID of the Product Tag type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A condition_id: description: The ID of the Discount Condition type: string example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A product_type: description: The details of the product type.

@oas:schema:DiscountRule title: "Discount Rule" description: "A discount rule defines how a Discount is calculated when applied to a Cart." type: object required: - allocation - created_at - deleted_at - description - id - metadata - type - updated_at - value properties: id: description: The discount rule's ID type: string example: dru_01F0YESMVK96HVX7N419E3CJ7C type: description: >- The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.

@oas:schema:DraftOrder title: "DraftOrder" description: "A draft order is created by an admin without direct involvement of the customer.

@oas:schema:Fulfillment title: "Fulfillment" description: "A Fulfillment is created once an admin can prepare the purchased goods.

@oas:schema:FulfillmentItem title: "Fulfillment Item" description: "This represents the association between a Line Item and a Fulfillment." type: object required: - fulfillment_id - item_id - quantity properties: fulfillment_id: description: The ID of the Fulfillment that the Fulfillment Item belongs to.

@oas:schema:FulfillmentProvider title: "Fulfillment Provider" description: "A fulfillment provider represents a fulfillment service installed in the Medusa backend, either through a plugin or backend customizations.

@oas:schema:GiftCard title: "Gift Card" description: "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order." type: object required: - balance - code - created_at - deleted_at - ends_at - id - is_disabled - metadata - order_id - region_id - tax_rate - updated_at - value properties: id: description: The gift card's ID type: string example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ code: description: The unique code that identifies the Gift Card.

@oas:schema:GiftCardTransaction title: "Gift Card Transaction" description: "Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order." type: object required: - amount - created_at - gift_card_id - id - is_taxable - order_id - tax_rate properties: id: description: The gift card transaction's ID type: string example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A gift_card_id: description: The ID of the Gift Card that was used in the transaction.

@oas:schema:IdempotencyKey title: "Idempotency Key" description: "Idempotency Key is used to continue a process in case of any failure that might occur." type: object required: - created_at - id - idempotency_key - locked_at - recovery_point - response_code - response_body - request_method - request_params - request_path properties: id: description: The idempotency key's ID type: string example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A idempotency_key: description: The unique randomly generated key used to determine the state of a process.

@oas:schema:Image title: "Image" description: "An Image is used to store details about uploaded images.

@oas:schema:Invite title: "Invite" description: "An invite is created when an admin user invites a new user to join the store's team.

@oas:schema:LineItem title: "Line Item" description: "Line Items are created when a product is added to a Cart.

@oas:schema:LineItemAdjustment title: "Line Item Adjustment" description: "A Line Item Adjustment includes details on discounts applied on a line item." type: object required: - amount - description - discount_id - id - item_id - metadata properties: id: description: The Line Item Adjustment's ID type: string example: lia_01G8TKE4XYCTHSCK2GDEP47RE1 item_id: description: The ID of the line item type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN item: description: The details of the line item.

@oas:schema:LineItemTaxLine title: "Line Item Tax Line" description: "A Line Item Tax Line represents the taxes applied on a line item." type: object required: - code - created_at - id - item_id - metadata - name - rate - updated_at properties: id: description: The line item tax line's ID type: string example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by nullable: true type: string example: tax01 name: description: A human friendly name for the tax type: string example: Tax Example rate: description: The numeric rate to charge tax by type: number example: 10 item_id: description: The ID of the line item type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN item: description: The details of the line item.

@oas:schema:MoneyAmount title: "Money Amount" description: "A Money Amount represent a price amount, for example, a product variant's price or a price in a price list.

@oas:schema:Note title: "Note" description: "A Note is an element that can be used in association with different resources to allow admin users to describe additional information.

@oas:schema:Notification title: "Notification" description: "A notification is an alert sent, typically to customers, using the installed Notification Provider as a reaction to internal events such as `order.placed`.

@oas:schema:NotificationProvider title: "Notification Provider" description: "A notification provider represents a notification service installed in the Medusa backend, either through a plugin or backend customizations.

@oas:schema:Order title: "Order" description: "An order is a purchase made by a customer.

@oas:schema:OrderEdit title: "Order Edit" description: "Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order.

@oas:schema:OrderItemChange title: "Order Item Change" description: "An order item change is a change made within an order edit to an order's items.

@oas:schema:Payment title: "Payment" description: "A payment is originally created from a payment session.

@oas:schema:PaymentCollection title: "Payment Collection" description: "A payment collection allows grouping and managing a list of payments at one.

@oas:schema:PaymentProvider title: "Payment Provider" description: "A payment provider represents a payment service installed in the Medusa backend, either through a plugin or backend customizations.

@oas:schema:PaymentSession title: "Payment Session" description: "A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow.

@oas:schema:PriceList title: "Price List" description: "A Price List represents a set of prices that override the default price for one or more product variants." type: object required: - created_at - deleted_at - description - ends_at - id - name - starts_at - status - type - updated_at properties: id: description: The price list's ID type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W name: description: The price list's name type: string example: VIP Prices description: description: The price list's description type: string example: Prices for VIP customers type: description: The type of Price List.

@oas:schema:ProductCategory 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 - created_at - handle - id - is_active - is_internal - metadata - mpath - name - parent_category_id - updated_at properties: id: description: The product category's ID type: string example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 name: description: The product category's name type: string example: Regular Fit description: description: The product category's description.

@oas:schema:ProductCollection title: "Product Collection" description: "A Product Collection allows grouping together products for promotional purposes.

@oas:schema:ProductOption title: "Product Option" description: A Product Option defines properties that may vary between different variants of a Product.

@oas:schema:ProductOptionValue title: "Product Option Value" description: "An option value is one of the possible values of a Product Option.

@oas:schema:ProductTag title: "Product Tag" description: "A Product Tag can be added to Products for easy filtering and grouping." type: object required: - created_at - deleted_at - id - metadata - updated_at - value properties: id: description: The product tag's ID type: string example: ptag_01G8K2MTMG9168F2B70S1TAVK3 value: description: The value that the Product Tag represents type: string example: Pants created_at: description: The date with timezone at which the resource was created.

@oas:schema:ProductTaxRate title: "Product Tax Rate" description: "This represents the association between a tax rate and a product to indicate that the product is taxed in a way different than the default." type: object required: - created_at - metadata - product_id - rate_id - updated_at properties: product_id: description: The ID of the Product type: string example: prod_01G1G5V2MBA328390B5AXJ610F product: description: The details of the product.

@oas:schema:ProductType title: "Product Type" description: "A Product Type can be added to Products for filtering and reporting purposes." type: object required: - created_at - deleted_at - id - metadata - updated_at - value properties: id: description: The product type's ID type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A value: description: The value that the Product Type represents.

@oas:schema:ProductTypeTaxRate title: "Product Type Tax Rate" description: "This represents the association between a tax rate and a product type to indicate that the product type is taxed in a different way than the default." type: object required: - created_at - metadata - product_type_id - rate_id - updated_at properties: product_type_id: description: The ID of the Product type type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A product_type: description: The details of the product type.

@oas:schema:ProductVariant title: "Product Variant" description: "A Product Variant represents a Product with a specific set of Product Option configurations.

@oas:schema:ProductVariantInventoryItem title: "Product Variant Inventory Item" description: "A Product Variant Inventory Item links variants with inventory items and denotes the required quantity of the variant." type: object required: - created_at - deleted_at - id - inventory_item_id - required_quantity - updated_at - variant_id properties: id: description: The product variant inventory item's ID type: string example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A inventory_item_id: description: The id of the inventory item type: string variant_id: description: The id of the variant.

@oas:schema:PublishableApiKey title: "Publishable API key" description: "A Publishable API key defines scopes that resources are available in.

@oas:schema:PublishableApiKeySalesChannel 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 - sales_channel_id - created_at - updated_at - deleted_at properties: id: description: The relation's ID type: string example: pksc_01G8X9A7ESKAJXG2H0E6F1MW7A sales_channel_id: description: The sales channel's ID type: string example: sc_01G1G5V21KADXNGH29BJMAJ4B4 publishable_key_id: description: The publishable API key's ID type: string example: pak_01G1G5V21KADXNGH29BJMAJ4B4 created_at: description: The date with timezone at which the resource was created.

@oas:schema:Refund title: "Refund" description: "A refund represents an amount of money transfered back to the customer for a given reason.

@oas:schema:Region title: "Region" description: "A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers.

@oas:schema:Return title: "Return" description: "A Return holds information about Line Items that a Customer wishes to send back, along with how the items will be returned.

@oas:schema:ReturnItem title: "Return Item" description: "A return item represents a line item in an order that is to be returned.

@oas:schema:ReturnReason title: "Return Reason" description: "A Return Reason is a value defined by an admin.

@oas:schema:SalesChannelLocation title: "Sales Channel Stock Location" description: "This represents the association between a sales channel and a stock locations." type: object required: - created_at - deleted_at - id - location_id - sales_channel_id - updated_at properties: id: description: The Sales Channel Stock Location's ID type: string example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A sales_channel_id: description: "The ID of the Sales Channel" type: string example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A location_id: description: "The ID of the Location Stock." type: string sales_channel: description: The details of the sales channel the location is associated with.

@oas:schema:ShippingMethod title: "Shipping Method" description: "A Shipping Method represents a way in which an Order or Return can be shipped.

@oas:schema:ShippingOption title: "Shipping Option" description: "A Shipping Option represents a way in which an Order or Return can be shipped.

@oas:schema:ShippingOptionRequirement title: "Shipping Option Requirement" description: "A shipping option requirement defines conditions that a Cart must satisfy for the Shipping Option to be available for usage in the Cart." type: object required: - amount - deleted_at - id - shipping_option_id - type properties: id: description: The shipping option requirement's ID type: string example: sor_01G1G5V29AB4CTNDRFSRWSRKWD shipping_option_id: description: The ID of the shipping option that the requirements belong to.

@oas:schema:ShippingProfile title: "Shipping Profile" description: "A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products.

@oas:schema:ShippingTaxRate title: "Shipping Tax Rate" description: "This represents the tax rates applied on a shipping option." type: object required: - created_at - metadata - rate_id - shipping_option_id - updated_at properties: shipping_option_id: description: The ID of the shipping option.

@oas:schema:StagedJob title: "Staged Job" description: "A staged job resource" type: object required: - data - event_name - id - options properties: id: description: The staged job's ID type: string example: job_01F0YET7BZTARY9MKN1SJ7AAXF event_name: description: The name of the event type: string example: order.placed data: description: Data necessary for the job type: object example: {} option: description: The staged job's option type: object example: {}.

@oas:schema:Store title: "Store" description: "A store holds the main settings of the commerce shop.

@oas:schema:Swap title: "Swap" description: "A swap can be created when a Customer wishes to exchange Products that they have purchased with different Products.

@oas:schema:TaxLine title: "Tax Line" description: "A tax line represents the taxes amount applied to a line item." type: object required: - code - created_at - id - metadata - name - rate - updated_at properties: id: description: The tax line's ID type: string example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by nullable: true type: string example: tax01 name: description: A human friendly name for the tax type: string example: Tax Example rate: description: The numeric rate to charge tax by type: number example: 10 created_at: description: The date with timezone at which the resource was created.

@oas:schema:TaxProvider title: "Tax Provider" description: "A tax provider represents a tax service installed in the Medusa backend, either through a plugin or backend customizations.

@oas:schema:TaxRate title: "Tax Rate" description: "A Tax Rate can be used to define a custom rate to charge on specified products, product types, and shipping options within a given region." type: object required: - code - created_at - id - metadata - name - rate - region_id - updated_at properties: id: description: The tax rate's ID type: string example: txr_01G8XDBAWKBHHJRKH0AV02KXBR rate: description: The numeric rate to charge nullable: true type: number example: 10 code: description: A code to identify the tax type by nullable: true type: string example: tax01 name: description: A human friendly name for the tax type: string example: Tax Example region_id: description: The ID of the region that the rate belongs to.

@oas:schema:TrackingLink title: "Tracking Link" description: "A tracking link holds information about tracking numbers for a Fulfillment.

@oas:schema:User title: "User" description: "A User is an administrator who can manage store settings and data." type: object required: - api_token - created_at - deleted_at - email - first_name - id - last_name - metadata - role - updated_at properties: id: description: The user's ID type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V role: description: The user's role.

The status of the Price List.

The status of the Price List.

The status of the Price List.

The status of the Price List.

The status of the Price List.

The status of the Price List.

The type of Price List.

The status of the product.

The status of the product.

ReturnStatus represents the status of a return.

The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option.

The type of the requirement, this defines how the value will be compared to the Cart's total.

The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.