promotion

This class provides RESTful services to get promotion data using the Promotion noun.

com.ibm.commerce.rest.marketing.handler.PromotionHandler

HTTP Method	Path	Description
GET	/store/{storeId}/promotion?q={q}	Gets the promotion list by query type and parameters.
GET	/store/{storeId}/promotion/{promotionId}	Get Promotion by id.

Gets the promotion list by query type and parameters.

getPromotionsByQuery

true

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
qName	The name of the promotion to find when finding promotions by name.	query	string	false	false
pageNumber	Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.	query	integer	false	false
pageSize	Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work.	query	integer	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.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Get Promotion by id.

getPromotionByID

true

false

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
promotionId	The promotion identifier.	path	integer	true	N/A

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.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Name	Data Type	Required
startDate	string	false
dailyStartTime	string	false
endDate	string	false
weekDays	com.ibm.commerce.promotion.facade.datatypes.DayOfWeekEnumerationType array	false
dailyEndTime	string	false

Name	Data Type	Required
recordSetTotal	string	false
Promotion	promotion-promotion_item array	false
recordSetStartNumber	string	false
recordSetComplete	string	false
recordSetCount	string	false

Name	Data Type	Required
status	string	false
schedule	com.ibm.commerce.promotion.facade.datatypes.PromotionScheduleType	false
administrativeName	string	false
Description	promotion-promotion_item.Description array	false
promotionType	string	false
promotionName	string	true
promotionId	string	false

Name	Data Type	Required
longDescription	string	false
shortDescription	string	false