Promotion: Promotion Noun

Promotion noun is used to model a Promotion.

BOD Summary

Access Profile and Expression Builder columns are for Get BOD only.
BOD Action Code / Access Profile Action Expression Service Provided Sample XML Message Client Library / Expression Builder
ChangePromotion Add /Promotion[]/Description[] Creates a new promotion description. Request
Response

PromotionFacadeClient.changePromotion()
Add /Promotion[]/Element[] Creates a promotion element and element name-value pairs. Request
Response

PromotionFacadeClient.changePromotion()
Change /Promotion[] Changes the base Promotion information. Request
Response

PromotionFacadeClient.changePromotion()
Change /Promotion[]/Description[] Changes a promotion description. Request
Response

PromotionFacadeClient.changePromotion()
Change /Promotion[]/Element[] Changes a promotion element and element name-value pairs. Request
Response

PromotionFacadeClient.changePromotion()
Delete /Promotion[]/Description[] Deletes a promotion description. Request
Response

PromotionFacadeClient.changePromotion()
Delete /Promotion[]/Element[] Deletes a promotion element and element name-value pairs. Request
Response

PromotionFacadeClient.changePromotion()
GetPromotion IBM_Admin_Details /Promotion[PromotionIdentifier[(UniqueID='$promotionId$')]] Gets promotion information by PromotionIdentifier. Detailed information about a promotion and its description will be returned.
Request
Response

PromotionFacadeClient.getPromotion()
IBM_Admin_PromotionElements /Promotion[PromotionIdentifier[(UniqueID='$promotionId$')]] Gets promotion information by PromotionIdentifier. Summary information about a promotion and information about its elements will be returned.
Request
Response

PromotionFacadeClient.getPromotion()
IBM_Admin_Details /Promotion Gets promotion information for a store. Detailed information about a promotion and its description will be returned.
Request
Response

PromotionFacadeClient.getPromotion()
IBM_Admin_Details /Promotion[Element[(ElementType='$elementType$') and ElementVariable[(Value='$Id$')]]] Gets promotion information associated with the 'ID' value of a predefined element type:
  • IncludeMemberGroupIdentifier
  • ExcludeMemberGroupIdentifier
  • IncludeCategoryIdentifier
  • ExcludeCategoryIdentifier
  • IncludeCatalogEntryIdentifier
  • ExcludeCatalogEntryIdentifier
  • GiftCatalogEntryIdentifier
  • IncludeShipModeIdentifier
Information about a promotion and its description will be returned.
Request
Response

PromotionFacadeClient.getPromotion()
IBM_Admin_Details /Promotion[search(PromotionIdentifier/ExternalIdentifier/Name='$searchText$' or Code='$searchText$')] Gets promotion information with a search pattern. The search pattern is used to match promotion name and promotion codes. Information about a promotion and its description will be returned.
Request
Response

PromotionFacadeClient.getPromotion()
ProcessPromotion Add /Promotion[] Creates a new promotion. Request
Response

PromotionFacadeClient.processPromotion()
Activate /Promotion[] Activates a promotion.
Request
Response

PromotionFacadeClient.processPromotion()
Deactivate /Promotion[] Deactivates a promotion. Request
Response

PromotionFacadeClient.processPromotion()
Delete /Promotion[] Marks a promotion for deletion. Request
Response

PromotionFacadeClient.processPromotion()

Access Profile

Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.

Access Profile Data Returned
IBM_Admin_Details
  • /Promotion/PromotionIdentifier
  • /Promotion/PromotionType
  • /Promotion/Status
  • /Promotion/Priority
  • /Promotion/ExclusiveType
  • /Promotion/Comments
  • /Promotion/Schedule
  • /Promotion/RedemptionLimit
  • /Promotion/Description
  • /Promotion/CouponRequired
  • /Promotion/CouponAttribute
  • /Promotion/PromotionCodeRequired
  • /Promotion/PromotionCode
  • /Promotion/TargetSales
  • /Promotion/ControlParameter
IBM_Admin_PromotionElements
  • /Promotion/PromotionIdentifier
  • /Promotion/Status
  • /Promotion/Priority
  • /Promotion/ExclusiveType
  • /Promotion/Schedule/StartDate
  • /Promotion/Schedule/EndDate
  • /Promotion/RedemptionLimit
  • /Promotion/CouponRequired
  • /Promotion/CouponAttribute
  • /Promotion/PromotionCodeRequired
  • /Promotion/TargetSales
  • /Promotion/Element

XSD files