REST Order Currency

Provides access to currencies and countries supporting the currency.

List currencies

/rest/orders/currencies

Parameters

Field	Type	Description
columns	`String[]`	The attributes to be loaded
with	`String[]`	The relations to be loaded. Valid relations are 'names' or 'countries'.

Success 200

Response is a List

Field	Type	Description
`currency`	`String`	The ISO 4217 code and id of the currency.
`htmlCode`	`String`	The html code (entity) for the currency.
`unicodeSign`	`String`	The unicode symbol for the currency. If no unicode symbol exists, the html code will be used.
`isActive`	`Bool`	Flag that indicates if the currency is active in the system or not. Currencies are activated per sales price.
`isErasable`	`Bool`	Flag that indicates if this currency can be deleted or not. False = Currency cannot be deleted True = Currency can be deleted

Response (example)

[{"currency":"MMK","htmlCode":"html_MMK","unicodeSign":"sign_MMK","isActive":false,"isErasable":false},{"currency":"MWK","htmlCode":"html_MWK","unicodeSign":"sign_MWK","isActive":true,"isErasable":true}]

Errors 4xx

Code	Exception	Description
401	`League\OAuth2\Server\Exception\AccessDeniedException`	The resource owner or authorization server denied the request.
401	`League\OAuth2\Server\Exception\InvalidRequestException`	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a currency

Get a currency. The ISO 4217 code of the currency must be specified.

/rest/orders/currencies/{currencyIso}

Parameters

Field	Type	Description
currencyIso	`String`	The ISO 4217 code of the currency
columns	`String[]`	The attributes to be loaded
with	`String[]`	The relations to be loaded. Valid relations are 'names' or 'countries'

Success 200

Field	Type	Description
`currency`	`String`	The ISO 4217 code and id of the currency.
`htmlCode`	`String`	The html code (entity) for the currency.
`unicodeSign`	`String`	The unicode symbol for the currency. If no unicode symbol exists, the html code will be used.
`isActive`	`Bool`	Flag that indicates if the currency is active in the system or not. Currencies are activated per sales price.
`isErasable`	`Bool`	Flag that indicates if this currency can be deleted or not. False = Currency cannot be deleted True = Currency can be deleted

Response (example)

{"currency":"LAK","htmlCode":"html_LAK","unicodeSign":"sign_LAK","isActive":true,"isErasable":false}

Errors 4xx

Code	Exception	Description
401	`League\OAuth2\Server\Exception\AccessDeniedException`	The resource owner or authorization server denied the request.
401	`League\OAuth2\Server\Exception\InvalidRequestException`	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List countries for a currency

List countries for a currency. The ISO 4271 code of the currency must be specified.

/rest/orders/currencies/{currencyIso}/countries

Parameters

Field	Type	Description
currencyIso	`String`	The ISO 4217 code of the currency
columns	`String[]`	The attributes to be loaded

Success 200

Response is a List

Field	Type	Description
`id`	`Int`	The country id.
`name`	`String`	The system country name.
`shippingDestinationId`	`Int`	The shipping destination (region) id.
`active`	`Int`	The active flag (1: active, 2: backend active, 3: supplier active
`storehouseId`	`Int`	The id of the main warehouse in this country.
`isoCode2`	`String`	The ISO 3166 ALPHA-2 code of the country.
`isoCode3`	`String`	The ISO 3166 ALPHA-3 code of the country.
`lang`	`String`	The main language spoken in the country.
`isCountryStateMandatory`	`Bool`	Flag that states if a country state is mandatory for the country.

Response (example)

[{"id":1,"name":"Germany","shippingDestinationId":149,"active":0,"storehouseId":18,"isoCode2":"DE","isoCode3":"DEU","lang":"de","isCountryStateMandatory":false},{"id":1,"name":"Germany","shippingDestinationId":159,"active":3,"storehouseId":23,"isoCode2":"DE","isoCode3":"DEU","lang":"de","isCountryStateMandatory":false}]

Errors 4xx

Code	Exception	Description
401	`League\OAuth2\Server\Exception\AccessDeniedException`	The resource owner or authorization server denied the request.
401	`League\OAuth2\Server\Exception\InvalidRequestException`	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a currency for a country

Get a currency for a country. The ID of the country must be specified.

/rest/orders/currencies/countries/{countryId}

Parameters

Field	Type	Description
columns	`String[]`	The attributes to be loaded
with	`String[]`	The relations to be loaded. Valid relations are 'names' or 'countries').

Success 200

Field	Type	Description
`currency`	`String`	The ISO 4217 code and id of the currency.
`htmlCode`	`String`	The html code (entity) for the currency.
`unicodeSign`	`String`	The unicode symbol for the currency. If no unicode symbol exists, the html code will be used.
`isActive`	`Bool`	Flag that indicates if the currency is active in the system or not. Currencies are activated per sales price.
`isErasable`	`Bool`	Flag that indicates if this currency can be deleted or not. False = Currency cannot be deleted True = Currency can be deleted

Response (example)

{"currency":"KWD","htmlCode":"html_KWD","unicodeSign":"sign_KWD","isActive":true,"isErasable":false}

Errors 4xx

Code	Exception	Description
401	`League\OAuth2\Server\Exception\AccessDeniedException`	The resource owner or authorization server denied the request.
401	`League\OAuth2\Server\Exception\InvalidRequestException`	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.