ae017c4657
* chore(docs): Generated API Reference (#3761) Co-authored-by: shahednasser <shahednasser@users.noreply.github.com> * docs: fix typo (#3771) --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: shahednasser <shahednasser@users.noreply.github.com> Co-authored-by: Andre Schweighofer <fidrelity@users.noreply.github.com>
159 lines
4.2 KiB
YAML
159 lines
4.2 KiB
YAML
get:
|
|
operationId: GetReservations
|
|
summary: List Reservations
|
|
description: Retrieve a list of Reservations.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: query
|
|
name: location_id
|
|
style: form
|
|
explode: false
|
|
description: Location ids to search for.
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
- in: query
|
|
name: inventory_item_id
|
|
style: form
|
|
explode: false
|
|
description: Inventory Item ids to search for.
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
- in: query
|
|
name: line_item_id
|
|
style: form
|
|
explode: false
|
|
description: Line Item ids to search for.
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
- in: query
|
|
name: quantity
|
|
description: Filter by reservation quantity
|
|
schema:
|
|
type: object
|
|
properties:
|
|
lt:
|
|
type: number
|
|
description: filter by reservation quantity less than this number
|
|
gt:
|
|
type: number
|
|
description: filter by reservation quantity greater than this number
|
|
lte:
|
|
type: number
|
|
description: filter by reservation quantity less than or equal to this number
|
|
gte:
|
|
type: number
|
|
description: >-
|
|
filter by reservation quantity greater than or equal to this
|
|
number
|
|
- in: query
|
|
name: offset
|
|
description: How many Reservations to skip in the result.
|
|
schema:
|
|
type: integer
|
|
default: 0
|
|
- in: query
|
|
name: limit
|
|
description: Limit the number of Reservations returned.
|
|
schema:
|
|
type: integer
|
|
default: 20
|
|
- in: query
|
|
name: expand
|
|
description: >-
|
|
(Comma separated) Which fields should be expanded in the product
|
|
category.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: fields
|
|
description: >-
|
|
(Comma separated) Which fields should be included in the product
|
|
category.
|
|
schema:
|
|
type: string
|
|
x-codegen:
|
|
method: list
|
|
queryParams: AdminGetReservationsParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_reservations/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_reservations/get.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Reservations
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminReservationsListRes.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: PostReservations
|
|
summary: Create a Reservation
|
|
description: Create a Reservation which can be associated with any resource as required.
|
|
x-authenticated: true
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminPostReservationsReq.yaml
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_reservations/post.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_reservations/post.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Reservations
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminReservationsRes.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
|