currency_format

A currency format. Contains formatting information on a currency.

Handler Class:

com.ibm.commerce.rest.store.handler.CurrencyFormatHandler

Method Summary

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.

Method Details

GET /store/{storeId}/currency_format?q={q}

Finds currency formats by a query. See each query for details on input and output.

Handler Method:

findByQuery

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:

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 Codes:

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.

GET /store/{storeId}/currency_format?q=byCurrency

Finds a currency format by its currency.

Handler Method:

findByCurrency

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:

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 Codes:

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.

Response Data Type:

com.ibm.commerce.common.beans.StoreCurrencyFormatDescriptionDataBean_IBM_Store_Details

Example

Request:

GET /wcs/resources/store/10001/currency_format?currency=USD&q=byCurrency&numberUsage=-1&langId=-1&responseFormat=json

HTTP Status Code:

200

Response:

{
	"resultList": [
		{
			"currencyCode": "USD",
			"currencySymbol": "$",
			"decimalPlaces": "2",
			"langId": "-1",
			"numberUsage": "-1",
			"storeId": "10001"
		}
	]
}

Data Type Details

com.ibm.commerce.common.beans.StoreCurrencyFormatDescriptionDataBean_IBM_Store_Details

Properties:

Name	Data Type	Required
numberUsage	string	false
langId	string	false
currencySymbol	string	false
storeId	string	false
decimalPlaces	string	false
currencyCode	string	false