docs: fix broken links in OAS (#14000)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-11-07 10:48:37 +02:00
1 parent 5a96bb7da4
commit 6cd40c9f74
169 files changed
+291 -300

No files matched your search

@@ -60,8 +60,7 @@ properties:
type: array type: array
description: The claim's transactions. description: The claim's transactions.
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
description: Learn more about transactions of orders and associated models. description: Learn more about transactions of orders and associated models.
items: items:
$ref: ./BaseOrderTransaction.yaml $ref: ./BaseOrderTransaction.yaml
@@ -28,7 +28,7 @@ properties:
handling its processing. handling its processing.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
price_type: price_type:
type: string type: string
description: >- description: >-
@@ -42,7 +42,7 @@ properties:
description: Any data useful for the fulfillment provider to handle the fulfillment. description: Any data useful for the fulfillment provider to handle the fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
description: Learn more about the data property. description: Learn more about the data property.
packed_at: packed_at:
type: string type: string
@@ -39,7 +39,7 @@ properties:
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The tax rate's metadata, used to store custom key-value pairs. description: The tax rate's metadata, used to store custom key-value pairs.
@@ -47,7 +47,7 @@ properties:
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The default tax rate's metadata, used to store custom key-value pairs. description: The default tax rate's metadata, used to store custom key-value pairs.
@@ -353,7 +353,7 @@ properties:
shipment. shipment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -59,8 +59,7 @@ properties:
type: array type: array
description: The exchange's transactions. description: The exchange's transactions.
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
items: items:
$ref: ./BaseOrderTransaction.yaml $ref: ./BaseOrderTransaction.yaml
metadata: metadata:
@@ -73,7 +73,7 @@ properties:
fulfillment. fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The fulfillment's metadata, can hold custom key-value pairs. description: The fulfillment's metadata, can hold custom key-value pairs.
@@ -51,7 +51,7 @@ properties:
the associated shipping option. the associated shipping option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -355,7 +355,7 @@ properties:
shipment. shipment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -56,7 +56,7 @@ properties:
fulfillment. fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -32,7 +32,7 @@ properties:
description: The payment's data, useful for processing by the payment provider. description: The payment's data, useful for processing by the payment provider.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
created_at: created_at:
type: string type: string
format: date-time format: date-time
@@ -26,7 +26,7 @@ properties:
payment. payment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
context: context:
type: object type: object
description: The context around the payment, such as the customer's details. description: The context around the payment, such as the customer's details.
@@ -84,7 +84,7 @@ properties:
fulfillments created from this option. fulfillments created from this option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping option's metadata, can hold custom key-value pairs. description: The shipping option's metadata, can hold custom key-value pairs.
@@ -50,7 +50,7 @@ properties:
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
is_default: is_default:
type: boolean type: boolean
title: is_default title: is_default
@@ -29,7 +29,7 @@ properties:
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The tax rate's metadata, can hold custom key-value pairs. description: The tax rate's metadata, can hold custom key-value pairs.
@@ -51,7 +51,7 @@ properties:
the associated shipping option. the associated shipping option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -56,7 +56,7 @@ properties:
fulfillment. fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -32,7 +32,7 @@ properties:
description: The payment's data, useful for processing by the payment provider. description: The payment's data, useful for processing by the payment provider.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
created_at: created_at:
type: string type: string
format: date-time format: date-time
@@ -56,8 +56,7 @@ properties:
type: array type: array
description: The claim's transactions. description: The claim's transactions.
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
description: Learn more about transactions of orders and associated models. description: Learn more about transactions of orders and associated models.
items: items:
$ref: ./OrderTransaction.yaml $ref: ./OrderTransaction.yaml
@@ -52,8 +52,7 @@ properties:
type: array type: array
description: The exchange's transactions. description: The exchange's transactions.
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
items: items:
$ref: ./OrderTransaction.yaml $ref: ./OrderTransaction.yaml
metadata: metadata:
@@ -53,7 +53,7 @@ properties:
the fulfillment. the fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -45,7 +45,7 @@ properties:
services. services.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/cart/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -94,7 +94,7 @@ properties:
description: The shipping option's data, useful for the provider handling fulfillment. description: The shipping option's data, useful for the provider handling fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
prices: prices:
type: array type: array
description: The shipping option's prices. description: The shipping option's prices.
@@ -13,6 +13,6 @@ properties:
description: Any data necessary for the payment provider to process the payment. description: Any data necessary for the payment provider to process the payment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
description: Learn more about the payment session's data property description: Learn more about the payment session's data property
x-schemaName: StoreInitializePaymentSession x-schemaName: StoreInitializePaymentSession
@@ -51,7 +51,7 @@ properties:
the associated shipping option. the associated shipping option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -56,7 +56,7 @@ properties:
fulfillment. fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -26,7 +26,7 @@ properties:
payment. payment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
context: context:
type: object type: object
description: The context around the payment, such as the customer's details. description: The context around the payment, such as the customer's details.
@@ -102,7 +102,7 @@ properties:
is always considered in stock. is always considered in stock.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/inventory https://docs.medusajs.com/resources/storefront-development/products/inventory
description: 'Storefront guide: How to retrieve a product variant''s inventory details.' description: 'Storefront guide: How to retrieve a product variant''s inventory details.'
inventory_quantity: inventory_quantity:
type: number type: number
@@ -112,7 +112,7 @@ properties:
pass `+variants.inventory_quantity` in the `fields` query parameter. pass `+variants.inventory_quantity` in the `fields` query parameter.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/inventory https://docs.medusajs.com/resources/storefront-development/products/inventory
description: 'Storefront guide: How to retrieve a product variant''s inventory details.' description: 'Storefront guide: How to retrieve a product variant''s inventory details.'
variant_rank: variant_rank:
type: number type: number
@@ -66,7 +66,7 @@ properties:
description: The shipping option's data, useful for the provider handling fulfillment. description: The shipping option's data, useful for the provider handling fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping option's metadata, can hold custom key-value pairs. description: The shipping option's metadata, can hold custom key-value pairs.
@@ -15063,7 +15063,7 @@ paths:
type: object type: object
description: The shipping method's data, useful for fulfillment providers. description: The shipping method's data, useful for fulfillment providers.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
amount: amount:
oneOf: oneOf:
- type: string - type: string
@@ -39685,7 +39685,7 @@ paths:
type: string type: string
description: The promotion's type. description: The promotion's type.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion url: https://docs.medusajs.com/resources/commerce-modules/promotion/concepts#what-is-a-promotion
enum: enum:
- standard - standard
- buyget - buyget
@@ -40429,7 +40429,7 @@ paths:
type: string type: string
description: The promotion's type. description: The promotion's type.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion url: https://docs.medusajs.com/resources/commerce-modules/promotion/concepts#what-is-a-promotion
enum: enum:
- standard - standard
- buyget - buyget
@@ -59033,7 +59033,7 @@ paths:
summary: Refresh Authentication Token summary: Refresh Authentication Token
description: Refresh the authentication token of a user. This is useful after authenticating a user with a third-party service to ensure the token holds the new user's details, or when you don't want users to re-login every day. description: Refresh the authentication token of a user. This is useful after authenticating a user with a third-party service to ensure the token holds the new user's details, or when you don't want users to re-login every day.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow url: https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow
description: Learn about third-party authentication flow. description: Learn about third-party authentication flow.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -59089,7 +59089,7 @@ paths:
When used with a third-party provider, such as Google, the request returns a `location` property. You redirect to the specified URL in your frontend to continue authentication with the third-party service. When used with a third-party provider, such as Google, the request returns a `location` property. You redirect to the specified URL in your frontend to continue authentication with the third-party service.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#types-of-authentication-flows url: https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#types-of-authentication-flows
description: Learn about different authentication flows. description: Learn about different authentication flows.
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -59178,7 +59178,7 @@ paths:
You can decode the JWT token using libraries like [react-jwt](https://www.npmjs.com/package/react-jwt) in the frontend. If the decoded data doesn't have an `actor_id` property, then you must create a user, typically using the Accept Invite route passing the token in the request's Authorization header. You can decode the JWT token using libraries like [react-jwt](https://www.npmjs.com/package/react-jwt) in the frontend. If the decoded data doesn't have an `actor_id` property, then you must create a user, typically using the Accept Invite route passing the token in the request's Authorization header.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow url: https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow
description: Learn about third-party authentication flow. description: Learn about third-party authentication flow.
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -59285,7 +59285,7 @@ paths:
summary: Retrieve Registration JWT Token summary: Retrieve Registration JWT Token
description: This API route retrieves a registration JWT token of a user that hasn't been registered yet. The token is used in the header of requests that create a user, such as the Accept Invite API route. description: This API route retrieves a registration JWT token of a user that hasn't been registered yet. The token is used in the header of requests that create a user, such as the Accept Invite API route.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#1-basic-authentication-flow url: https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#1-basic-authentication-flow
description: Learn about the basic authentication flow. description: Learn about the basic authentication flow.
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -59377,7 +59377,7 @@ paths:
Use the generated token to update the user's password using the [Reset Password API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerupdate). Use the generated token to update the user's password using the [Reset Password API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerupdate).
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#generate-reset-password-token-route url: https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#generate-reset-password-token-route
description: Learn more about this API route. description: Learn more about this API route.
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -59467,7 +59467,7 @@ paths:
x-sidebar-summary: Reset Password x-sidebar-summary: Reset Password
description: Reset an admin user's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header. description: Reset an admin user's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#reset-password-route url: https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#reset-password-route
description: Learn more about this API route. description: Learn more about this API route.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -60888,7 +60888,7 @@ components:
type: array type: array
description: The claim's transactions. description: The claim's transactions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
description: Learn more about transactions of orders and associated models. description: Learn more about transactions of orders and associated models.
items: items:
$ref: '#/components/schemas/BaseOrderTransaction' $ref: '#/components/schemas/BaseOrderTransaction'
@@ -61539,7 +61539,7 @@ components:
type: object type: object
description: The flat-rate shipping option's data, useful for the fulfillment provider handling its processing. description: The flat-rate shipping option's data, useful for the fulfillment provider handling its processing.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
price_type: price_type:
type: string type: string
description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider. description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider.
@@ -61702,7 +61702,7 @@ components:
type: object type: object
description: Any data useful for the fulfillment provider to handle the fulfillment. description: Any data useful for the fulfillment provider to handle the fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
description: Learn more about the data property. description: Learn more about the data property.
packed_at: packed_at:
type: string type: string
@@ -62992,7 +62992,7 @@ components:
title: is_combinable title: is_combinable
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The tax rate's metadata, used to store custom key-value pairs. description: The tax rate's metadata, used to store custom key-value pairs.
@@ -63066,7 +63066,7 @@ components:
type: boolean type: boolean
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The default tax rate's metadata, used to store custom key-value pairs. description: The default tax rate's metadata, used to store custom key-value pairs.
@@ -64812,7 +64812,7 @@ components:
type: object type: object
description: The data relevant for the fulfillment provider to process this shipment. description: The data relevant for the fulfillment provider to process this shipment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -65201,7 +65201,7 @@ components:
type: array type: array
description: The exchange's transactions. description: The exchange's transactions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
items: items:
$ref: '#/components/schemas/BaseOrderTransaction' $ref: '#/components/schemas/BaseOrderTransaction'
metadata: metadata:
@@ -65514,7 +65514,7 @@ components:
type: object type: object
description: The fulfillment's data, useful for the third-party provider handling the fulfillment. description: The fulfillment's data, useful for the third-party provider handling the fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The fulfillment's metadata, can hold custom key-value pairs. description: The fulfillment's metadata, can hold custom key-value pairs.
@@ -67347,7 +67347,7 @@ components:
type: object type: object
description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -67986,7 +67986,7 @@ components:
type: object type: object
description: The data relevant for the fulfillment provider to process this shipment. description: The data relevant for the fulfillment provider to process this shipment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -68384,7 +68384,7 @@ components:
type: object type: object
description: The shipping method's data, useful for fulfillment provider handling its fulfillment. description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -68479,7 +68479,7 @@ components:
type: object type: object
description: The payment's data, useful for processing by the payment provider. description: The payment's data, useful for processing by the payment provider.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment url: https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
created_at: created_at:
type: string type: string
format: date-time format: date-time
@@ -68662,7 +68662,7 @@ components:
type: object type: object
description: The payment session's data, useful for the payment provider processing the payment. description: The payment session's data, useful for the payment provider processing the payment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
context: context:
type: object type: object
description: The context around the payment, such as the customer's details. description: The context around the payment, such as the customer's details.
@@ -71628,7 +71628,7 @@ components:
type: object type: object
description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option. description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping option's metadata, can hold custom key-value pairs. description: The shipping option's metadata, can hold custom key-value pairs.
@@ -72556,7 +72556,7 @@ components:
title: is_combinable title: is_combinable
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
is_default: is_default:
type: boolean type: boolean
title: is_default title: is_default
@@ -74395,7 +74395,7 @@ components:
title: is_combinable title: is_combinable
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The tax rate's metadata, can hold custom key-value pairs. description: The tax rate's metadata, can hold custom key-value pairs.
@@ -76449,7 +76449,7 @@ components:
type: object type: object
description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -76995,7 +76995,7 @@ components:
type: object type: object
description: The shipping method's data, useful for fulfillment provider handling its fulfillment. description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -77310,7 +77310,7 @@ components:
type: object type: object
description: The payment's data, useful for processing by the payment provider. description: The payment's data, useful for processing by the payment provider.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment url: https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
created_at: created_at:
type: string type: string
format: date-time format: date-time
@@ -79763,7 +79763,7 @@ components:
type: array type: array
description: The claim's transactions. description: The claim's transactions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
description: Learn more about transactions of orders and associated models. description: Learn more about transactions of orders and associated models.
items: items:
$ref: '#/components/schemas/OrderTransaction' $ref: '#/components/schemas/OrderTransaction'
@@ -79928,7 +79928,7 @@ components:
type: array type: array
description: The exchange's transactions. description: The exchange's transactions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
items: items:
$ref: '#/components/schemas/OrderTransaction' $ref: '#/components/schemas/OrderTransaction'
metadata: metadata:
@@ -80502,7 +80502,7 @@ components:
type: object type: object
description: The shipping method's data, useful for the fulfillment provider handling the fulfillment. description: The shipping method's data, useful for the fulfillment provider handling the fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -81757,7 +81757,7 @@ components:
type: object type: object
description: The shipping method's data, useful for fulfillment handling by third-party services. description: The shipping method's data, useful for fulfillment handling by third-party services.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/cart/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -82047,7 +82047,7 @@ components:
type: object type: object
description: The shipping option's data, useful for the provider handling fulfillment. description: The shipping option's data, useful for the provider handling fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
prices: prices:
type: array type: array
description: The shipping option's prices. description: The shipping option's prices.
@@ -82774,7 +82774,7 @@ components:
type: object type: object
description: Any data necessary for the payment provider to process the payment. description: Any data necessary for the payment provider to process the payment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
description: Learn more about the payment session's data property description: Learn more about the payment session's data property
x-schemaName: StoreInitializePaymentSession x-schemaName: StoreInitializePaymentSession
StoreOrder: StoreOrder:
@@ -83163,7 +83163,7 @@ components:
type: object type: object
description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -87337,7 +87337,7 @@ components:
type: object type: object
description: The shipping method's data, useful for fulfillment provider handling its fulfillment. description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -89137,7 +89137,7 @@ components:
type: object type: object
description: The payment session's data, useful for the payment provider processing the payment. description: The payment session's data, useful for the payment provider processing the payment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
context: context:
type: object type: object
description: The context around the payment, such as the customer's details. description: The context around the payment, such as the customer's details.
@@ -89923,14 +89923,14 @@ components:
title: manage_inventory title: manage_inventory
description: Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock. description: Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory url: https://docs.medusajs.com/resources/storefront-development/products/inventory
description: 'Storefront guide: How to retrieve a product variant''s inventory details.' description: 'Storefront guide: How to retrieve a product variant''s inventory details.'
inventory_quantity: inventory_quantity:
type: number type: number
title: inventory_quantity title: inventory_quantity
description: The variant's inventory quantity. This property is only available if you pass `+variants.inventory_quantity` in the `fields` query parameter. description: The variant's inventory quantity. This property is only available if you pass `+variants.inventory_quantity` in the `fields` query parameter.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory url: https://docs.medusajs.com/resources/storefront-development/products/inventory
description: 'Storefront guide: How to retrieve a product variant''s inventory details.' description: 'Storefront guide: How to retrieve a product variant''s inventory details.'
variant_rank: variant_rank:
type: number type: number
@@ -90314,7 +90314,7 @@ components:
type: object type: object
description: The shipping option's data, useful for the provider handling fulfillment. description: The shipping option's data, useful for the provider handling fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping option's metadata, can hold custom key-value pairs. description: The shipping option's metadata, can hold custom key-value pairs.
@@ -2095,7 +2095,7 @@ post:
providers. providers.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
amount: amount:
oneOf: oneOf:
- type: string - type: string
@@ -879,7 +879,7 @@ post:
description: The promotion's type. description: The promotion's type.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion https://docs.medusajs.com/resources/commerce-modules/promotion/concepts#what-is-a-promotion
enum: enum:
- standard - standard
- buyget - buyget
@@ -121,7 +121,7 @@ post:
description: The promotion's type. description: The promotion's type.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion https://docs.medusajs.com/resources/commerce-modules/promotion/concepts#what-is-a-promotion
enum: enum:
- standard - standard
- buyget - buyget
@@ -7,7 +7,7 @@ post:
the new user's details, or when you don't want users to re-login every day. the new user's details, or when you don't want users to re-login every day.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow
description: Learn about third-party authentication flow. description: Learn about third-party authentication flow.
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -11,7 +11,7 @@ post:
continue authentication with the third-party service. continue authentication with the third-party service.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#types-of-authentication-flows https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#types-of-authentication-flows
description: Learn about different authentication flows. description: Learn about different authentication flows.
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -17,7 +17,7 @@ post:
request's Authorization header. request's Authorization header.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow
description: Learn about third-party authentication flow. description: Learn about third-party authentication flow.
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -7,7 +7,7 @@ post:
user, such as the Accept Invite API route. user, such as the Accept Invite API route.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#1-basic-authentication-flow https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#1-basic-authentication-flow
description: Learn about the basic authentication flow. description: Learn about the basic authentication flow.
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -22,7 +22,7 @@ post:
Use the generated token to update the user's password using the [Reset Password API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerupdate). Use the generated token to update the user's password using the [Reset Password API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerupdate).
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#generate-reset-password-token-route https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#generate-reset-password-token-route
description: Learn more about this API route. description: Learn more about this API route.
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -9,7 +9,7 @@ post:
You pass the token as a bearer token in the request's Authorization header. You pass the token as a bearer token in the request's Authorization header.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#reset-password-route https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route#reset-password-route
description: Learn more about this API route. description: Learn more about this API route.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -60,8 +60,7 @@ properties:
type: array type: array
description: The claim's transactions. description: The claim's transactions.
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
description: Learn more about transactions of orders and associated models. description: Learn more about transactions of orders and associated models.
items: items:
$ref: ./BaseOrderTransaction.yaml $ref: ./BaseOrderTransaction.yaml
@@ -28,7 +28,7 @@ properties:
handling its processing. handling its processing.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
price_type: price_type:
type: string type: string
description: >- description: >-
@@ -42,7 +42,7 @@ properties:
description: Any data useful for the fulfillment provider to handle the fulfillment. description: Any data useful for the fulfillment provider to handle the fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
description: Learn more about the data property. description: Learn more about the data property.
packed_at: packed_at:
type: string type: string
@@ -39,7 +39,7 @@ properties:
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The tax rate's metadata, used to store custom key-value pairs. description: The tax rate's metadata, used to store custom key-value pairs.
@@ -47,7 +47,7 @@ properties:
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The default tax rate's metadata, used to store custom key-value pairs. description: The default tax rate's metadata, used to store custom key-value pairs.
@@ -353,7 +353,7 @@ properties:
shipment. shipment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -59,8 +59,7 @@ properties:
type: array type: array
description: The exchange's transactions. description: The exchange's transactions.
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
items: items:
$ref: ./BaseOrderTransaction.yaml $ref: ./BaseOrderTransaction.yaml
metadata: metadata:
@@ -73,7 +73,7 @@ properties:
fulfillment. fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The fulfillment's metadata, can hold custom key-value pairs. description: The fulfillment's metadata, can hold custom key-value pairs.
@@ -51,7 +51,7 @@ properties:
the associated shipping option. the associated shipping option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -355,7 +355,7 @@ properties:
shipment. shipment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -56,7 +56,7 @@ properties:
fulfillment. fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -32,7 +32,7 @@ properties:
description: The payment's data, useful for processing by the payment provider. description: The payment's data, useful for processing by the payment provider.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
created_at: created_at:
type: string type: string
format: date-time format: date-time
@@ -26,7 +26,7 @@ properties:
payment. payment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
context: context:
type: object type: object
description: The context around the payment, such as the customer's details. description: The context around the payment, such as the customer's details.
@@ -84,7 +84,7 @@ properties:
fulfillments created from this option. fulfillments created from this option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping option's metadata, can hold custom key-value pairs. description: The shipping option's metadata, can hold custom key-value pairs.
@@ -50,7 +50,7 @@ properties:
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
is_default: is_default:
type: boolean type: boolean
title: is_default title: is_default
@@ -29,7 +29,7 @@ properties:
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The tax rate's metadata, can hold custom key-value pairs. description: The tax rate's metadata, can hold custom key-value pairs.
@@ -51,7 +51,7 @@ properties:
the associated shipping option. the associated shipping option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -56,7 +56,7 @@ properties:
fulfillment. fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -32,7 +32,7 @@ properties:
description: The payment's data, useful for processing by the payment provider. description: The payment's data, useful for processing by the payment provider.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
created_at: created_at:
type: string type: string
format: date-time format: date-time
@@ -56,8 +56,7 @@ properties:
type: array type: array
description: The claim's transactions. description: The claim's transactions.
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
description: Learn more about transactions of orders and associated models. description: Learn more about transactions of orders and associated models.
items: items:
$ref: ./OrderTransaction.yaml $ref: ./OrderTransaction.yaml
@@ -52,8 +52,7 @@ properties:
type: array type: array
description: The exchange's transactions. description: The exchange's transactions.
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
items: items:
$ref: ./OrderTransaction.yaml $ref: ./OrderTransaction.yaml
metadata: metadata:
@@ -53,7 +53,7 @@ properties:
the fulfillment. the fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -45,7 +45,7 @@ properties:
services. services.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property https://docs.medusajs.com/resources/commerce-modules/cart/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -94,7 +94,7 @@ properties:
description: The shipping option's data, useful for the provider handling fulfillment. description: The shipping option's data, useful for the provider handling fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
prices: prices:
type: array type: array
description: The shipping option's prices. description: The shipping option's prices.
@@ -13,6 +13,6 @@ properties:
description: Any data necessary for the payment provider to process the payment. description: Any data necessary for the payment provider to process the payment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
description: Learn more about the payment session's data property description: Learn more about the payment session's data property
x-schemaName: StoreInitializePaymentSession x-schemaName: StoreInitializePaymentSession
@@ -51,7 +51,7 @@ properties:
the associated shipping option. the associated shipping option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -56,7 +56,7 @@ properties:
fulfillment. fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -26,7 +26,7 @@ properties:
payment. payment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
context: context:
type: object type: object
description: The context around the payment, such as the customer's details. description: The context around the payment, such as the customer's details.
@@ -102,7 +102,7 @@ properties:
is always considered in stock. is always considered in stock.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/inventory https://docs.medusajs.com/resources/storefront-development/products/inventory
description: 'Storefront guide: How to retrieve a product variant''s inventory details.' description: 'Storefront guide: How to retrieve a product variant''s inventory details.'
inventory_quantity: inventory_quantity:
type: number type: number
@@ -112,7 +112,7 @@ properties:
pass `+variants.inventory_quantity` in the `fields` query parameter. pass `+variants.inventory_quantity` in the `fields` query parameter.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/inventory https://docs.medusajs.com/resources/storefront-development/products/inventory
description: 'Storefront guide: How to retrieve a product variant''s inventory details.' description: 'Storefront guide: How to retrieve a product variant''s inventory details.'
variant_rank: variant_rank:
type: number type: number
@@ -66,7 +66,7 @@ properties:
description: The shipping option's data, useful for the provider handling fulfillment. description: The shipping option's data, useful for the provider handling fulfillment.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping option's metadata, can hold custom key-value pairs. description: The shipping option's metadata, can hold custom key-value pairs.
@@ -182,7 +182,7 @@ paths:
When used with a third-party provider, such as Google, the request returns a `location` property. You redirect to the specified URL in your storefront to continue authentication with the third-party service. When used with a third-party provider, such as Google, the request returns a `location` property. You redirect to the specified URL in your storefront to continue authentication with the third-party service.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/storefront-development/customers/login#1-using-a-jwt-token url: https://docs.medusajs.com/resources/storefront-development/customers/login#1-using-a-jwt-token
description: 'Storefront development: How to login as a customer' description: 'Storefront development: How to login as a customer'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -274,7 +274,7 @@ paths:
This API route is used by your storefront or frontend application when a third-party provider redirects to it after authentication. It validates the authentication with the third-party provider and, if successful, returns an authentication token. All query parameters received from the third-party provider, such as `code`, `state`, and `error`, must be passed as query parameters to this route. This API route is used by your storefront or frontend application when a third-party provider redirects to it after authentication. It validates the authentication with the third-party provider and, if successful, returns an authentication token. All query parameters received from the third-party provider, such as `code`, `state`, and `error`, must be passed as query parameters to this route.
You can decode the JWT token using libraries like [react-jwt](https://www.npmjs.com/package/react-jwt) in the storefront. If the decoded data doesn't have an `actor_id` property, then you must register the customer using the Create Customer API route passing the token in the request's Authorization header. You can decode the JWT token using libraries like [react-jwt](https://www.npmjs.com/package/react-jwt) in the storefront. If the decoded data doesn't have an `actor_id` property, then you must register the customer using the Create Customer API route passing the token in the request's Authorization header.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/storefront-development/customers/third-party-login url: https://docs.medusajs.com/resources/storefront-development/customers/third-party-login
description: 'Storefront development: Implement third-party (social) login.' description: 'Storefront development: Implement third-party (social) login.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -375,7 +375,7 @@ paths:
summary: Retrieve Registration JWT Token summary: Retrieve Registration JWT Token
description: This API route retrieves a registration JWT token of a customer that hasn't been registered yet. The token is used in the header of requests that create a customer. description: This API route retrieves a registration JWT token of a customer that hasn't been registered yet. The token is used in the header of requests that create a customer.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/storefront-development/customers/register url: https://docs.medusajs.com/resources/storefront-development/customers/register
description: 'Storefront development: How to register a customer' description: 'Storefront development: How to register a customer'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -471,7 +471,7 @@ paths:
Use the generated token to update the customer's password using the [Reset Password API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerupdate). Use the generated token to update the customer's password using the [Reset Password API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerupdate).
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#1-request-reset-password-page url: https://docs.medusajs.com/resources/storefront-development/customers/reset-password#1-request-reset-password-page
description: 'Storefront development: How to create the request reset password page.' description: 'Storefront development: How to create the request reset password page.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -565,7 +565,7 @@ paths:
x-sidebar-summary: Reset Password x-sidebar-summary: Reset Password
description: Reset a customer's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header. description: Reset a customer's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#2-reset-password-page url: https://docs.medusajs.com/resources/storefront-development/customers/reset-password#2-reset-password-page
description: 'Storefront development: How to create the reset password page.' description: 'Storefront development: How to create the reset password page.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -662,7 +662,7 @@ paths:
summary: Set Authentication Session summary: Set Authentication Session
description: Set the cookie session ID of a customer. The customer must be previously authenticated with the `/auth/customer/{provider}` API route first, as the JWT token is required in the header of the request. description: Set the cookie session ID of a customer. The customer must be previously authenticated with the `/auth/customer/{provider}` API route first, as the JWT token is required in the header of the request.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/storefront-development/customers/login#2-using-a-cookie-session url: https://docs.medusajs.com/resources/storefront-development/customers/login#2-using-a-cookie-session
description: 'Storefront development: How to login as a customer' description: 'Storefront development: How to login as a customer'
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -759,7 +759,7 @@ paths:
summary: Refresh Authentication Token summary: Refresh Authentication Token
description: Refresh the authentication token of a customer. This is useful after authenticating a customer with a third-party service to ensure the token holds the new user's details, or when you don't want customers to re-login every day. description: Refresh the authentication token of a customer. This is useful after authenticating a customer with a third-party service to ensure the token holds the new user's details, or when you don't want customers to re-login every day.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/storefront-development/customers/third-party-login url: https://docs.medusajs.com/resources/storefront-development/customers/third-party-login
description: 'Storefront development: Implement third-party (social) login.' description: 'Storefront development: Implement third-party (social) login.'
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -1120,7 +1120,7 @@ paths:
description: Complete a cart and place an order. description: Complete a cart and place an order.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart url: https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart
description: 'Storefront guide: How to implement cart completion during checkout.' description: 'Storefront guide: How to implement cart completion during checkout.'
parameters: parameters:
- name: id - name: id
@@ -1236,7 +1236,7 @@ paths:
type: string type: string
title: type title: type
description: | description: |
The error's type. Can be a [MedusaError type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types) or `payment_authorization_error` or `payment_requires_more_error` for payment-related errors. The error's type. Can be a [MedusaError type](https://docs.medusajs.com/learn/fundamentals/api-routes/errors#medusaerror-types) or `payment_authorization_error` or `payment_requires_more_error` for payment-related errors.
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -1534,7 +1534,7 @@ paths:
x-sidebar-summary: Add Line Item x-sidebar-summary: Add Line Item
description: Add a product variant as a line item in the cart. description: Add a product variant as a line item in the cart.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#add-product-variant-to-cart url: https://docs.medusajs.com/resources/storefront-development/cart/manage-items#add-product-variant-to-cart
description: 'Storefront guide: How to add a product variant to the cart.' description: 'Storefront guide: How to add a product variant to the cart.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -1666,7 +1666,7 @@ paths:
x-sidebar-summary: Update Line Item x-sidebar-summary: Update Line Item
description: Update a line item's details in the cart. description: Update a line item's details in the cart.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#update-line-item-in-cart url: https://docs.medusajs.com/resources/storefront-development/cart/manage-items#update-line-item-in-cart
description: 'Storefront guide: How to update a cart''s line item.' description: 'Storefront guide: How to update a cart''s line item.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -1800,7 +1800,7 @@ paths:
x-sidebar-summary: Remove Line Item x-sidebar-summary: Remove Line Item
description: Remove a line item from a cart. description: Remove a line item from a cart.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#remove-line-item-from-cart url: https://docs.medusajs.com/resources/storefront-development/cart/manage-items#remove-line-item-from-cart
description: 'Storefront guide: How to remove line item from cart.' description: 'Storefront guide: How to remove line item from cart.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -1922,7 +1922,7 @@ paths:
description: Add a list of promotions to a cart. description: Add a list of promotions to a cart.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-promotions#add-promotion-to-cart url: https://docs.medusajs.com/resources/storefront-development/cart/manage-promotions#add-promotion-to-cart
description: 'Storefront guide: How to add a promotion to cart.' description: 'Storefront guide: How to add a promotion to cart.'
parameters: parameters:
- name: id - name: id
@@ -1995,7 +1995,7 @@ paths:
description: Remove a list of promotions from a cart. description: Remove a list of promotions from a cart.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-promotions#remove-promotion-from-cart url: https://docs.medusajs.com/resources/storefront-development/cart/manage-promotions#remove-promotion-from-cart
description: 'Storefront guide: How to remove a promotion from cart.' description: 'Storefront guide: How to remove a promotion from cart.'
parameters: parameters:
- name: id - name: id
@@ -2073,7 +2073,7 @@ paths:
x-sidebar-summary: Add Shipping Method x-sidebar-summary: Add Shipping Method
description: Add a shipping method to a cart. Use this API route when the customer chooses their preferred shipping option. description: Add a shipping method to a cart. Use this API route when the customer chooses their preferred shipping option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping url: https://docs.medusajs.com/resources/storefront-development/checkout/shipping
description: 'Storefront guide: How to implement shipping during checkout.' description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -2340,7 +2340,7 @@ paths:
description: Retrieve a list of collections. The collections can be filtered by fields such as `handle`. The collections can also be sorted or paginated. description: Retrieve a list of collections. The collections can be filtered by fields such as `handle`. The collections can also be sorted or paginated.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list url: https://docs.medusajs.com/resources/storefront-development/products/collections/list
description: 'Storefront guide: How to retrieve a list of collections.' description: 'Storefront guide: How to retrieve a list of collections.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -3013,7 +3013,7 @@ paths:
description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned. description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve url: https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve
description: 'Storefront guide: How to retrieve a collection.' description: 'Storefront guide: How to retrieve a collection.'
parameters: parameters:
- name: id - name: id
@@ -3282,7 +3282,7 @@ paths:
summary: Register Customer summary: Register Customer
description: Register a customer. Use the `/auth/customer/emailpass/register` API route first to retrieve the registration token and pass it in the header of the request. description: Register a customer. Use the `/auth/customer/emailpass/register` API route first to retrieve the registration token and pass it in the header of the request.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/register url: https://docs.medusajs.com/resources/storefront-development/customers/register
description: 'Storefront guide: How to register a customer.' description: 'Storefront guide: How to register a customer.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -3401,7 +3401,7 @@ paths:
description: Retrieve the logged-in customer. You can expand the customer's relations or select the fields that should be returned. description: Retrieve the logged-in customer. You can expand the customer's relations or select the fields that should be returned.
x-authenticated: true x-authenticated: true
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve url: https://docs.medusajs.com/resources/storefront-development/customers/retrieve
description: 'Storefront guide: How to retrieve the logged-in customer.' description: 'Storefront guide: How to retrieve the logged-in customer.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -3480,7 +3480,7 @@ paths:
summary: Update Customer summary: Update Customer
description: Update the logged-in customer's details. description: Update the logged-in customer's details.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/profile url: https://docs.medusajs.com/resources/storefront-development/customers/profile
description: 'Storefront guide: How to edit a customer''s profile.' description: 'Storefront guide: How to edit a customer''s profile.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -3588,7 +3588,7 @@ paths:
description: Retrieve the addresses of the logged-in customer. The addresses can be filtered by fields such as `country_code`. The addresses can also be sorted or paginated. description: Retrieve the addresses of the logged-in customer. The addresses can be filtered by fields such as `country_code`. The addresses can also be sorted or paginated.
x-authenticated: true x-authenticated: true
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses url: https://docs.medusajs.com/resources/storefront-development/customers/addresses#list-customer-addresses
description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.' description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -3759,7 +3759,7 @@ paths:
x-sidebar-summary: Create Address x-sidebar-summary: Create Address
description: Create an address for the logged-in customer. description: Create an address for the logged-in customer.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#add-customer-address url: https://docs.medusajs.com/resources/storefront-development/customers/addresses#add-customer-address
description: 'Storefront guide: How to create an address for the logged-in customer.' description: 'Storefront guide: How to create an address for the logged-in customer.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -3951,7 +3951,7 @@ paths:
x-sidebar-summary: Update Address x-sidebar-summary: Update Address
description: Update the logged-in customer's address. description: Update the logged-in customer's address.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#edit-an-address url: https://docs.medusajs.com/resources/storefront-development/customers/addresses#edit-an-address
description: 'Storefront guide: How to update an address of the logged-in customer.' description: 'Storefront guide: How to update an address of the logged-in customer.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4055,7 +4055,7 @@ paths:
description: Remove an address of the logged-in customer. description: Remove an address of the logged-in customer.
x-authenticated: true x-authenticated: true
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#delete-customer-address url: https://docs.medusajs.com/resources/storefront-development/customers/addresses#delete-customer-address
description: 'Storefront guide: How to delete a customer''s address.' description: 'Storefront guide: How to delete a customer''s address.'
parameters: parameters:
- name: address_id - name: address_id
@@ -5003,7 +5003,7 @@ paths:
summary: Create Payment Collection summary: Create Payment Collection
description: Create a payment collection for a cart. This is used during checkout, where the payment collection holds the cart's payment sessions. description: Create a payment collection for a cart. This is used during checkout, where the payment collection holds the cart's payment sessions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment url: https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.' description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -5103,7 +5103,7 @@ paths:
In cases where you want to create a payment session for a payment collection with an amount of `0`, you can use the Manual System Payment Provider instead of third-party payment providers. The Manual System Payment Provider is built into Medusa and allows you to create payment sessions without interacting with an external payment provider. In cases where you want to create a payment session for a payment collection with an amount of `0`, you can use the Manual System Payment Provider instead of third-party payment providers. The Manual System Payment Provider is built into Medusa and allows you to create payment sessions without interacting with an external payment provider.
Make sure to configure the Manual System Payment Provider in your store's region. Learn more in the [Manage Region](https://docs.medusajs.com/user-guide/settings/regions#edit-region-details) user guide. Make sure to configure the Manual System Payment Provider in your store's region. Learn more in the [Manage Region](https://docs.medusajs.com/user-guide/settings/regions#edit-region-details) user guide.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment url: https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.' description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -5176,7 +5176,7 @@ paths:
description: Retrieve a list of payment providers. You must provide the `region_id` query parameter to retrieve the payment providers enabled in that region. description: Retrieve a list of payment providers. You must provide the `region_id` query parameter to retrieve the payment providers enabled in that region.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment url: https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.' description: 'Storefront guide: How to implement payment during checkout.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -5327,7 +5327,7 @@ paths:
description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list url: https://docs.medusajs.com/resources/storefront-development/products/categories/list
description: 'Storefront guide: How to retrieve a list of product categories.' description: 'Storefront guide: How to retrieve a list of product categories.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -6013,7 +6013,7 @@ paths:
description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve url: https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve
description: 'Storefront guide: How to retrieve a product category.' description: 'Storefront guide: How to retrieve a product category.'
parameters: parameters:
- name: id - name: id
@@ -7455,7 +7455,7 @@ paths:
description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/price url: https://docs.medusajs.com/resources/storefront-development/products/price
description: 'Storefront guide: How to retrieve a product variants'' prices.' description: 'Storefront guide: How to retrieve a product variants'' prices.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -7591,7 +7591,7 @@ paths:
schema: schema:
description: Filter by a collection's ID to retrieve the products in it. description: Filter by a collection's ID to retrieve the products in it.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/products url: https://docs.medusajs.com/resources/storefront-development/products/collections/products
description: 'Storefront guide: Retrieve a collection''s products.' description: 'Storefront guide: Retrieve a collection''s products.'
items: items:
type: string type: string
@@ -8098,7 +8098,7 @@ paths:
title: region_id title: region_id
description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes. description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price url: https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price
description: 'Storefront guide: How to show product variants'' prices with taxes.' description: 'Storefront guide: How to show product variants'' prices with taxes.'
- name: province - name: province
in: query in: query
@@ -8264,7 +8264,7 @@ paths:
description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/price url: https://docs.medusajs.com/resources/storefront-development/products/price
description: 'Storefront guide: How to retrieve a product variants'' prices.' description: 'Storefront guide: How to retrieve a product variants'' prices.'
parameters: parameters:
- name: id - name: id
@@ -8300,7 +8300,7 @@ paths:
title: region_id title: region_id
description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes. description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price url: https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price
description: 'Storefront guide: How to show product variants'' prices with taxes.' description: 'Storefront guide: How to show product variants'' prices with taxes.'
- name: country_code - name: country_code
in: query in: query
@@ -8385,7 +8385,7 @@ paths:
description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list url: https://docs.medusajs.com/resources/storefront-development/regions/list
description: 'Storefront guide: How to retrieve a list of regions.' description: 'Storefront guide: How to retrieve a list of regions.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -8944,7 +8944,7 @@ paths:
The shipping options also be sorted or paginated. The shipping options also be sorted or paginated.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping url: https://docs.medusajs.com/resources/storefront-development/checkout/shipping
description: 'Storefront guide: How to implement shipping during checkout.' description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -10952,7 +10952,7 @@ components:
type: array type: array
description: The claim's transactions. description: The claim's transactions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
description: Learn more about transactions of orders and associated models. description: Learn more about transactions of orders and associated models.
items: items:
$ref: '#/components/schemas/BaseOrderTransaction' $ref: '#/components/schemas/BaseOrderTransaction'
@@ -11603,7 +11603,7 @@ components:
type: object type: object
description: The flat-rate shipping option's data, useful for the fulfillment provider handling its processing. description: The flat-rate shipping option's data, useful for the fulfillment provider handling its processing.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
price_type: price_type:
type: string type: string
description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider. description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider.
@@ -11766,7 +11766,7 @@ components:
type: object type: object
description: Any data useful for the fulfillment provider to handle the fulfillment. description: Any data useful for the fulfillment provider to handle the fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
description: Learn more about the data property. description: Learn more about the data property.
packed_at: packed_at:
type: string type: string
@@ -13056,7 +13056,7 @@ components:
title: is_combinable title: is_combinable
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The tax rate's metadata, used to store custom key-value pairs. description: The tax rate's metadata, used to store custom key-value pairs.
@@ -13130,7 +13130,7 @@ components:
type: boolean type: boolean
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The default tax rate's metadata, used to store custom key-value pairs. description: The default tax rate's metadata, used to store custom key-value pairs.
@@ -14876,7 +14876,7 @@ components:
type: object type: object
description: The data relevant for the fulfillment provider to process this shipment. description: The data relevant for the fulfillment provider to process this shipment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -15265,7 +15265,7 @@ components:
type: array type: array
description: The exchange's transactions. description: The exchange's transactions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
items: items:
$ref: '#/components/schemas/BaseOrderTransaction' $ref: '#/components/schemas/BaseOrderTransaction'
metadata: metadata:
@@ -15578,7 +15578,7 @@ components:
type: object type: object
description: The fulfillment's data, useful for the third-party provider handling the fulfillment. description: The fulfillment's data, useful for the third-party provider handling the fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The fulfillment's metadata, can hold custom key-value pairs. description: The fulfillment's metadata, can hold custom key-value pairs.
@@ -17411,7 +17411,7 @@ components:
type: object type: object
description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -18050,7 +18050,7 @@ components:
type: object type: object
description: The data relevant for the fulfillment provider to process this shipment. description: The data relevant for the fulfillment provider to process this shipment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -18448,7 +18448,7 @@ components:
type: object type: object
description: The shipping method's data, useful for fulfillment provider handling its fulfillment. description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -18543,7 +18543,7 @@ components:
type: object type: object
description: The payment's data, useful for processing by the payment provider. description: The payment's data, useful for processing by the payment provider.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment url: https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
created_at: created_at:
type: string type: string
format: date-time format: date-time
@@ -18726,7 +18726,7 @@ components:
type: object type: object
description: The payment session's data, useful for the payment provider processing the payment. description: The payment session's data, useful for the payment provider processing the payment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
context: context:
type: object type: object
description: The context around the payment, such as the customer's details. description: The context around the payment, such as the customer's details.
@@ -21692,7 +21692,7 @@ components:
type: object type: object
description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option. description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping option's metadata, can hold custom key-value pairs. description: The shipping option's metadata, can hold custom key-value pairs.
@@ -22620,7 +22620,7 @@ components:
title: is_combinable title: is_combinable
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
is_default: is_default:
type: boolean type: boolean
title: is_default title: is_default
@@ -24459,7 +24459,7 @@ components:
title: is_combinable title: is_combinable
description: Whether the tax rate should be combined with parent rates. description: Whether the tax rate should be combined with parent rates.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
metadata: metadata:
type: object type: object
description: The tax rate's metadata, can hold custom key-value pairs. description: The tax rate's metadata, can hold custom key-value pairs.
@@ -26513,7 +26513,7 @@ components:
type: object type: object
description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -27059,7 +27059,7 @@ components:
type: object type: object
description: The shipping method's data, useful for fulfillment provider handling its fulfillment. description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -27374,7 +27374,7 @@ components:
type: object type: object
description: The payment's data, useful for processing by the payment provider. description: The payment's data, useful for processing by the payment provider.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment url: https://docs.medusajs.com/resources/commerce-modules/payment/payment#whats-a-payment
created_at: created_at:
type: string type: string
format: date-time format: date-time
@@ -29827,7 +29827,7 @@ components:
type: array type: array
description: The claim's transactions. description: The claim's transactions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
description: Learn more about transactions of orders and associated models. description: Learn more about transactions of orders and associated models.
items: items:
$ref: '#/components/schemas/OrderTransaction' $ref: '#/components/schemas/OrderTransaction'
@@ -29992,7 +29992,7 @@ components:
type: array type: array
description: The exchange's transactions. description: The exchange's transactions.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
items: items:
$ref: '#/components/schemas/OrderTransaction' $ref: '#/components/schemas/OrderTransaction'
metadata: metadata:
@@ -30566,7 +30566,7 @@ components:
type: object type: object
description: The shipping method's data, useful for the fulfillment provider handling the fulfillment. description: The shipping method's data, useful for the fulfillment provider handling the fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -31821,7 +31821,7 @@ components:
type: object type: object
description: The shipping method's data, useful for fulfillment handling by third-party services. description: The shipping method's data, useful for fulfillment handling by third-party services.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property url: https://docs.medusajs.com/resources/commerce-modules/cart/concepts#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -32111,7 +32111,7 @@ components:
type: object type: object
description: The shipping option's data, useful for the provider handling fulfillment. description: The shipping option's data, useful for the provider handling fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
prices: prices:
type: array type: array
description: The shipping option's prices. description: The shipping option's prices.
@@ -32838,7 +32838,7 @@ components:
type: object type: object
description: Any data necessary for the payment provider to process the payment. description: Any data necessary for the payment provider to process the payment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
description: Learn more about the payment session's data property description: Learn more about the payment session's data property
x-schemaName: StoreInitializePaymentSession x-schemaName: StoreInitializePaymentSession
StoreOrder: StoreOrder:
@@ -33227,7 +33227,7 @@ components:
type: object type: object
description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
provider_id: provider_id:
type: string type: string
title: provider_id title: provider_id
@@ -37401,7 +37401,7 @@ components:
type: object type: object
description: The shipping method's data, useful for fulfillment provider handling its fulfillment. description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping method's metadata, can hold custom key-value pairs. description: The shipping method's metadata, can hold custom key-value pairs.
@@ -39201,7 +39201,7 @@ components:
type: object type: object
description: The payment session's data, useful for the payment provider processing the payment. description: The payment session's data, useful for the payment provider processing the payment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property url: https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property
context: context:
type: object type: object
description: The context around the payment, such as the customer's details. description: The context around the payment, such as the customer's details.
@@ -39987,14 +39987,14 @@ components:
title: manage_inventory title: manage_inventory
description: Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock. description: Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory url: https://docs.medusajs.com/resources/storefront-development/products/inventory
description: 'Storefront guide: How to retrieve a product variant''s inventory details.' description: 'Storefront guide: How to retrieve a product variant''s inventory details.'
inventory_quantity: inventory_quantity:
type: number type: number
title: inventory_quantity title: inventory_quantity
description: The variant's inventory quantity. This property is only available if you pass `+variants.inventory_quantity` in the `fields` query parameter. description: The variant's inventory quantity. This property is only available if you pass `+variants.inventory_quantity` in the `fields` query parameter.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory url: https://docs.medusajs.com/resources/storefront-development/products/inventory
description: 'Storefront guide: How to retrieve a product variant''s inventory details.' description: 'Storefront guide: How to retrieve a product variant''s inventory details.'
variant_rank: variant_rank:
type: number type: number
@@ -40378,7 +40378,7 @@ components:
type: object type: object
description: The shipping option's data, useful for the provider handling fulfillment. description: The shipping option's data, useful for the provider handling fulfillment.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
metadata: metadata:
type: object type: object
description: The shipping option's metadata, can hold custom key-value pairs. description: The shipping option's metadata, can hold custom key-value pairs.
@@ -11,7 +11,7 @@ post:
continue authentication with the third-party service. continue authentication with the third-party service.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/storefront-development/customers/login#1-using-a-jwt-token https://docs.medusajs.com/resources/storefront-development/customers/login#1-using-a-jwt-token
description: 'Storefront development: How to login as a customer' description: 'Storefront development: How to login as a customer'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -16,7 +16,7 @@ post:
in the request's Authorization header. in the request's Authorization header.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/storefront-development/customers/third-party-login https://docs.medusajs.com/resources/storefront-development/customers/third-party-login
description: 'Storefront development: Implement third-party (social) login.' description: 'Storefront development: Implement third-party (social) login.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -6,7 +6,8 @@ post:
been registered yet. The token is used in the header of requests that create been registered yet. The token is used in the header of requests that create
a customer. a customer.
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/storefront-development/customers/register url: >-
https://docs.medusajs.com/resources/storefront-development/customers/register
description: 'Storefront development: How to register a customer' description: 'Storefront development: How to register a customer'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -21,7 +21,7 @@ post:
Use the generated token to update the customer's password using the [Reset Password API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerupdate). Use the generated token to update the customer's password using the [Reset Password API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerupdate).
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#1-request-reset-password-page https://docs.medusajs.com/resources/storefront-development/customers/reset-password#1-request-reset-password-page
description: 'Storefront development: How to create the request reset password page.' description: 'Storefront development: How to create the request reset password page.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -9,7 +9,7 @@ post:
You pass the token as a bearer token in the request's Authorization header. You pass the token as a bearer token in the request's Authorization header.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#2-reset-password-page https://docs.medusajs.com/resources/storefront-development/customers/reset-password#2-reset-password-page
description: 'Storefront development: How to create the reset password page.' description: 'Storefront development: How to create the reset password page.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -7,7 +7,7 @@ post:
JWT token is required in the header of the request. JWT token is required in the header of the request.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/storefront-development/customers/login#2-using-a-cookie-session https://docs.medusajs.com/resources/storefront-development/customers/login#2-using-a-cookie-session
description: 'Storefront development: How to login as a customer' description: 'Storefront development: How to login as a customer'
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -8,7 +8,7 @@ post:
every day. every day.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/storefront-development/customers/third-party-login https://docs.medusajs.com/resources/storefront-development/customers/third-party-login
description: 'Storefront development: Implement third-party (social) login.' description: 'Storefront development: Implement third-party (social) login.'
x-authenticated: true x-authenticated: true
x-codeSamples: x-codeSamples:
@@ -5,7 +5,7 @@ post:
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart
description: 'Storefront guide: How to implement cart completion during checkout.' description: 'Storefront guide: How to implement cart completion during checkout.'
parameters: parameters:
- name: id - name: id
@@ -110,7 +110,7 @@ post:
title: type title: type
description: > description: >
The error's type. Can be a [MedusaError The error's type. Can be a [MedusaError
type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types) type](https://docs.medusajs.com/learn/fundamentals/api-routes/errors#medusaerror-types)
or `payment_authorization_error` or or `payment_authorization_error` or
`payment_requires_more_error` for payment-related `payment_requires_more_error` for payment-related
errors. errors.
@@ -5,7 +5,7 @@ post:
description: Add a product variant as a line item in the cart. description: Add a product variant as a line item in the cart.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#add-product-variant-to-cart https://docs.medusajs.com/resources/storefront-development/cart/manage-items#add-product-variant-to-cart
description: 'Storefront guide: How to add a product variant to the cart.' description: 'Storefront guide: How to add a product variant to the cart.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -5,7 +5,7 @@ post:
description: Update a line item's details in the cart. description: Update a line item's details in the cart.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#update-line-item-in-cart https://docs.medusajs.com/resources/storefront-development/cart/manage-items#update-line-item-in-cart
description: 'Storefront guide: How to update a cart''s line item.' description: 'Storefront guide: How to update a cart''s line item.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -123,7 +123,7 @@ delete:
description: Remove a line item from a cart. description: Remove a line item from a cart.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#remove-line-item-from-cart https://docs.medusajs.com/resources/storefront-development/cart/manage-items#remove-line-item-from-cart
description: 'Storefront guide: How to remove line item from cart.' description: 'Storefront guide: How to remove line item from cart.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -6,7 +6,7 @@ post:
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-promotions#add-promotion-to-cart https://docs.medusajs.com/resources/storefront-development/cart/manage-promotions#add-promotion-to-cart
description: 'Storefront guide: How to add a promotion to cart.' description: 'Storefront guide: How to add a promotion to cart.'
parameters: parameters:
- name: id - name: id
@@ -81,7 +81,7 @@ delete:
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-promotions#remove-promotion-from-cart https://docs.medusajs.com/resources/storefront-development/cart/manage-promotions#remove-promotion-from-cart
description: 'Storefront guide: How to remove a promotion from cart.' description: 'Storefront guide: How to remove a promotion from cart.'
parameters: parameters:
- name: id - name: id
@@ -7,7 +7,7 @@ post:
chooses their preferred shipping option. chooses their preferred shipping option.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping https://docs.medusajs.com/resources/storefront-development/checkout/shipping
description: 'Storefront guide: How to implement shipping during checkout.' description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -7,7 +7,7 @@ get:
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list https://docs.medusajs.com/resources/storefront-development/products/collections/list
description: 'Storefront guide: How to retrieve a list of collections.' description: 'Storefront guide: How to retrieve a list of collections.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -7,7 +7,7 @@ get:
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve
description: 'Storefront guide: How to retrieve a collection.' description: 'Storefront guide: How to retrieve a collection.'
parameters: parameters:
- name: id - name: id
@@ -7,7 +7,7 @@ post:
request. request.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/register https://docs.medusajs.com/resources/storefront-development/customers/register
description: 'Storefront guide: How to register a customer.' description: 'Storefront guide: How to register a customer.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -8,7 +8,7 @@ get:
x-authenticated: true x-authenticated: true
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve https://docs.medusajs.com/resources/storefront-development/customers/retrieve
description: 'Storefront guide: How to retrieve the logged-in customer.' description: 'Storefront guide: How to retrieve the logged-in customer.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -84,7 +84,7 @@ post:
description: Update the logged-in customer's details. description: Update the logged-in customer's details.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/profile https://docs.medusajs.com/resources/storefront-development/customers/profile
description: 'Storefront guide: How to edit a customer''s profile.' description: 'Storefront guide: How to edit a customer''s profile.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -9,7 +9,7 @@ get:
x-authenticated: true x-authenticated: true
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses https://docs.medusajs.com/resources/storefront-development/customers/addresses#list-customer-addresses
description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.' description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -169,7 +169,7 @@ post:
description: Create an address for the logged-in customer. description: Create an address for the logged-in customer.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#add-customer-address https://docs.medusajs.com/resources/storefront-development/customers/addresses#add-customer-address
description: 'Storefront guide: How to create an address for the logged-in customer.' description: 'Storefront guide: How to create an address for the logged-in customer.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -88,7 +88,7 @@ post:
description: Update the logged-in customer's address. description: Update the logged-in customer's address.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#edit-an-address https://docs.medusajs.com/resources/storefront-development/customers/addresses#edit-an-address
description: 'Storefront guide: How to update an address of the logged-in customer.' description: 'Storefront guide: How to update an address of the logged-in customer.'
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -182,7 +182,7 @@ delete:
x-authenticated: true x-authenticated: true
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#delete-customer-address https://docs.medusajs.com/resources/storefront-development/customers/addresses#delete-customer-address
description: 'Storefront guide: How to delete a customer''s address.' description: 'Storefront guide: How to delete a customer''s address.'
parameters: parameters:
- name: address_id - name: address_id
@@ -6,7 +6,7 @@ post:
the payment collection holds the cart's payment sessions. the payment collection holds the cart's payment sessions.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.' description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -25,7 +25,7 @@ post:
user guide. user guide.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.' description: 'Storefront guide: How to implement payment during checkout.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -7,7 +7,7 @@ get:
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment https://docs.medusajs.com/resources/storefront-development/checkout/payment
description: 'Storefront guide: How to implement payment during checkout.' description: 'Storefront guide: How to implement payment during checkout.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -8,7 +8,7 @@ get:
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list https://docs.medusajs.com/resources/storefront-development/products/categories/list
description: 'Storefront guide: How to retrieve a list of product categories.' description: 'Storefront guide: How to retrieve a list of product categories.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -7,7 +7,7 @@ get:
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve
description: 'Storefront guide: How to retrieve a product category.' description: 'Storefront guide: How to retrieve a product category.'
parameters: parameters:
- name: id - name: id
@@ -6,8 +6,7 @@ get:
`id`. The products can also be sorted or paginated. `id`. The products can also be sorted or paginated.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/storefront-development/products/price
https://docs.medusajs.com/v2/resources/storefront-development/products/price
description: 'Storefront guide: How to retrieve a product variants'' prices.' description: 'Storefront guide: How to retrieve a product variants'' prices.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -165,7 +164,7 @@ get:
description: Filter by a collection's ID to retrieve the products in it. description: Filter by a collection's ID to retrieve the products in it.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/collections/products https://docs.medusajs.com/resources/storefront-development/products/collections/products
description: 'Storefront guide: Retrieve a collection''s products.' description: 'Storefront guide: Retrieve a collection''s products.'
items: items:
type: string type: string
@@ -753,7 +752,7 @@ get:
required if you're retrieving product variant prices with taxes. required if you're retrieving product variant prices with taxes.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price
description: 'Storefront guide: How to show product variants'' prices with taxes.' description: 'Storefront guide: How to show product variants'' prices with taxes.'
- name: province - name: province
in: query in: query
@@ -6,8 +6,7 @@ get:
select the fields that should be returned. select the fields that should be returned.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: >- url: https://docs.medusajs.com/resources/storefront-development/products/price
https://docs.medusajs.com/v2/resources/storefront-development/products/price
description: 'Storefront guide: How to retrieve a product variants'' prices.' description: 'Storefront guide: How to retrieve a product variants'' prices.'
parameters: parameters:
- name: id - name: id
@@ -56,7 +55,7 @@ get:
required if you're retrieving product variant prices with taxes. required if you're retrieving product variant prices with taxes.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price
description: 'Storefront guide: How to show product variants'' prices with taxes.' description: 'Storefront guide: How to show product variants'' prices with taxes.'
- name: country_code - name: country_code
in: query in: query
@@ -6,7 +6,7 @@ get:
`id`. The regions can also be sorted or paginated. `id`. The regions can also be sorted or paginated.
x-authenticated: false x-authenticated: false
externalDocs: externalDocs:
url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list url: https://docs.medusajs.com/resources/storefront-development/regions/list
description: 'Storefront guide: How to retrieve a list of regions.' description: 'Storefront guide: How to retrieve a list of regions.'
parameters: parameters:
- name: x-publishable-api-key - name: x-publishable-api-key
@@ -9,7 +9,7 @@ get:
The shipping options also be sorted or paginated. The shipping options also be sorted or paginated.
externalDocs: externalDocs:
url: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping https://docs.medusajs.com/resources/storefront-development/checkout/shipping
description: 'Storefront guide: How to implement shipping during checkout.' description: 'Storefront guide: How to implement shipping during checkout.'
x-authenticated: false x-authenticated: false
parameters: parameters:
@@ -288,7 +288,7 @@
* type: object * type: object
* description: The shipping method's data, useful for fulfillment providers. * description: The shipping method's data, useful for fulfillment providers.
* externalDocs: * externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property * url: https://docs.medusajs.com/resources/commerce-modules/order/concepts#data-property
* amount: * amount:
* oneOf: * oneOf:
* - type: string * - type: string
@@ -46,7 +46,7 @@
* type: string * type: string
* description: The promotion's type. * description: The promotion's type.
* externalDocs: * externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion * url: https://docs.medusajs.com/resources/commerce-modules/promotion/concepts#what-is-a-promotion
* enum: * enum:
* - standard * - standard
* - buyget * - buyget
Loaded 100 of 169 files, more files were not shown because too many files have changed in this diff. Show more