chore(docs): Generated API Reference (#3718)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
51d0b88404
commit
70435d5631
106
docs/api/admin/paths/admin_draft-orders.yaml
Normal file
106
docs/api/admin/paths/admin_draft-orders.yaml
Normal file
@@ -0,0 +1,106 @@
|
||||
get:
|
||||
operationId: GetDraftOrders
|
||||
summary: List Draft Orders
|
||||
description: Retrieves an list of Draft Orders
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: offset
|
||||
description: The number of items to skip before the results.
|
||||
schema:
|
||||
type: number
|
||||
default: '0'
|
||||
- in: query
|
||||
name: limit
|
||||
description: Limit the number of items returned.
|
||||
schema:
|
||||
type: number
|
||||
default: '50'
|
||||
- in: query
|
||||
name: q
|
||||
description: >-
|
||||
a search term to search emails in carts associated with draft orders and
|
||||
display IDs of draft orders
|
||||
schema:
|
||||
type: string
|
||||
x-codegen:
|
||||
method: list
|
||||
queryParams: AdminGetDraftOrdersParams
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders/get.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders/get.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Draft Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDraftOrdersListRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
post:
|
||||
operationId: PostDraftOrders
|
||||
summary: Create a Draft Order
|
||||
description: Creates a Draft Order
|
||||
x-authenticated: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminPostDraftOrdersReq.yaml
|
||||
x-codegen:
|
||||
method: create
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source:
|
||||
$ref: ../code_samples/JavaScript/admin_draft-orders/post.js
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_draft-orders/post.sh
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Draft Orders
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminDraftOrdersRes.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
$ref: ../components/responses/unauthorized.yaml
|
||||
'404':
|
||||
$ref: ../components/responses/not_found_error.yaml
|
||||
'409':
|
||||
$ref: ../components/responses/invalid_state_error.yaml
|
||||
'422':
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
Reference in New Issue
Block a user