Locales > Currencies > currenciesModify
Commerce APILocalesCurrenciescurrenciesModify
currenciesModify
POST:currencies.json

Description

Modify shop currencies.

You cannot disable shop's primary currency.

Permission bit: "currencies.modify"

Topic: Currencies

Arguments

data: [CurrencyModify!]!

Main argument for mutations.


ids: [String!]!

List of currency ids. See also: Unique Identifiers


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

conversion_fee: Float

Additional fee to add when converting to and from this currency (in percents)

Example: 5.5

Valid when: conversion_fee is valid percentage, i.e.: 0 ≤ conversion_fee ≤ 100


custom_exchange_rate: Float

Custom exchange rate to use when converting from primary to this currency

Example: 5.1231237

Valid when: custom_exchange_rate is a non-negative float


enabled: Boolean

Whether it's allowed to place orders in this currency

Example: false


format: CurrencyFormatCreate

Currency formatting options


Result

[Currency!]

Preview (typescript)

Loading module