docs: fix broken links in OAS (#14000)
This commit is contained in:
@@ -288,7 +288,7 @@
|
||||
* type: object
|
||||
* description: The shipping method's data, useful for fulfillment providers.
|
||||
* 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:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
|
||||
@@ -46,7 +46,7 @@
|
||||
* type: string
|
||||
* description: The promotion's type.
|
||||
* 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:
|
||||
* - standard
|
||||
* - buyget
|
||||
|
||||
@@ -49,7 +49,7 @@
|
||||
* type: string
|
||||
* description: The promotion's type.
|
||||
* 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:
|
||||
* - standard
|
||||
* - buyget
|
||||
|
||||
+1
-1
@@ -9,7 +9,7 @@
|
||||
* 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:
|
||||
* 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.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -10,7 +10,7 @@
|
||||
* 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:
|
||||
* 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.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@
|
||||
*
|
||||
* 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:
|
||||
* 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.
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* 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.
|
||||
* 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.
|
||||
* x-authenticated: true
|
||||
* x-codeSamples:
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* x-sidebar-summary: Remove Line Item
|
||||
* description: Remove a line item from a cart.
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* description: Remove a list of promotions from a cart.
|
||||
* x-authenticated: false
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: id
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@
|
||||
* description: Remove an address of the logged-in customer.
|
||||
* x-authenticated: true
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: address_id
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: x-publishable-api-key
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: id
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
* description: Retrieve the logged-in customer. You can expand the customer's relations or select the fields that should be returned.
|
||||
* x-authenticated: true
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: x-publishable-api-key
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: x-publishable-api-key
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: x-publishable-api-key
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: x-publishable-api-key
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: id
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: x-publishable-api-key
|
||||
@@ -143,7 +143,7 @@
|
||||
* schema:
|
||||
* description: Filter by a collection's ID to retrieve the products in it.
|
||||
* 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."
|
||||
* items:
|
||||
* type: string
|
||||
@@ -650,7 +650,7 @@
|
||||
* 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.
|
||||
* 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."
|
||||
* - name: province
|
||||
* in: query
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -43,7 +43,7 @@
|
||||
* 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.
|
||||
* 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."
|
||||
* - name: country_code
|
||||
* in: query
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* 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
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: x-publishable-api-key
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
*
|
||||
* The shipping options also be sorted or paginated.
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -9,7 +9,7 @@
|
||||
* 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:
|
||||
* 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"
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -9,7 +9,7 @@
|
||||
* 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:
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@
|
||||
* 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.
|
||||
* 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"
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@
|
||||
*
|
||||
* 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:
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* 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.
|
||||
* 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."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* 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:
|
||||
* 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"
|
||||
* x-authenticated: true
|
||||
* x-codeSamples:
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* 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.
|
||||
* 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."
|
||||
* x-authenticated: true
|
||||
* x-codeSamples:
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* description: Complete a cart and place an order.
|
||||
* x-authenticated: false
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -123,7 +123,7 @@
|
||||
* type: string
|
||||
* title: type
|
||||
* 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
|
||||
* 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":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
* x-sidebar-summary: Add Line Item
|
||||
* description: Add a product variant as a line item in the cart.
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* x-sidebar-summary: Update Line Item
|
||||
* description: Update a line item's details in the cart.
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
* description: Add a list of promotions to a cart.
|
||||
* x-authenticated: false
|
||||
* 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."
|
||||
* parameters:
|
||||
* - name: id
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* 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.
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* 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.
|
||||
* 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."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* summary: Update Customer
|
||||
* description: Update the logged-in customer's details.
|
||||
* 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."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* x-sidebar-summary: Create Address
|
||||
* description: Create an address for the logged-in customer.
|
||||
* 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."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@
|
||||
* x-sidebar-summary: Update Address
|
||||
* description: Update the logged-in customer's address.
|
||||
* 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."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* 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.
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@
|
||||
*
|
||||
* 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:
|
||||
* 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."
|
||||
* x-authenticated: false
|
||||
* parameters:
|
||||
|
||||
@@ -62,7 +62,7 @@
|
||||
* type: array
|
||||
* description: The claim's transactions.
|
||||
* 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.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderTransaction"
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
* type: object
|
||||
* description: The flat-rate shipping option's data, useful for the fulfillment provider handling its processing.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
* price_type:
|
||||
* type: string
|
||||
* description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider.
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
* type: object
|
||||
* description: Any data useful for the fulfillment provider to handle the fulfillment.
|
||||
* 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.
|
||||
* packed_at:
|
||||
* type: string
|
||||
|
||||
@@ -40,7 +40,7 @@
|
||||
* title: is_combinable
|
||||
* description: Whether the tax rate should be combined with parent rates.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The tax rate's metadata, used to store custom key-value pairs.
|
||||
|
||||
@@ -48,7 +48,7 @@
|
||||
* type: boolean
|
||||
* description: Whether the tax rate should be combined with parent rates.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The default tax rate's metadata, used to store custom key-value pairs.
|
||||
|
||||
@@ -341,7 +341,7 @@
|
||||
* type: object
|
||||
* description: The data relevant for the fulfillment provider to process this shipment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -58,7 +58,7 @@
|
||||
* type: array
|
||||
* description: The exchange's transactions.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
|
||||
* url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
|
||||
* items:
|
||||
* $ref: "#/components/schemas/BaseOrderTransaction"
|
||||
* metadata:
|
||||
|
||||
@@ -72,7 +72,7 @@
|
||||
* type: object
|
||||
* description: The fulfillment's data, useful for the third-party provider handling the fulfillment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The fulfillment's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
* type: object
|
||||
* description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
* provider_id:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
|
||||
@@ -341,7 +341,7 @@
|
||||
* type: object
|
||||
* description: The data relevant for the fulfillment provider to process this shipment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -55,7 +55,7 @@
|
||||
* type: object
|
||||
* description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
* type: object
|
||||
* description: The payment's data, useful for processing by the payment provider.
|
||||
* 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:
|
||||
* type: string
|
||||
* format: date-time
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
* type: object
|
||||
* description: The payment session's data, useful for the payment provider processing the payment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The context around the payment, such as the customer's details.
|
||||
|
||||
@@ -76,7 +76,7 @@
|
||||
* type: object
|
||||
* description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping option's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -51,7 +51,7 @@
|
||||
* title: is_combinable
|
||||
* description: Whether the tax rate should be combined with parent rates.
|
||||
* 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:
|
||||
* type: boolean
|
||||
* title: is_default
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
* title: is_combinable
|
||||
* description: Whether the tax rate should be combined with parent rates.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The tax rate's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
* type: object
|
||||
* description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
* provider_id:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
|
||||
@@ -55,7 +55,7 @@
|
||||
* type: object
|
||||
* description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
* type: object
|
||||
* description: The payment's data, useful for processing by the payment provider.
|
||||
* 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:
|
||||
* type: string
|
||||
* format: date-time
|
||||
|
||||
@@ -58,7 +58,7 @@
|
||||
* type: array
|
||||
* description: The claim's transactions.
|
||||
* 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.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderTransaction"
|
||||
|
||||
@@ -51,7 +51,7 @@
|
||||
* type: array
|
||||
* description: The exchange's transactions.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
|
||||
* url: https://docs.medusajs.com/resources/commerce-modules/order/transactions
|
||||
* items:
|
||||
* $ref: "#/components/schemas/OrderTransaction"
|
||||
* metadata:
|
||||
|
||||
@@ -52,7 +52,7 @@
|
||||
* type: object
|
||||
* description: The shipping method's data, useful for the fulfillment provider handling the fulfillment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -44,7 +44,7 @@
|
||||
* type: object
|
||||
* description: The shipping method's data, useful for fulfillment handling by third-party services.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -93,7 +93,7 @@
|
||||
* type: object
|
||||
* description: The shipping option's data, useful for the provider handling fulfillment.
|
||||
* 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:
|
||||
* type: array
|
||||
* description: The shipping option's prices.
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
* type: object
|
||||
* description: Any data necessary for the payment provider to process the payment.
|
||||
* 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
|
||||
* x-schemaName: StoreInitializePaymentSession
|
||||
*
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
* type: object
|
||||
* description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
|
||||
* provider_id:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
|
||||
@@ -55,7 +55,7 @@
|
||||
* type: object
|
||||
* description: The shipping method's data, useful for fulfillment provider handling its fulfillment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping method's metadata, can hold custom key-value pairs.
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
* type: object
|
||||
* description: The payment session's data, useful for the payment provider processing the payment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The context around the payment, such as the customer's details.
|
||||
|
||||
@@ -101,14 +101,14 @@
|
||||
* title: manage_inventory
|
||||
* description: Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.
|
||||
* 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."
|
||||
* inventory_quantity:
|
||||
* type: number
|
||||
* 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.
|
||||
* 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."
|
||||
* variant_rank:
|
||||
* type: number
|
||||
|
||||
@@ -65,7 +65,7 @@
|
||||
* type: object
|
||||
* description: The shipping option's data, useful for the provider handling fulfillment.
|
||||
* 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:
|
||||
* type: object
|
||||
* description: The shipping option's metadata, can hold custom key-value pairs.
|
||||
|
||||
Reference in New Issue
Block a user