Files
medusa-store/docs/api/admin/paths/store_currencies_{code}.yaml
2022-09-13 10:59:51 +03:00

101 lines
2.8 KiB
YAML

post:
operationId: PostStoreCurrenciesCode
summary: Add a Currency Code
description: Adds a Currency Code to the available currencies.
x-authenticated: true
parameters:
- in: path
name: code
required: true
description: The 3 character ISO currency code.
schema:
type: string
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
description: See a list of codes.
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_currencies_{code}/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/store_currencies_{code}/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Store
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
store:
$ref: ../components/schemas/store.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: DeleteStoreCurrenciesCode
summary: Delete a Currency Code
description: Removes a Currency Code from the available currencies.
x-authenticated: true
parameters:
- in: path
name: code
required: true
description: The 3 character ISO currency code.
schema:
type: string
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
description: See a list of codes.
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_currencies_{code}/deleteundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/store_currencies_{code}/deleteundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Store
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
store:
$ref: ../components/schemas/store.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