Files
medusa-store/docs/api/admin/paths/admin_sales-channels_{id}_stock-locations.yaml
Shahed Nasser ae017c4657 chore(docs): merge changes from master (#3780)
* 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>
2023-04-10 11:15:54 +03:00

111 lines
3.0 KiB
YAML

post:
operationId: PostSalesChannelsSalesChannelStockLocation
summary: Associate a Stock Location
description: Associates a stock location with a Sales Channel.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Sales Channel.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: >-
../components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml
x-codegen:
method: addLocation
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_sales-channels_{id}_stock-locations/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Sales Channels
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminSalesChannelsRes.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: DeleteSalesChannelsSalesChannelStockLocation
summary: Remove a Stock Location Association
description: Removes a stock location from a Sales Channel.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Sales Channel.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: >-
../components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml
x-codegen:
method: removeLocation
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_sales-channels_{id}_stock-locations/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Sales Channels
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminSalesChannelsDeleteLocationRes.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