Skip to content
You are reading the pinned copy of v1.0, which is also the latest release. Read the latest.

Currencies (admin API)

Admin routes of the currencies module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.

List currencies with enabled/default flags

Responses:

  • 200: Currencies retrieved.

Bulk update enabled currencies + default

Request body: UpdateEnabledCurrenciesDto.

Responses:

  • 200: Updated.
  • 400: Empty enabled list or default not in enabled set.

Store display currency + enabled set (any staff role)

Responses:

  • 200: Store currency retrieved.
  • 403: Customer session — not a staff role.
  • enabled (array of "AED", "AUD", "BHD", "BRL", "CAD", "CHF", "CNY", "EGP", "EUR", "GBP", "INR", "JOD", "JPY", "KWD", "LYD", "MXN", "OMR", "QAR", "SAR", "SEK", "SGD", "TND", "USD", required).
  • defaultCode ("AED", "AUD", "BHD", "BRL", "CAD", "CHF", "CNY", "EGP", "EUR", "GBP", "INR", "JOD", "JPY", "KWD", "LYD", "MXN", "OMR", "QAR", "SAR", "SEK", "SGD", "TND", "USD", optional).
As seen on Open Source Alternatives The Merchant Engine badge