Get Product Promotions

Returns active promotion details for a single product.

GET/organizations/{organizationId}/products/{productId}/promotions

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Product Promotions action (under Shopper Products).
Fill in the fields below, then reference the result from later steps as {{getProductPromotions.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

productIdstringrequired

The ID of the product whose promotions to retrieve.

Query parameters

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

localeoneOf

A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.

currencystring

A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.

Response

Returns 200 with an object. Read it in later steps with {{getProductPromotions.response.data.<field>}}.

productIdstring

The ID of the product.

productPromotionsarray<object>

An array of active customer promotions applicable to this product, sorted by promotion priority using SORT_BY_EXCLUSIVITY ordering (exclusivity → rank → promotion class → discount type → best discount → ID). This array can be empty. Coupon promotions are not returned in this array.

promotionIdstringrequired

The unique ID of the promotion.

calloutMsgstringrequired

The localized call-out message of the promotion.

promotionalPricenumber (double)

The promotional price for this product. Only present for PRODUCT class promotions.

json

{
  "productId": "apple-ipod-shuffle",
  "productPromotions": [
    {
      "promotionId": "20off-electronics",
      "calloutMsg": "Save 20%!",
      "promotionalPrice": 71.99
    }
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?