younifyd
Menu

Get Product Prices

Returns price details for a single product.

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

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Get Product Prices action (under Shopper Products).
  3. Fill in the fields below, then reference the result from later steps as {{getProductPrices.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 prices 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 {{getProductPrices.response.data.<field>}}.

productIdstring

The ID of the product.

pricenumber (double)

The effective sales price of the product. For complex products (master, set), this is the minimum price of the related child products.

priceMaxnumber (double)

The maximum sales price. For complex products (master, set), this is the maximum price of the related child products.

pricePerUnitnumber (double)

The price per unit if defined for the product.

pricePerUnitMaxnumber (double)

The maximum price per unit, typically for a master product's variant.

pricePerUnitUnitstring

The unit of measure for the per-unit price (e.g. "kg", "lb").

tieredPricesarray<object>

The list of tiered prices for the product. Each entry represents a price for a given pricebook and minimum order quantity threshold. Uses the effective (lowest) winning price from the merged applicable pricebooks for each quantity tier — matching the SCAPI product endpoint's tieredPrices field.

priceany

Price for the product for the specified tier for the specified pricebook

pricebookstring

The active pricebook for which this price is defined

quantitynumber (double)

Quantity tier for which the price is defined.

pricesobject

A map of pricebook IDs to their corresponding prices for this product.

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.

priceRangesarray<object>

Per-pricebook min/max price ranges. Only present for complex products (master, variation group, product set) that have variants with differing prices.

pricebookstring

The ID of the pricebook.

minPricenumber (double)

The minimum price across all variants for this pricebook.

maxPricenumber (double)

The maximum price across all variants for this pricebook.

json
{
  "productId": "apple-ipod-shuffle",
  "price": 89.99,
  "priceMax": 99.99,
  "pricePerUnit": 8.99,
  "pricePerUnitMax": 9.99,
  "pricePerUnitUnit": "kg",
  "tieredPrices": [
    {
      "price": null,
      "pricebook": "usd-list-pricebook",
      "quantity": 1
    }
  ],
  "prices": {
    "usd-sale-pricebook": 89.99,
    "usd-list-pricebook": 99.99
  },
  "currency": "USD",
  "priceRanges": [
    {
      "pricebook": "usd-sale-pricebook",
      "minPrice": 19.99,
      "maxPrice": 99.99
    }
  ]
}

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