62 lines
1.6 KiB
YAML
62 lines
1.6 KiB
YAML
get:
|
|
operationId: GetCurrencies
|
|
summary: List Currency
|
|
description: >-
|
|
Retrieve a list of currencies. The currencies can be filtered by fields such
|
|
as `code`. The currencies can also be sorted or paginated.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: query
|
|
name: code
|
|
description: filter by currency code.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: includes_tax
|
|
description: filter currencies by whether they include taxes or not.
|
|
schema:
|
|
type: boolean
|
|
x-featureFlag: tax_inclusive_pricing
|
|
- in: query
|
|
name: order
|
|
description: A field to sort order the retrieved currencies by.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: offset
|
|
description: The number of currencies to skip when retrieving the currencies.
|
|
schema:
|
|
type: number
|
|
default: '0'
|
|
- in: query
|
|
name: limit
|
|
description: The number of currencies to return.
|
|
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
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
- jwt_token: []
|
|
tags:
|
|
- Currencies
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminCurrenciesListRes.yaml
|