List Currency

GET

/admin/currencies

Currencies

Retrieve a list of currencies. The currencies can be filtered by fields such as code. The currencies can also be sorted or paginated.

Response Example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "currencies": [
    {
      "symbol": "$",
      "symbol_native": "$",
      "name": "US Dollar",
      "includes_tax": false,
      "code": "usd"
    }
  ]
}

Request

Query Params

code

string

optional

filter by currency code.

includes_tax

string

optional

filter currencies by whether they include taxes or not.

order

string

optional

A field to sort order the retrieved currencies by.

offset

number

optional

The number of currencies to skip when retrieving the currencies.

limit

number

optional

The number of currencies to return.

Responses

🟢200OK

application/json

Body

count

integer

required

The total number of items available

offset

integer

required

The number of currencies skipped when retrieving the currencies.

limit

integer

required

The number of items per page

currencies

array[object (Currency) {5}]

required

An array of currency details.

symbol

string

required

The symbol used to indicate the currency.

Example:

symbol_native

string

required

The native symbol used to indicate the currency.

Example:

name

string

required

The written name of the currency

Example:

US Dollar

includes_tax

boolean

optional

Whether the currency prices include tax

Default:

false

code

string

required

The 3 character ISO code for the currency.

Example:

usd

Modified at 2023-10-10 11:56:36

Create a Batch Job

Update a Currency