156 lines
4.2 KiB
YAML
156 lines
4.2 KiB
YAML
get:
|
|
operationId: GetStockLocationsStockLocation
|
|
summary: Get a Stock Location
|
|
description: Retrieves the Stock Location.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the Stock Location.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: expand
|
|
description: Comma separated list of relations to include in the results.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: fields
|
|
description: Comma separated list of fields to include in the results.
|
|
schema:
|
|
type: string
|
|
x-codegen:
|
|
method: retrieve
|
|
queryParams: AdminGetStockLocationsLocationParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_stock-locations_{id}/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_stock-locations_{id}/get.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Stock Locations
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminStockLocationsRes.yaml
|
|
post:
|
|
operationId: PostStockLocationsStockLocation
|
|
summary: Update a Stock Location
|
|
description: Updates a Stock Location.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the Stock Location.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: expand
|
|
description: Comma separated list of relations to include in the results.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: fields
|
|
description: Comma separated list of fields to include in the results.
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminPostStockLocationsLocationReq.yaml
|
|
x-codegen:
|
|
method: update
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_stock-locations_{id}/post.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_stock-locations_{id}/post.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Stock Locations
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminStockLocationsRes.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
|
|
delete:
|
|
operationId: DeleteStockLocationsStockLocation
|
|
summary: Delete a Stock Location
|
|
description: Delete a Stock Location
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the Stock Location to delete.
|
|
schema:
|
|
type: string
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_stock-locations_{id}/delete.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_stock-locations_{id}/delete.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Stock Locations
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the deleted Stock Location.
|
|
object:
|
|
type: string
|
|
description: The type of the object that was deleted.
|
|
format: stock_location
|
|
deleted:
|
|
type: boolean
|
|
description: Whether or not the Stock Location was deleted.
|
|
default: true
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|