chore(docs): Updated API Reference (automated) (#12461)
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:
committed by
GitHub
parent
5c36bafc1d
commit
c6c660c4d3
@@ -76,4 +76,15 @@ post:
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: transferCartCustomerWorkflow
|
||||
x-events: []
|
||||
x-events:
|
||||
- name: cart.customer_transferred
|
||||
payload: |-
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
customer_id, // The ID of the customer
|
||||
}
|
||||
```
|
||||
description: Emitted when the customer in the cart is transferred.
|
||||
deprecated: false
|
||||
version: 2.8.0
|
||||
|
||||
@@ -1,10 +1,19 @@
|
||||
post:
|
||||
operationId: PostReturn
|
||||
operationId: PostReturns
|
||||
summary: Create Return
|
||||
description: >-
|
||||
Create a return for an order's items. The admin receives the return and
|
||||
process it from their side.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: x-publishable-api-key
|
||||
in: header
|
||||
description: Publishable API Key created in the Medusa Admin.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
@@ -14,9 +23,9 @@ post:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_return/post.sh
|
||||
$ref: ../code_samples/Shell/store_returns/post.sh
|
||||
tags:
|
||||
- Return
|
||||
- Returns
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
@@ -37,12 +46,25 @@ post:
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createAndCompleteReturnOrderWorkflow
|
||||
parameters:
|
||||
- name: x-publishable-api-key
|
||||
in: header
|
||||
description: Publishable API Key created in the Medusa Admin.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||
x-events:
|
||||
- name: order.return_requested
|
||||
payload: |-
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
description: Emitted when a return request is confirmed.
|
||||
deprecated: false
|
||||
- name: order.return_received
|
||||
payload: |-
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
description: Emitted when a return is marked as received.
|
||||
deprecated: false
|
||||
x-version: 2.8.0
|
||||
Reference in New Issue
Block a user