List Currencies

GET

/store/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.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/store/currencies' \
--header 'x-publishable-api-key;'

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "estimate_count": 0,
    "currencies": [
        {
            "code": "usd",
            "symbol": "string",
            "symbol_native": "string",
            "name": "string",
            "decimal_digits": 0,
            "rounding": 0,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z"
        }
    ]
}

Request

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

optional

Search term to filter the currency's searchable properties.

code

optional

One of

code

array[string]

Filter by a currency code.

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Header Params

x-publishable-api-key

string

required

Publishable API Key created in the Medusa Admin.

Responses

🟢200OK

application/json

Body

The paginated list of currencies.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total count of items.

estimate_count

number

estimate_count

optional

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.

currencies

array[object (StoreCurrency) {9}]

required

The list of currencies.

code

string

code

required

The currency's code.

Example:

usd

symbol

string

symbol

required

The currency's symbol.

symbol_native

string

symbol_native

required

The currency's symbol native.

name

string

name

required

The currency's name.

decimal_digits

number

decimal_digits

required

The currency's decimal digits.

rounding

number

rounding

required

The currency's rounding.

created_at

string <date-time>

created_at

required

The date the currency was created.

updated_at

string <date-time>

updated_at

required

The date the currency was updated.

deleted_at

string <date-time>

deleted_at

required

The date the currency was deleted.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:21:30

Pagination

Get a Currency