CurrenciesResource


Create a currency


POST https://example.com/api/config/currencies

Roles : [ROLE_PRICING_MANAGE]

Content-Type : currency Accept : currency

Example

List currencies


GET https://example.com/api/config/currencies

Roles : [ROLE_PRICING_VIEW]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String name Order by
has String If present filter to apply in the search.
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)
limit Integer 25 The number of entities to retrieve

Accept : currencies

Example

Delete a currency


Delete a currency. You must have at least one currency, so if you try to delete a currency and it is the only one, you will get an error message.

DELETE https://example.com/api/config/currencies/{currency}

Roles : [ROLE_PRICING_MANAGE]

Example

Get a currency


GET https://example.com/api/config/currencies/{currency}

Roles : [ROLE_PRICING_VIEW]

Accept : currency

Error Codes

  • CURRENCY-0 - The requested currency does not exist

Example

Update a currency


Update a currency for the pricing feature.

PUT https://example.com/api/config/currencies/{currency}

Roles : [ROLE_PRICING_MANAGE]

Content-Type : currency Accept : currency

Example