chore(docs): Generated API Reference (v2) (#8668)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
fa44e3f5a8
commit
cb2ead3a1c
@@ -11902,7 +11902,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AdminOrderResponse'
|
||||
$ref: '#/components/schemas/AdminOrderEditResponse'
|
||||
'400':
|
||||
$ref: '#/components/responses/400_error'
|
||||
'401':
|
||||
@@ -12199,6 +12199,112 @@ paths:
|
||||
'500':
|
||||
$ref: '#/components/responses/500_error'
|
||||
x-workflow: orderEditAddNewItemWorkflow
|
||||
/admin/order-edits/{id}/items/item/{item_id}:
|
||||
post:
|
||||
operationId: PostOrderEditsIdItemsItemItem_id
|
||||
summary: Add Items to Order Edit
|
||||
description: Add a list of items to a order edit.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The order edit's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: item_id
|
||||
in: path
|
||||
description: The order edit's item id.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
- name: order
|
||||
in: query
|
||||
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema'
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source: |-
|
||||
curl -X POST '{backend_url}/admin/order-edits/{id}/items/item/{item_id}' \
|
||||
-H 'x-medusa-access-token: {api_token}' \
|
||||
-H 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"quantity": 7564330046324736
|
||||
}'
|
||||
tags:
|
||||
- Order Edits
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/AdminOrderEditPreviewResponse'
|
||||
'400':
|
||||
$ref: '#/components/responses/400_error'
|
||||
'401':
|
||||
$ref: '#/components/responses/unauthorized'
|
||||
'404':
|
||||
$ref: '#/components/responses/not_found_error'
|
||||
'409':
|
||||
$ref: '#/components/responses/invalid_state_error'
|
||||
'422':
|
||||
$ref: '#/components/responses/invalid_request_error'
|
||||
'500':
|
||||
$ref: '#/components/responses/500_error'
|
||||
x-workflow: orderEditUpdateItemQuantityWorkflow
|
||||
/admin/order-edits/{id}/items/{action_id}:
|
||||
post:
|
||||
operationId: PostOrderEditsIdItemsAction_id
|
||||
@@ -13752,18 +13858,12 @@ paths:
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
- name: fields
|
||||
in: query
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: fields
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
* without prefix it will replace the entire default fields.
|
||||
description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
@@ -46899,6 +46999,15 @@ components:
|
||||
properties:
|
||||
order_preview:
|
||||
$ref: '#/components/schemas/OrderPreview'
|
||||
AdminOrderEditResponse:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminOrderEditResponse
|
||||
required:
|
||||
- order_change
|
||||
properties:
|
||||
order_change:
|
||||
$ref: '#/components/schemas/OrderChange'
|
||||
AdminOrderPreview:
|
||||
type: object
|
||||
description: The return's order preview.
|
||||
@@ -48303,6 +48412,21 @@ components:
|
||||
metadata:
|
||||
type: object
|
||||
description: The order edit's metadata.
|
||||
AdminPostOrderEditsUpdateItemQuantityReqSchema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminPostOrderEditsUpdateItemQuantityReqSchema
|
||||
required:
|
||||
- quantity
|
||||
properties:
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
description: The order edit's quantity.
|
||||
internal_note:
|
||||
type: string
|
||||
title: internal_note
|
||||
description: The order edit's internal note.
|
||||
AdminPostOrderExchangesReqSchema:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -55114,7 +55238,7 @@ components:
|
||||
x-schemaName: OrderLineItemTaxLine
|
||||
OrderPreview:
|
||||
type: object
|
||||
description: The exchange's order preview.
|
||||
description: The order edit's order preview.
|
||||
x-schemaName: OrderPreview
|
||||
required:
|
||||
- order_change
|
||||
|
||||
Reference in New Issue
Block a user