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

chore(docs): Updated API Reference (automated) (#11719)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-03-04 14:10:22 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 8a36bd4034
commit 6294a71296
26 changed files with 189 additions and 404 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_update/post.sh
+2 -1
View File
@@ -1,5 +1,6 @@
curl -X POST '{backend_url}/auth/user/emailpass/update?token=123' \ curl -X POST '{backend_url}/auth/user/emailpass/update' \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
-H 'Authorization: Bearer {token}' \
--data-raw '{ --data-raw '{
"email": "admin@medusa-test.com", "email": "admin@medusa-test.com",
"password": "supersecret" "password": "supersecret"
www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml
+10
View File
@@ -5,6 +5,8 @@ required:
- id - id
- calculated_amount - calculated_amount
- original_amount - original_amount
- original_amount_with_tax
- original_amount_without_tax
- currency_code - currency_code
properties: properties:
id: id:
@@ -59,3 +61,11 @@ properties:
original_price: original_price:
type: object type: object
description: The original price's details. description: The original price's details.
original_amount_with_tax:
type: number
title: original_amount_with_tax
description: The amount of the original price with taxes applied.
original_amount_without_tax:
type: number
title: original_amount_without_tax
description: The amount of the original price without taxes.
www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml
+5
View File
@@ -5,6 +5,7 @@ required:
- id - id
- order_id - order_id
- order - order
- amount
- reference - reference
- reference_id - reference_id
- metadata - metadata
@@ -44,3 +45,7 @@ properties:
format: date-time format: date-time
title: updated_at title: updated_at
description: The date the credit line was updated. description: The date the credit line was updated.
amount:
type: number
title: amount
description: The credit line's amount.
www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml
+4
View File
@@ -51,3 +51,7 @@ properties:
format: date-time format: date-time
title: updated_at title: updated_at
description: The date the item was updated. description: The date the item was updated.
damaged_quantity:
type: number
title: damaged_quantity
description: The item's damaged quantity.
www/apps/api-reference/specs/admin/components/schemas/StoreCalculatedPrice.yaml
+10
View File
@@ -5,6 +5,8 @@ required:
- id - id
- calculated_amount - calculated_amount
- original_amount - original_amount
- original_amount_with_tax
- original_amount_without_tax
- currency_code - currency_code
properties: properties:
id: id:
@@ -120,3 +122,11 @@ properties:
type: number type: number
title: max_quantity title: max_quantity
description: The maximum quantity required in the cart for the price to apply. description: The maximum quantity required in the cart for the price to apply.
original_amount_with_tax:
type: number
title: original_amount_with_tax
description: The original amount with taxes applied.
original_amount_without_tax:
type: number
title: original_amount_without_tax
description: The original amount without taxes.
www/apps/api-reference/specs/admin/openapi.full.yaml
+40 -131
View File
@@ -12428,48 +12428,6 @@ paths:
type: string type: string
title: sales_channel_id title: sales_channel_id
description: A sales channel's ID. description: A sales channel's ID.
- name: fulfillment_status
in: query
description: Filter by the fulfillment status of the draft order.
required: false
schema:
type: array
description: Filter by the fulfillment status of the draft order.
items:
type: string
title: fulfillment_status
description: The fulfillment status's details.
enum:
- canceled
- not_fulfilled
- partially_fulfilled
- fulfilled
- partially_shipped
- shipped
- partially_delivered
- delivered
- name: payment_status
in: query
description: Filter by the payment status of the draft order.
required: false
schema:
type: array
description: Filter by the payment status of the draft order.
items:
type: string
title: payment_status
description: The payment status's details.
enum:
- canceled
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- partially_refunded
- refunded
- requires_action
- name: region_id - name: region_id
in: query in: query
description: Filter by region IDs to retrieve their associated draft orders. description: Filter by region IDs to retrieve their associated draft orders.
@@ -19174,46 +19132,6 @@ paths:
type: string type: string
title: sales_channel_id title: sales_channel_id
description: A sales channel's ID. description: A sales channel's ID.
- name: fulfillment_status
in: query
description: Filter by the order's fulfillment status.
required: false
schema:
type: array
description: Filter by the order's fulfillment status.
items:
type: string
description: A fulfillment status.
enum:
- canceled
- not_fulfilled
- partially_fulfilled
- fulfilled
- partially_shipped
- shipped
- partially_delivered
- delivered
- name: payment_status
in: query
description: Filter by the order's payment status.
required: false
schema:
type: array
description: Filter by the order's payment status.
items:
type: string
description: A payment status
enum:
- canceled
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- partially_refunded
- refunded
- requires_action
- name: region_id - name: region_id
in: query in: query
description: Filter by region IDs to retrieve their associated orders. description: Filter by region IDs to retrieve their associated orders.
@@ -33752,46 +33670,6 @@ paths:
type: string type: string
title: sales_channel_id title: sales_channel_id
description: A sales channel's ID. description: A sales channel's ID.
- name: fulfillment_status
in: query
description: Filter by fulfillment statuses.
required: false
schema:
type: array
description: Filter by fulfillment statuses.
items:
type: string
description: A fulfillment status.
enum:
- canceled
- not_fulfilled
- partially_fulfilled
- fulfilled
- partially_shipped
- shipped
- partially_delivered
- delivered
- name: payment_status
in: query
description: Filter by payment statuses.
required: false
schema:
type: array
description: Filter by payment statuses.
items:
type: string
description: A payment status.
enum:
- canceled
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- partially_refunded
- refunded
- requires_action
- name: region_id - name: region_id
in: query in: query
description: Filter by region IDs to retrieve their associated returns. description: Filter by region IDs to retrieve their associated returns.
@@ -43604,11 +43482,11 @@ paths:
operationId: PostActor_typeAuth_providerUpdate operationId: PostActor_typeAuth_providerUpdate
summary: Reset an Admin User's Password summary: Reset an Admin User's Password
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). 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/v2/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: false x-authenticated: true
parameters: parameters:
- name: auth_provider - name: auth_provider
in: path in: path
@@ -43617,12 +43495,6 @@ paths:
schema: schema:
type: string type: string
example: emailpass example: emailpass
- name: token
in: query
description: The reset password token received using the Get Reset Password API route.
required: true
schema:
type: string
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -43637,12 +43509,15 @@ paths:
- lang: Shell - lang: Shell
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/auth/user/emailpass/update?token=123' \ curl -X POST '{backend_url}/auth/user/emailpass/update' \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
-H 'Authorization: Bearer {token}' \
--data-raw '{ --data-raw '{
"email": "admin@medusa-test.com", "email": "admin@medusa-test.com",
"password": "supersecret" "password": "supersecret"
}' }'
security:
- reset_password: []
tags: tags:
- Auth - Auth
responses: responses:
@@ -55717,6 +55592,8 @@ components:
- id - id
- calculated_amount - calculated_amount
- original_amount - original_amount
- original_amount_with_tax
- original_amount_without_tax
- currency_code - currency_code
properties: properties:
id: id:
@@ -55766,6 +55643,14 @@ components:
original_price: original_price:
type: object type: object
description: The original price's details. description: The original price's details.
original_amount_with_tax:
type: number
title: original_amount_with_tax
description: The amount of the original price with taxes applied.
original_amount_without_tax:
type: number
title: original_amount_without_tax
description: The amount of the original price without taxes.
BaseCapture: BaseCapture:
type: object type: object
description: The details of a captured payment. description: The details of a captured payment.
@@ -60060,6 +59945,7 @@ components:
- id - id
- order_id - order_id
- order - order
- amount
- reference - reference
- reference_id - reference_id
- metadata - metadata
@@ -60097,6 +59983,10 @@ components:
format: date-time format: date-time
title: updated_at title: updated_at
description: The date the credit line was updated. description: The date the credit line was updated.
amount:
type: number
title: amount
description: The credit line's amount.
OrderExchange: OrderExchange:
type: object type: object
description: The order change's exchange. description: The order change's exchange.
@@ -60649,6 +60539,10 @@ components:
format: date-time format: date-time
title: updated_at title: updated_at
description: The date the item was updated. description: The date the item was updated.
damaged_quantity:
type: number
title: damaged_quantity
description: The item's damaged quantity.
OrderShippingMethod: OrderShippingMethod:
type: object type: object
description: The shipping method's details. description: The shipping method's details.
@@ -61149,6 +61043,8 @@ components:
- id - id
- calculated_amount - calculated_amount
- original_amount - original_amount
- original_amount_with_tax
- original_amount_without_tax
- currency_code - currency_code
properties: properties:
id: id:
@@ -61255,6 +61151,14 @@ components:
type: number type: number
title: max_quantity title: max_quantity
description: The maximum quantity required in the cart for the price to apply. description: The maximum quantity required in the cart for the price to apply.
original_amount_with_tax:
type: number
title: original_amount_with_tax
description: The original amount with taxes applied.
original_amount_without_tax:
type: number
title: original_amount_without_tax
description: The original amount without taxes.
StoreCart: StoreCart:
type: object type: object
description: The cart's details. description: The cart's details.
@@ -70571,3 +70475,8 @@ components:
in: cookie in: cookie
name: connect.sid name: connect.sid
x-displayName: Cookie Session ID x-displayName: Cookie Session ID
reset_password:
type: http
x-displayName: Reset Password Token
scheme: bearer
x-is-auth: false
www/apps/api-reference/specs/admin/openapi.yaml
+5
View File
@@ -1044,3 +1044,8 @@ components:
in: cookie in: cookie
name: connect.sid name: connect.sid
x-displayName: Cookie Session ID x-displayName: Cookie Session ID
reset_password:
type: http
x-displayName: Reset Password Token
scheme: bearer
x-is-auth: false
www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml
-42
View File
@@ -1170,48 +1170,6 @@ get:
type: string type: string
title: sales_channel_id title: sales_channel_id
description: A sales channel's ID. description: A sales channel's ID.
- name: fulfillment_status
in: query
description: Filter by the fulfillment status of the draft order.
required: false
schema:
type: array
description: Filter by the fulfillment status of the draft order.
items:
type: string
title: fulfillment_status
description: The fulfillment status's details.
enum:
- canceled
- not_fulfilled
- partially_fulfilled
- fulfilled
- partially_shipped
- shipped
- partially_delivered
- delivered
- name: payment_status
in: query
description: Filter by the payment status of the draft order.
required: false
schema:
type: array
description: Filter by the payment status of the draft order.
items:
type: string
title: payment_status
description: The payment status's details.
enum:
- canceled
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- partially_refunded
- refunded
- requires_action
- name: region_id - name: region_id
in: query in: query
description: Filter by region IDs to retrieve their associated draft orders. description: Filter by region IDs to retrieve their associated draft orders.
www/apps/api-reference/specs/admin/paths/admin_orders.yaml
-40
View File
@@ -126,46 +126,6 @@ get:
type: string type: string
title: sales_channel_id title: sales_channel_id
description: A sales channel's ID. description: A sales channel's ID.
- name: fulfillment_status
in: query
description: Filter by the order's fulfillment status.
required: false
schema:
type: array
description: Filter by the order's fulfillment status.
items:
type: string
description: A fulfillment status.
enum:
- canceled
- not_fulfilled
- partially_fulfilled
- fulfilled
- partially_shipped
- shipped
- partially_delivered
- delivered
- name: payment_status
in: query
description: Filter by the order's payment status.
required: false
schema:
type: array
description: Filter by the order's payment status.
items:
type: string
description: A payment status
enum:
- canceled
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- partially_refunded
- refunded
- requires_action
- name: region_id - name: region_id
in: query in: query
description: Filter by region IDs to retrieve their associated orders. description: Filter by region IDs to retrieve their associated orders.
www/apps/api-reference/specs/admin/paths/admin_returns.yaml
-40
View File
@@ -124,46 +124,6 @@ get:
type: string type: string
title: sales_channel_id title: sales_channel_id
description: A sales channel's ID. description: A sales channel's ID.
- name: fulfillment_status
in: query
description: Filter by fulfillment statuses.
required: false
schema:
type: array
description: Filter by fulfillment statuses.
items:
type: string
description: A fulfillment status.
enum:
- canceled
- not_fulfilled
- partially_fulfilled
- fulfilled
- partially_shipped
- shipped
- partially_delivered
- delivered
- name: payment_status
in: query
description: Filter by payment statuses.
required: false
schema:
type: array
description: Filter by payment statuses.
items:
type: string
description: A payment status.
enum:
- canceled
- not_paid
- awaiting
- authorized
- partially_authorized
- captured
- partially_captured
- partially_refunded
- refunded
- requires_action
- name: region_id - name: region_id
in: query in: query
description: Filter by region IDs to retrieve their associated returns. description: Filter by region IDs to retrieve their associated returns.
www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_update.yaml
+4 -9
View File
@@ -6,11 +6,12 @@ post:
Reset an admin user's password using a reset-password token generated with Reset an admin user's password using a reset-password token generated with
the [Generate Reset Password Token API the [Generate Reset Password Token API
route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword). 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: >- url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#reset-password-route https://docs.medusajs.com/v2/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: false x-authenticated: true
parameters: parameters:
- name: auth_provider - name: auth_provider
in: path in: path
@@ -19,14 +20,6 @@ post:
schema: schema:
type: string type: string
example: emailpass example: emailpass
- name: token
in: query
description: >-
The reset password token received using the Get Reset Password API
route.
required: true
schema:
type: string
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -44,6 +37,8 @@ post:
label: cURL label: cURL
source: source:
$ref: ../code_samples/Shell/auth_user_{auth_provider}_update/post.sh $ref: ../code_samples/Shell/auth_user_{auth_provider}_update/post.sh
security:
- reset_password: []
tags: tags:
- Auth - Auth
responses: responses:
www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_update/post.sh
+2 -1
View File
@@ -1,5 +1,6 @@
curl -X POST '{backend_url}/auth/customer/emailpass/update?token=123' \ curl -X POST '{backend_url}/auth/customer/emailpass/update' \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
-H 'Authorization: Bearer {token}' \
--data-raw '{ --data-raw '{
"email": "customer@gmail.com", "email": "customer@gmail.com",
"password": "supersecret" "password": "supersecret"
www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml
+10
View File
@@ -5,6 +5,8 @@ required:
- id - id
- calculated_amount - calculated_amount
- original_amount - original_amount
- original_amount_with_tax
- original_amount_without_tax
- currency_code - currency_code
properties: properties:
id: id:
@@ -59,3 +61,11 @@ properties:
original_price: original_price:
type: object type: object
description: The original price's details. description: The original price's details.
original_amount_with_tax:
type: number
title: original_amount_with_tax
description: The amount of the original price with taxes applied.
original_amount_without_tax:
type: number
title: original_amount_without_tax
description: The amount of the original price without taxes.
www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml
+5
View File
@@ -5,6 +5,7 @@ required:
- id - id
- order_id - order_id
- order - order
- amount
- reference - reference
- reference_id - reference_id
- metadata - metadata
@@ -44,3 +45,7 @@ properties:
format: date-time format: date-time
title: updated_at title: updated_at
description: The date the credit line was updated. description: The date the credit line was updated.
amount:
type: number
title: amount
description: The credit line's amount.
www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml
+4
View File
@@ -51,3 +51,7 @@ properties:
format: date-time format: date-time
title: updated_at title: updated_at
description: The date the item was updated. description: The date the item was updated.
damaged_quantity:
type: number
title: damaged_quantity
description: The item's damaged quantity.
www/apps/api-reference/specs/store/components/schemas/StoreCalculatedPrice.yaml
+10
View File
@@ -5,6 +5,8 @@ required:
- id - id
- calculated_amount - calculated_amount
- original_amount - original_amount
- original_amount_with_tax
- original_amount_without_tax
- currency_code - currency_code
properties: properties:
id: id:
@@ -120,3 +122,11 @@ properties:
type: number type: number
title: max_quantity title: max_quantity
description: The maximum quantity required in the cart for the price to apply. description: The maximum quantity required in the cart for the price to apply.
original_amount_with_tax:
type: number
title: original_amount_with_tax
description: The original amount with taxes applied.
original_amount_without_tax:
type: number
title: original_amount_without_tax
description: The original amount without taxes.
www/apps/api-reference/specs/store/openapi.full.yaml
+40 -9
View File
@@ -389,11 +389,11 @@ paths:
operationId: PostActor_typeAuth_providerUpdate operationId: PostActor_typeAuth_providerUpdate
summary: Reset a Customer's Password summary: Reset a Customer's Password
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). 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/v2/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: false x-authenticated: true
parameters: parameters:
- name: auth_provider - name: auth_provider
in: path in: path
@@ -402,12 +402,6 @@ paths:
schema: schema:
type: string type: string
example: emailpass example: emailpass
- name: token
in: query
description: The reset password token received using the Get Reset Password API route.
required: true
schema:
type: string
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -422,12 +416,15 @@ paths:
- lang: Shell - lang: Shell
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/auth/customer/emailpass/update?token=123' \ curl -X POST '{backend_url}/auth/customer/emailpass/update' \
-H 'Content-Type: application/json' \ -H 'Content-Type: application/json' \
-H 'Authorization: Bearer {token}' \
--data-raw '{ --data-raw '{
"email": "customer@gmail.com", "email": "customer@gmail.com",
"password": "supersecret" "password": "supersecret"
}' }'
security:
- reset_password: []
tags: tags:
- Auth - Auth
responses: responses:
@@ -19595,6 +19592,8 @@ components:
- id - id
- calculated_amount - calculated_amount
- original_amount - original_amount
- original_amount_with_tax
- original_amount_without_tax
- currency_code - currency_code
properties: properties:
id: id:
@@ -19644,6 +19643,14 @@ components:
original_price: original_price:
type: object type: object
description: The original price's details. description: The original price's details.
original_amount_with_tax:
type: number
title: original_amount_with_tax
description: The amount of the original price with taxes applied.
original_amount_without_tax:
type: number
title: original_amount_without_tax
description: The amount of the original price without taxes.
BaseCapture: BaseCapture:
type: object type: object
description: The details of a captured payment. description: The details of a captured payment.
@@ -23938,6 +23945,7 @@ components:
- id - id
- order_id - order_id
- order - order
- amount
- reference - reference
- reference_id - reference_id
- metadata - metadata
@@ -23975,6 +23983,10 @@ components:
format: date-time format: date-time
title: updated_at title: updated_at
description: The date the credit line was updated. description: The date the credit line was updated.
amount:
type: number
title: amount
description: The credit line's amount.
OrderExchange: OrderExchange:
type: object type: object
description: The order change's exchange. description: The order change's exchange.
@@ -24527,6 +24539,10 @@ components:
format: date-time format: date-time
title: updated_at title: updated_at
description: The date the item was updated. description: The date the item was updated.
damaged_quantity:
type: number
title: damaged_quantity
description: The item's damaged quantity.
OrderShippingMethod: OrderShippingMethod:
type: object type: object
description: The shipping method's details. description: The shipping method's details.
@@ -25027,6 +25043,8 @@ components:
- id - id
- calculated_amount - calculated_amount
- original_amount - original_amount
- original_amount_with_tax
- original_amount_without_tax
- currency_code - currency_code
properties: properties:
id: id:
@@ -25133,6 +25151,14 @@ components:
type: number type: number
title: max_quantity title: max_quantity
description: The maximum quantity required in the cart for the price to apply. description: The maximum quantity required in the cart for the price to apply.
original_amount_with_tax:
type: number
title: original_amount_with_tax
description: The original amount with taxes applied.
original_amount_without_tax:
type: number
title: original_amount_without_tax
description: The original amount without taxes.
StoreCart: StoreCart:
type: object type: object
description: The cart's details. description: The cart's details.
@@ -34445,3 +34471,8 @@ components:
x-displayName: Cookie Session ID x-displayName: Cookie Session ID
in: cookie in: cookie
name: connect.sid name: connect.sid
reset_password:
type: http
x-displayName: Reset Password Token
scheme: bearer
x-is-auth: false
www/apps/api-reference/specs/store/openapi.yaml
+5
View File
@@ -302,3 +302,8 @@ components:
x-displayName: Cookie Session ID x-displayName: Cookie Session ID
in: cookie in: cookie
name: connect.sid name: connect.sid
reset_password:
type: http
x-displayName: Reset Password Token
scheme: bearer
x-is-auth: false
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_update.yaml
+4 -9
View File
@@ -6,11 +6,12 @@ post:
Reset a customer's password using a reset-password token generated with the Reset a customer's password using a reset-password token generated with the
[Generate Reset Password Token API [Generate Reset Password Token API
route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword). 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: >- url: >-
https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#2-reset-password-page https://docs.medusajs.com/v2/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: false x-authenticated: true
parameters: parameters:
- name: auth_provider - name: auth_provider
in: path in: path
@@ -19,14 +20,6 @@ post:
schema: schema:
type: string type: string
example: emailpass example: emailpass
- name: token
in: query
description: >-
The reset password token received using the Get Reset Password API
route.
required: true
schema:
type: string
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -45,6 +38,8 @@ post:
label: cURL label: cURL
source: source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}_update/post.sh $ref: ../code_samples/Shell/auth_customer_{auth_provider}_update/post.sh
security:
- reset_password: []
tags: tags:
- Auth - Auth
responses: responses:
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts
-42
View File
@@ -922,48 +922,6 @@
* type: string * type: string
* title: sales_channel_id * title: sales_channel_id
* description: A sales channel's ID. * description: A sales channel's ID.
* - name: fulfillment_status
* in: query
* description: Filter by the fulfillment status of the draft order.
* required: false
* schema:
* type: array
* description: Filter by the fulfillment status of the draft order.
* items:
* type: string
* title: fulfillment_status
* description: The fulfillment status's details.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by the payment status of the draft order.
* required: false
* schema:
* type: array
* description: Filter by the payment status of the draft order.
* items:
* type: string
* title: payment_status
* description: The payment status's details.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id * - name: region_id
* in: query * in: query
* description: Filter by region IDs to retrieve their associated draft orders. * description: Filter by region IDs to retrieve their associated draft orders.
www/utils/generated/oas-output/operations/admin/get_admin_orders.ts
-40
View File
@@ -104,46 +104,6 @@
* type: string * type: string
* title: sales_channel_id * title: sales_channel_id
* description: A sales channel's ID. * description: A sales channel's ID.
* - name: fulfillment_status
* in: query
* description: Filter by the order's fulfillment status.
* required: false
* schema:
* type: array
* description: Filter by the order's fulfillment status.
* items:
* type: string
* description: A fulfillment status.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by the order's payment status.
* required: false
* schema:
* type: array
* description: Filter by the order's payment status.
* items:
* type: string
* description: A payment status
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id * - name: region_id
* in: query * in: query
* description: Filter by region IDs to retrieve their associated orders. * description: Filter by region IDs to retrieve their associated orders.
www/utils/generated/oas-output/operations/admin/get_admin_returns.ts
-40
View File
@@ -104,46 +104,6 @@
* type: string * type: string
* title: sales_channel_id * title: sales_channel_id
* description: A sales channel's ID. * description: A sales channel's ID.
* - name: fulfillment_status
* in: query
* description: Filter by fulfillment statuses.
* required: false
* schema:
* type: array
* description: Filter by fulfillment statuses.
* items:
* type: string
* description: A fulfillment status.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by payment statuses.
* required: false
* schema:
* type: array
* description: Filter by payment statuses.
* items:
* type: string
* description: A payment status.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id * - name: region_id
* in: query * in: query
* description: Filter by region IDs to retrieve their associated returns. * description: Filter by region IDs to retrieve their associated returns.
www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts
+10
View File
@@ -7,6 +7,8 @@
* - id * - id
* - calculated_amount * - calculated_amount
* - original_amount * - original_amount
* - original_amount_with_tax
* - original_amount_without_tax
* - currency_code * - currency_code
* properties: * properties:
* id: * id:
@@ -56,6 +58,14 @@
* original_price: * original_price:
* type: object * type: object
* description: The original price's details. * description: The original price's details.
* original_amount_with_tax:
* type: number
* title: original_amount_with_tax
* description: The amount of the original price with taxes applied.
* original_amount_without_tax:
* type: number
* title: original_amount_without_tax
* description: The amount of the original price without taxes.
* *
*/ */
www/utils/generated/oas-output/schemas/OrderCreditLine.ts
+5
View File
@@ -7,6 +7,7 @@
* - id * - id
* - order_id * - order_id
* - order * - order
* - amount
* - reference * - reference
* - reference_id * - reference_id
* - metadata * - metadata
@@ -44,6 +45,10 @@
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The date the credit line was updated. * description: The date the credit line was updated.
* amount:
* type: number
* title: amount
* description: The credit line's amount.
* *
*/ */
www/utils/generated/oas-output/schemas/OrderReturnItem.ts
+4
View File
@@ -51,6 +51,10 @@
* format: date-time * format: date-time
* title: updated_at * title: updated_at
* description: The date the item was updated. * description: The date the item was updated.
* damaged_quantity:
* type: number
* title: damaged_quantity
* description: The item's damaged quantity.
* *
*/ */
www/utils/generated/oas-output/schemas/StoreCalculatedPrice.ts
+10
View File
@@ -7,6 +7,8 @@
* - id * - id
* - calculated_amount * - calculated_amount
* - original_amount * - original_amount
* - original_amount_with_tax
* - original_amount_without_tax
* - currency_code * - currency_code
* properties: * properties:
* id: * id:
@@ -113,6 +115,14 @@
* type: number * type: number
* title: max_quantity * title: max_quantity
* description: The maximum quantity required in the cart for the price to apply. * description: The maximum quantity required in the cart for the price to apply.
* original_amount_with_tax:
* type: number
* title: original_amount_with_tax
* description: The original amount with taxes applied.
* original_amount_without_tax:
* type: number
* title: original_amount_without_tax
* description: The original amount without taxes.
* *
*/ */