display_price

This class provides RESTful services to get display price(list price) for catalog entry. It uses the DisplayPrice noun.

Handler Class:

com.ibm.commerce.rest.price.handler.DisplayPriceHandler

Method Summary

HTTP Method	Path	Description
GET	/store/{storeId}/display_price?q={q}	Finds display prices by a query. See each query for details on input and output.
GET	/store/{storeId}/display_price?q=byCatalogEntryIdsAndPriceRuleId	Get the display prices for catalog entries by catalog entry ids and price rule id.
GET	/store/{storeId}/display_price?q=byCatalogEntryIdsAndPriceRuleName	Get the display prices for catalog entries by catalog entry ids and price rule name.
GET	/store/{storeId}/display_price?q=byPartNumbersAndPriceRuleId	Get the display prices for catalog entries by part numbers and price rule id.
GET	/store/{storeId}/display_price?q=byPartNumbersAndPriceRuleName	Get the display prices for catalog entries by part numbers and price rule name.

Method Details

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

Finds display prices 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}/display_price?q=byCatalogEntryIdsAndPriceRuleId

Get the display prices for catalog entries by catalog entry ids and price rule id.

Handler Method:

byCatalogEntryIdsAndPriceRuleId

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
catalogEntryId	The unique id of catalog entry.	query	string	true	true
priceRuleId	The unique id of price rule.	query	string	true	false
quantity	The quantity of the catalog entry.	query	string	false	false
uom	The unit of measurement of the quantity.	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:

display_price-IBM_Store_DisplayPrice

Example

Request:

GET /wcs/resources/store/10001/display_price?q=byCatalogEntryIdsAndPriceRuleId&catalogEntryId=13011&priceRuleId=10002

HTTP Status Code:

200

Response:

{
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/display_price?q=byCatalogEntryIdsAndPriceRuleId&catalogEntryId=13011&priceRuleId=10002",
	"resourceName": "display_price",
	"resultList": [
		{
			"catalogEntryId": "13011",
			"priceRuleId": "10002",
			"unitPrice": [
				{
					"price": {
						"currency": "USD",
						"value": 20.00
					},
					"quantity": {
						"uom": "C62",
						"value": 1.0
					}
				}
			]
		}
	]
}

GET /store/{storeId}/display_price?q=byCatalogEntryIdsAndPriceRuleName

Get the display prices for catalog entries by catalog entry ids and price rule name.

Handler Method:

byCatalogEntryIdsAndPriceRuleName

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
catalogEntryId	The unique id of catalog entry.	query	string	true	true
priceRuleName	The price rule name.	query	string	false	false
quantity	The quantity of the catalog entry.	query	string	false	false
uom	The unit of measurement of the quantity.	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:

display_price-IBM_Store_DisplayPrice

Example

Request:

GET /wcs/resources/store/10001/display_price?q=byCatalogEntryIdsAndPriceRuleName&catalogEntryId=13011&priceRuleName=%2522

HTTP Status Code:

200

Response:

{
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/display_price?q=byCatalogEntryIdsAndPriceRuleName&catalogEntryId=13011&priceRuleName=%2522",
	"resourceName": "display_price",
	"resultList": [
		{
			"catalogEntryId": "13011",
			"priceRuleId": "10001",
			"priceRuleName": "%22",
			"unitPrice": [
				{
					"price": {
						"currency": "USD",
						"value": 20.00
					},
					"quantity": {
						"uom": "C62",
						"value": 1.0
					}
				}
			]
		}
	]
}

GET /store/{storeId}/display_price?q=byPartNumbersAndPriceRuleId

Get the display prices for catalog entries by part numbers and price rule id.

Handler Method:

byPartNumbersAndPriceRuleId

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
partNumber	The unique id of catalog entry.	query	string	true	true
priceRuleId	The unique id of price rule.	query	string	true	false
quantity	The quantity of the catalog entry.	query	string	false	false
uom	The unit of measurement of the quantity.	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:

display_price-IBM_Store_DisplayPrice

Example

Request:

GET /wcs/resources/store/10001/display_price?q=byPartNumbersAndPriceRuleId&partNumber=HTA029_292001&partNumber=AAAZZZ&priceRuleId=10002

HTTP Status Code:

200

Response:

{
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/display_price?q=byPartNumbersAndPriceRuleId&partNumber=HTA029_292001&partNumber=AAAZZZ&priceRuleId=10002",
	"resourceName": "display_price",
	"resultList": [
		{
			"catalogEntryId": "13011",
			"partNumber": "HTA029_292001",
			"priceRuleId": "10002",
			"unitPrice": [
				{
					"price": {
						"currency": "USD",
						"value": 20.00
					},
					"quantity": {
						"uom": "C62",
						"value": 1.0
					}
				}
			]
		}
	]
}

GET /store/{storeId}/display_price?q=byPartNumbersAndPriceRuleName

Get the display prices for catalog entries by part numbers and price rule name.

Handler Method:

byPartNumbersAndPriceRuleName

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
partNumber	The part number of the catalog entry.	query	string	true	true
priceRuleName	The price rule name.	query	string	false	false
quantity	The quantity of the catalog entry.	query	string	false	false
uom	The unit of measurement of the quantity.	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:

display_price-IBM_Store_DisplayPrice

Example

Request:

GET /wcs/resources/store/10001/display_price?q=byPartNumbersAndPriceRuleName&partNumber=HTA029_292001&qPartNumer=AAAZZZ&priceRuleName=List%20price%20rule

HTTP Status Code:

200

Response:

{
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/display_price?q=byPartNumbersAndPriceRuleName&partNumber=HTA029_292001&qPartNumer=AAAZZZ&priceRuleName=List%20price%20rule",
	"resourceName": "display_price",
	"resultList": [
		{
			"catalogEntryId": "13011",
			"partNumber": "HTA029_292001",
			"priceRuleId": "10002",
			"priceRuleName": "List price rule",
			"unitPrice": [
				{
					"price": {
						"currency": "USD",
						"value": 20.00
					},
					"quantity": {
						"uom": "C62",
						"value": 1.0
					}
				}
			]
		}
	]
}

Data Type Details

com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType

Properties:

Name	Data Type	Required
value	string	false
currency	string	false

com.ibm.commerce.foundation.common.datatypes.QuantityType

Properties:

Name	Data Type	Required
value	string	false
uom	string	false

display_price-IBM_Store_DisplayPrice

Properties:

Name	Data Type	Required
recordSetTotal	string	false
recordSetStartNumber	string	false
recordSetComplete	string	false
resultList	display_price-IBM_Store_DisplayPrice_item array	false
recordSetCount	string	false

display_price-IBM_Store_DisplayPrice_item

Properties:

Name	Data Type	Required
priceRuleName	string	false
priceRuleId	string	false
catalogEntryId	string	false
unitPrice	display_price-IBM_Store_DisplayPrice_item.unitPrice array	false
userDataField	display_price-IBM_Store_DisplayPrice_item.userDataField array	false
partNumber	string	true

display_price-IBM_Store_DisplayPrice_item.unitPrice

Properties:

Name	Data Type	Required
price	com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType	false
quantity	com.ibm.commerce.foundation.common.datatypes.QuantityType	false

display_price-IBM_Store_DisplayPrice_item.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true