This class provides RESTful services to access retrieve associated promotions.
com.ibm.commerce.rest.marketing.handler.AssociatedPromotionHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/associated_promotion?q={q} | Get promotion list by query name and parameters. See the individual queries for the details on input and output. |
GET | /store/{storeId}/associated_promotion?q=byCategory | Get promotions list by category ID. |
GET | /store/{storeId}/associated_promotion?q=byCategory | Get promotions list by category ID. |
GET | /store/{storeId}/associated_promotion?q=byName | This method retrieves the calculation code details using the name assigned to the calculation code. |
GET | /store/{storeId}/associated_promotion?q=byProduct | Get promotions list by product ID. |
GET | /store/{storeId}/associated_promotion?q=byProduct | Get promotions list by product ID. |
Get promotion list by query name and parameters. See the individual queries for the details on input and output.
findPromotionList
false
true
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. |
Get promotions list by category ID.
findPromotionsByCategory
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
qCalculationUsageId | The calculation usage ID. | query | string | false | false |
qCategoryId | The category ID. | query | string | true | false |
qCode | The calculation code name. | query | string | false | false |
qEnableStorePath | Whether the data bean searches for calculation code based on store path. Default value is <b>true</b>. | query | string | false | false |
qIncludeCategoryPromotions | Whether to exclude category promotions. Default value is <b>false</b>. | query | string | false | false |
qIncludeNonManagementCenterPromotions | Whether all the promotions in the store have been created in Management Center. Default value is <b>false</b> | query | string | false | false |
qIncludeParentCategories | Whether to retrieve the calculation codes attached to the parent category of the specified catalog group. Default value is <b>false</b>. | query | string | false | false |
qIncludePromotionCode | Whether to exclude the calculation codes that require a promotion code. Default value is <b>true</b>. | query | string | false | false |
qShipModeId | The ship mode ID. | query | string | false | false |
qUserId | The user ID. | query | string | false | false |
q | The query name. | query | string | true | false |
qDisplayLevel | query | integer | false | false | |
qIncludeChildItems | query | boolean | false | false | |
qIncludeParentProduct | query | boolean | false | false | |
qIncludeUnentitledPromotionsByMemberGroup | query | boolean | false | false | |
qProductId | query | integer | false | false | |
qStoreId | 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. |
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed
GET /wcs/resources/store/10001/associated_promotion?q=byCategory&qIncludeParentCategories=true&responseFormat=json&profileName=IBM_associatedPromotionsList_Summary&qCategoryId=10043
200
{ "associatedPromotions": [ { "associatePromotionId": "10011", "code": "Furniture Category Discount", "description": { "langId": "-1", "longDescription": "Save 20% on all Furniture items! No restrictions!", "shortDescription": "Save 20% on Furniture!" }, "endDate": "2999-12-31 23:59:59.0", "startDate": "2004-01-01 00:00:00.0" } ] }
Get promotions list by category ID.
findPromotionsByCategoryWAssociatedPromotionSummaryProfileName
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
qCalculationUsageId | The calculation usage ID. | query | string | false | false |
qCategoryId | The category ID. | query | string | true | false |
qCode | The calculation code name. | query | string | false | false |
qEnableStorePath | Whether the data bean searches for calculation code based on store path. Default value is <b>true</b>. | query | string | false | false |
qIncludeCategoryPromotions | Whether to exclude category promotions. Default value is <b>false</b>. | query | string | false | false |
qIncludeNonManagementCenterPromotions | Whether all the promotions in the store have been created in Management Center. Default value is <b>false</b> | query | string | false | false |
qIncludeParentCategories | Whether to retrieve the calculation codes attached to the parent category of the specified catalog group. Default value is <b>false</b>. | query | string | false | false |
qIncludePromotionCode | Whether to exclude the calculation codes that require a promotion code. Default value is <b>true</b>. | query | string | false | false |
qShipModeId | The ship mode ID. | query | string | false | false |
qUserId | The user ID. | query | string | false | false |
q | The query name. | query | string | true | false |
qDisplayLevel | query | integer | false | false | |
qIncludeChildItems | query | boolean | false | false | |
qIncludeParentProduct | query | boolean | false | false | |
qIncludeUnentitledPromotionsByMemberGroup | query | boolean | false | false | |
qProductId | query | integer | false | false | |
qStoreId | 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. |
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary
GET /wcs/resources/store/10001/associated_promotion?q=byCategory&qIncludeParentCategories=true&responseFormat=json&profileName=IBM_associatedPromotionsList_Summary&qCategoryId=10043
200
{ "associatedPromotions": [ { "associatePromotionId": "10011", "code": "Furniture Category Discount", "description": { "langId": "-1", "longDescription": "Save 20% on all Furniture items! No restrictions!", "shortDescription": "Save 20% on Furniture!" }, "endDate": "2999-12-31 23:59:59.0", "startDate": "2004-01-01 00:00:00.0" } ] }
This method retrieves the calculation code details using the name assigned to the calculation code.
byName
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
qCalculationUsageId | The calculation usage ID. | query | string | true | false |
qCode | The calculation code name. | query | string | true | false |
qIncludePromotionCode | Whether to exclude the calculation codes that require a promotion code. Default value is <b>true</b>. | query | string | true | false |
q | The query name. | query | string | true | false |
qCategoryId | query | integer | false | false | |
qDisplayLevel | query | integer | false | false | |
qEnableStorePath | query | boolean | false | false | |
qIncludeCategoryPromotions | query | boolean | false | false | |
qIncludeChildItems | query | boolean | false | false | |
qIncludeNonManagementCenterPromotions | query | boolean | false | false | |
qIncludeParentCategories | query | boolean | false | false | |
qIncludeParentProduct | query | boolean | false | false | |
qIncludeUnentitledPromotionsByMemberGroup | query | boolean | false | false | |
qProductId | query | integer | false | false | |
qShipModeId | query | integer | false | false | |
qStoreId | query | integer | false | false | |
qUserId | 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. |
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed
GET /wcs/resources/store/10001/associated_promotion?q=byName&profileName=IBM_catalogEntryDetailed&qIncludePromotionCode=true&qCalculationUsageId=-1&responseFormat=json&qCode=Register+and+Save
200
{ "resultList": [ { "attachedCatalogEntries": [ ], "calculationCodeId": "10007", "calculationUsageId": "-1", "code": "Register and Save", "descriptionString": "Register today and save 7%.", "endDate": "2999-12-31 23:59:59.0", "isPromotionRelated": true, "longDescriptionString": "Register with us today and save 7% on your next order.", "startDate": "2004-01-01 00:00:00.0" } ] }
Get promotions list by product ID.
findPromotionsByProduct
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
qProductId | The product ID. | query | string | true | false |
qCalculationUsageId | The calculation usage ID. | query | string | false | false |
qCode | The calculation code name. | query | string | false | false |
qEnableStorePath | Whether the data bean searches for calculation code based on store path. Default value is <b>true</b>. | query | string | false | false |
qIncludeCategoryPromotions | Whether to exclude category promotions. Default value is <b>false</b>. | query | string | false | false |
qIncludeChildItems | Whether to include the child items. Default value is <b>false</b>. | query | string | false | false |
qIncludeNonManagementCenterPromotions | Whether all the promotions in the store have been created in Management Center. Default value is <b>false</b> | query | string | false | false |
qIncludeParentCategories | Whether to retrieve the calculation codes attached to the parent category of the specified catalog group. Default value is <b>false</b>. | query | string | false | false |
qIncludeParentProduct | Whether to retrieve the calculation codes attached to the parent product of the specified catalog entry. Default value is <b>false</b> | query | string | false | false |
qIncludePromotionCode | Whether to exclude the calculation codes that require a promotion code. Default value is <b>true</b>. | query | string | false | false |
qIncludeUnentitledPromotionsByMemberGroup | Whether to include promotions that are targeted to a member group if the user does not belong to the member group. Default value is <b>false</b>. | query | string | false | false |
qShipModeId | The ship mode ID. | query | string | false | false |
qUserId | The user ID. | query | string | false | false |
q | The query name. | query | string | true | false |
qCategoryId | query | integer | false | false | |
qDisplayLevel | query | integer | false | false | |
qStoreId | 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. |
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed
GET /wcs/resources/store/10001/associated_promotion?q=byProduct&qCalculationUsageId=-1&profileName=IBM_catalogEntryDetailed&qProductId=12836&qIncludeChildItems=true&qIncludeParentProduct=true&responseFormat=json
200
{ "resultList": [ { "attachedCatalogEntries": [ ], "calculationCodeId": "10011", "calculationUsageId": "-1", "code": "Furniture Category Discount", "descriptionString": "Save 20% on Furniture!", "endDate": "2999-12-31 23:59:59.0", "isPromotionRelated": true, "longDescriptionString": "Save 20% on all Furniture items! No restrictions!", "startDate": "2004-01-01 00:00:00.0" } ] }
Get promotions list by product ID.
findPromotionsByProductWAssociatedPromotionSummaryProfileName
false
true
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
qProductId | The product ID. | query | string | true | false |
qCalculationUsageId | The calculation usage ID. | query | string | false | false |
qCode | The calculation code name. | query | string | false | false |
qEnableStorePath | Whether the data bean searches for calculation code based on store path. Default value is <b>true</b>. | query | string | false | false |
qIncludeCategoryPromotions | Whether to exclude category promotions. Default value is <b>false</b>. | query | string | false | false |
qIncludeChildItems | Whether to include the child items. Default value is <b>false</b>. | query | string | false | false |
qIncludeNonManagementCenterPromotions | Whether all the promotions in the store have been created in Management Center. Default value is <b>false</b> | query | string | false | false |
qIncludeParentCategories | Whether to retrieve the calculation codes attached to the parent category of the specified catalog group. Default value is <b>false</b>. | query | string | false | false |
qIncludeParentProduct | Whether to retrieve the calculation codes attached to the parent product of the specified catalog entry. Default value is <b>false</b> | query | string | false | false |
qIncludePromotionCode | Whether to exclude the calculation codes that require a promotion code. Default value is <b>true</b>. | query | string | false | false |
qIncludeUnentitledPromotionsByMemberGroup | Whether to include promotions that are targeted to a member group if the user does not belong to the member group. Default value is <b>false</b>. | query | string | false | false |
qShipModeId | The ship mode ID. | query | string | false | false |
qUserId | The user ID. | query | string | false | false |
q | The query name. | query | string | true | false |
qCategoryId | query | integer | false | false | |
qDisplayLevel | query | integer | false | false | |
qStoreId | 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. |
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary
GET /wcs/resources/store/10001/associated_promotion?q=byProduct&qCalculationUsageId=-1&profileName=IBM_catalogEntryDetailed&qProductId=12836&qIncludeChildItems=true&qIncludeParentProduct=true&responseFormat=json
200
{ "resultList": [ { "attachedCatalogEntries": [ ], "calculationCodeId": "10011", "calculationUsageId": "-1", "code": "Furniture Category Discount", "descriptionString": "Save 20% on Furniture!", "endDate": "2999-12-31 23:59:59.0", "isPromotionRelated": true, "longDescriptionString": "Save 20% on all Furniture items! No restrictions!", "startDate": "2004-01-01 00:00:00.0" } ] }
Name | Data Type | Required |
---|---|---|
associatedPromotions | com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary.associatedPromotions array | false |
Name | Data Type | Required |
---|---|---|
startDate | string | false |
associatePromotionId | string | false |
endDate | string | false |
description | com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary.associatedPromotions.description | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
shortDescription | string | false |
longDescription | string | false |
langId | string | false |
Name | Data Type | Required |
---|---|---|
resultList | com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed.resultList array | false |
Name | Data Type | Required |
---|---|---|
startDate | string | false |
longDescriptionString | string | false |
calculationCodeId | string | false |
isPromotionRelated | string | false |
calculationUsageId | string | false |
endDate | string | false |
attachedCatalogEntries | com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed.resultList.attachedCatalogEntries array | false |
descriptionString | string | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
isDynamicKit | string | false |
catalogEntryId | string | false |
isProduct | string | false |
productDataBean | com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed.resultList.attachedCatalogEntries.productDataBean | false |
calculatedContractPrice | com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed.resultList.attachedCatalogEntries.calculatedContractPrice | false |
listPrice | com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed.resultList.attachedCatalogEntries.listPrice | false |
partNumber | string | false |
manufacturerName | string | false |
description | com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_catalogEntryDetailed.resultList.attachedCatalogEntries.description | false |
manufacturerPartNumber | string | false |
Name | Data Type | Required |
---|---|---|
currency | string | false |
amount | string | false |
Name | Data Type | Required |
---|---|---|
shortDescription | string | false |
longDescription | string | false |
keyWord | string | false |
available | string | false |
availabilityDate | string | false |
auxDescription1 | string | false |
auxDescription2 | string | false |
name | string | false |
thumbNail | string | false |
fullImage | string | false |
published | string | false |
Name | Data Type | Required |
---|---|---|
currency | string | false |
amount | string | false |
Name | Data Type | Required |
---|---|---|
productId | string | false |