A currency format. Contains formatting information on a currency.
com.ibm.commerce.rest.store.handler.CurrencyFormatHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/currency_format?q={q} | Finds currency formats by a query. See each query for details on input and output. |
GET | /store/{storeId}/currency_format?q=byCurrency | Finds a currency format by its currency. |
Finds currency formats by a query. See each query for details on input and output.
findByQuery
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Finds a currency format by its currency.
findByCurrency
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
numberUsage | The number usage. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.common.beans.StoreCurrencyFormatDescriptionDataBean_IBM_Store_Details
GET /wcs/resources/store/10001/currency_format?currency=USD&q=byCurrency&numberUsage=-1&langId=-1&responseFormat=json
200
{ "resultList": [ { "currencyCode": "USD", "currencySymbol": "$", "decimalPlaces": "2", "langId": "-1", "numberUsage": "-1", "storeId": "10001" } ] }
Name | Data Type | Required |
---|---|---|
numberUsage | string | false |
langId | string | false |
currencySymbol | string | false |
storeId | string | false |
decimalPlaces | string | false |
currencyCode | string | false |