Calculate prices for products by SKUs

Getting Started

Authentication v3

Concepts
System Apps
User Apps
Authentication Endpoints

Product Catalog

Product Catalog API - Overview
Developer Guide
Data Ingestion Best Practices
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products

Orders

Orders (3.0.0)
Developer Guide
Orders FAQ
Shopping Lists
Shipping Methods
Imports
Exports
Orders
Frauds
Notifications
Backorders Preorders
Cancellations
Allocations
Shipments
Inventory Transfers
Tracking
Invoices
Payments
Credits
Appeasements
Returns

Inventory

Inventory (3.0.0)
Inventory FAQ
Imports
Counters
Inventory
Locations
Networks

Integrations

Offers

Offers (3.0.0)
Developer Guide
Real-time Pricing Engine
- Overview
- POST
  Calculate prices for products by IDs
- POST
  Calculate prices for products by SKUs
- POST
  Evaluate cart promotions
Price Lists
Prices
Price Types
Price Controls
Price Methods
Priced Products
Add-ons
Promotions
Coupons
Coupon Codes
Redemptions
Product Exclusion Lists
Segments
Imports
Exports
Attributes
Webhook Events

Carts

Overview
Developer Guides
Carts
Order Draft
Items
Addresses
Payments
Fulfillment
Customer
Coupons
Validations
Cart Orchestrator

Customers

Customer Profile
Customer Address
Customer Self

POST

price-engine

actions

evaluate-products-by-sku

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Required string length: 24

x-fabric-date

string

The Date and time, in ISO 8601 format, for which the evaluation should be done. The prices and promotions that are active on this date will be considered for evaluation.

x-fabric-request-id

string

A unique request ID.

x-fabric-channel-id

string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

Body

application/json

Evaluate prices for products based on their individual SKUs.

priceListId

integer

required

Price list ID of the item.

skus

string[]

required

List of product SKUs for which prices are to be retrieved. You can specify up to 50 SKUs.

customer

object

Customer details

priceParameters

object[]

The parameters used to calculate the price.

isAudit

boolean

Specifies whether an audit's required. The options are:

true: Response includes an audit object mentioning how the price is calculated.
false: Response doesn't include an audit object.

locale

string

The language code, which is a combination of language in ISO 639 format and country in ISO 3166 format. The default value is en-US.

Response

200 - application/json

Sample response including successful retrievals and potential errors.

errors

object[]

An array containing error codes and corresponding messages.

data

object[]

data.priceListId

integer

The price list ID of the item.

data.sku

string

Product SKU

data.offer

object

Discounts or special offers applied to the price.

data.offer.price

object

The calculated price details for line items.

data.offer.discounts

object[]

A list of discounts applied to the price.

data.offer.discounts.amount

number

The actual discount amount applied to the price. For example, specifying 100.15 for a product with a base price of 2000.15 results in a discounted price of 1900.

data.offer.discounts.quantity

integer

The number of items eligible for the promotional discount.

data.offer.discounts.proratedAmount

number

The discount amount distributed proportionally among all the selected items. The distribution is determined based on each item's price relative to the total price of all participating items. Typically, proratedAmount matches the amount. However, there might be variations, particularly in the context of Buy-Get promotions.

data.offer.discounts.proratedQuantity

integer

This is used in conjunction with proratedAmount to determine the discount portion allocated to the respective units of BuyGet promotions. This is applicable in partial return scenarios.

data.offer.discounts.application

integer | null

An identifier for an instance of the Buy-Get promotion that can be applied repeatedly. For example, consider a promotion - Buy 1 shirt and get 1 pant at a 20% off. If a shopper buys three shirts, 20% discount is individually applied to each shirt-pant pair. Each such discounted pair is assigned a unique application number for tracking purposes.

data.offer.discounts.promotion

object

The promotion details.

data.offer.discounts.promotion.id

string

A 24-character system-generated coupon ID generated using the create coupon endpoint.

data.offer.discounts.promotion.value

number

The discount in percent or amount.

data.offer.discounts.promotion.groupId

string | null

ID of the group or category this product belongs to

data.offer.discounts.promotion.level

integer | null

The order in which the current promotion is executed.

data.offer.discounts.promotion.isStackable

boolean | null

A flag indicating whether the promotion is stackable. Set to true to combine the given promotion with other promotions. The discount of the current promotion is combined with other promotions, if applicable, to the item. Set to false if the promotion isn't stackable; the given promotion can't be combined with other promotions.

data.offer.discounts.promotion.isAlwaysApplied

boolean | null

A flag indicating whether the promotion is always applied regardless of any exclusive promotions on the same item. Set to true if the promotion is always applied and set to false if the promotion isn't applied on the item by default.

data.offer.discounts.promotion.stackingType

enum<string>

Defines the rules for how a promotion can be combined with other promotions. This field determines whether a specific promotion can be applied in conjunction with other active promotions during a transaction or if it must be used exclusively. Possible values: - STACKABLE: This promotion can be combined with other stackable promotions, allowing multiple discounts to be applied together. The order in which stackable promotions are applied is determined by the level field, with promotions having a higher priority (lower numeric value) being applied before those with a lower priority.

EXCLUSIVE: This promotion can't be combined with any other promotions. The level field is used to determine which exclusive promotion will be evaluated and applied first. Once an exclusive promotion is applied, no other promotions can be used in the same transaction.
TYPE_EXCLUSIVE: This promotion can't be combined with other promotions of the same type. The level field is used to determine which promotion within the same type will be evaluated and applied first.
UNIVERSAL: This promotion can be combined with any other promotions without restrictions. Universal promotions will be evaluated last.

Available options:

STACKABLE,

EXCLUSIVE,

TYPE_EXCLUSIVE,

UNIVERSAL

data.offer.discounts.promotion.name

string

The name of the promotion.

data.offer.discounts.promotion.type

string

The type of the promotion.

data.offer.discounts.promotion.discountType

enum<string>

The type of discount.

Available options:

PERCENTAGE_OFF,

AMOUNT_OFF,

FIXED_PRICE

data.offer.suggestedProducts

array

The suggested products.

data.offer.additionalAttributes

object[]

A placeholder for additional price attributes, in name-values pairs.

data.audit

object

Details involved in calculating the price.

Was this page helpful?

Calculate prices for products by IDs Evaluate cart promotions