55 lines
1.3 KiB
YAML
55 lines
1.3 KiB
YAML
get:
|
|
operationId: GetCurrencies
|
|
summary: List Currency
|
|
description: Retrieves a list of Currency
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: query
|
|
name: code
|
|
description: Code of the currency to search for.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: includes_tax
|
|
description: Search for tax inclusive currencies.
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: order
|
|
description: order to retrieve products in.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: offset
|
|
description: How many products to skip in the result.
|
|
schema:
|
|
type: number
|
|
default: '0'
|
|
- in: query
|
|
name: limit
|
|
description: Limit the number of products returned.
|
|
schema:
|
|
type: number
|
|
default: '20'
|
|
x-codegen:
|
|
method: list
|
|
queryParams: AdminGetCurrenciesParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_currencies/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_currencies/get.sh
|
|
tags:
|
|
- Currencies
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminCurrenciesListRes.yaml
|