chore(docs): Updated API Reference (automated) (#11719)
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]
committed by
GitHub
GitHub
parent
8a36bd4034
commit
6294a71296
@@ -12428,48 +12428,6 @@ paths:
|
||||
type: string
|
||||
title: sales_channel_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
|
||||
in: query
|
||||
description: Filter by region IDs to retrieve their associated draft orders.
|
||||
@@ -19174,46 +19132,6 @@ paths:
|
||||
type: string
|
||||
title: sales_channel_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
|
||||
in: query
|
||||
description: Filter by region IDs to retrieve their associated orders.
|
||||
@@ -33752,46 +33670,6 @@ paths:
|
||||
type: string
|
||||
title: sales_channel_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
|
||||
in: query
|
||||
description: Filter by region IDs to retrieve their associated returns.
|
||||
@@ -43604,11 +43482,11 @@ paths:
|
||||
operationId: PostActor_typeAuth_providerUpdate
|
||||
summary: Reset an Admin User's 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:
|
||||
url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#reset-password-route
|
||||
description: Learn more about this API route.
|
||||
x-authenticated: false
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: auth_provider
|
||||
in: path
|
||||
@@ -43617,12 +43495,6 @@ paths:
|
||||
schema:
|
||||
type: string
|
||||
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:
|
||||
content:
|
||||
application/json:
|
||||
@@ -43637,12 +43509,15 @@ paths:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
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 'Authorization: Bearer {token}' \
|
||||
--data-raw '{
|
||||
"email": "admin@medusa-test.com",
|
||||
"password": "supersecret"
|
||||
}'
|
||||
security:
|
||||
- reset_password: []
|
||||
tags:
|
||||
- Auth
|
||||
responses:
|
||||
@@ -55717,6 +55592,8 @@ components:
|
||||
- id
|
||||
- calculated_amount
|
||||
- original_amount
|
||||
- original_amount_with_tax
|
||||
- original_amount_without_tax
|
||||
- currency_code
|
||||
properties:
|
||||
id:
|
||||
@@ -55766,6 +55643,14 @@ components:
|
||||
original_price:
|
||||
type: object
|
||||
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:
|
||||
type: object
|
||||
description: The details of a captured payment.
|
||||
@@ -60060,6 +59945,7 @@ components:
|
||||
- id
|
||||
- order_id
|
||||
- order
|
||||
- amount
|
||||
- reference
|
||||
- reference_id
|
||||
- metadata
|
||||
@@ -60097,6 +59983,10 @@ components:
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date the credit line was updated.
|
||||
amount:
|
||||
type: number
|
||||
title: amount
|
||||
description: The credit line's amount.
|
||||
OrderExchange:
|
||||
type: object
|
||||
description: The order change's exchange.
|
||||
@@ -60649,6 +60539,10 @@ components:
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The date the item was updated.
|
||||
damaged_quantity:
|
||||
type: number
|
||||
title: damaged_quantity
|
||||
description: The item's damaged quantity.
|
||||
OrderShippingMethod:
|
||||
type: object
|
||||
description: The shipping method's details.
|
||||
@@ -61149,6 +61043,8 @@ components:
|
||||
- id
|
||||
- calculated_amount
|
||||
- original_amount
|
||||
- original_amount_with_tax
|
||||
- original_amount_without_tax
|
||||
- currency_code
|
||||
properties:
|
||||
id:
|
||||
@@ -61255,6 +61151,14 @@ components:
|
||||
type: number
|
||||
title: max_quantity
|
||||
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:
|
||||
type: object
|
||||
description: The cart's details.
|
||||
@@ -70571,3 +70475,8 @@ components:
|
||||
in: cookie
|
||||
name: connect.sid
|
||||
x-displayName: Cookie Session ID
|
||||
reset_password:
|
||||
type: http
|
||||
x-displayName: Reset Password Token
|
||||
scheme: bearer
|
||||
x-is-auth: false
|
||||
|
||||
Reference in New Issue
Block a user