Get calculated prices

Retrieves prices for items either by SKUs or by item IDs based on the customer specific configuration set in the backend.

Authorizations

Authorization

string

header

required

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

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

Prices conditions

audit

boolean

true if audit is required. Response body will have an audit object with details about how the dynamic pricing engine obtained the result.<br /> false if audit is not required.

channel

integer[]

List of channel ID from where the request is coming

date

string

Date for which the prices are to be retrieved

isLoggedIn

boolean

true if the user logged in<br /> false if the user is not logged in

itemId

integer[]

List of item IDs for items whose prices needs to be retrieved. Specify either SKUs or itemIds. If both are provided, the SKU takes precedence.

priceList

string[]

List of price list IDs which items or SKUs belong to

priceParams

object[]

Various price parameters to calculate final price

Show child attributes

priceParams.itemId

integer

Item ID. Either SKU or ItemId is mandatory

priceParams.options

object

Pricing options for calculation

Show child attributes

priceParams.options.{key}

object

Pricing pptions for calculation

priceParams.quantity

number

Number of items ordered. Mandatory for Range-Base pricing method

priceParams.sku

string

Item SKU. Either SKU or ItemId is mandatory

sku

string[]

A list of Stock Keeping Units (SKUs) for items whose prices needs to be retrieved. Specify either SKUs or itemIds. If both are provided, the SKU takes precedence.

traceId

string

Trace ID, used to trace logs

userId

string

User ID

userProfile

object

Segment the user belongs to

Show child attributes

userProfile.{key}

string[]

Segment the user belongs to

Response

200 - application/json

audit

object

Show child attributes

audit.appliedAddons

string[]

audit.options

object

Show child attributes

audit.options.length

number

audit.options.width

number

audit.priceMethodType

string

audit.quantity

number

audit.userId

string

ID of the user who created the price

itemId

integer

Item SKU

offers

object

Offers on the price

Show child attributes

offers.additionalAttributes

object[]

A placeholder for additional attributes, in key-value pairs.

offers.channel

integer

Channel for which the price is retrieved

offers.discounts

object[]

Discount object

Show child attributes

offers.discounts.amount

number

Actual discount amount

offers.discounts.application

integer

It is used specifically for BuyGet type that applies when you Buy something and Get discount of some amount or percentage or free items. This field indicates how many times this BuyGet promotion is applied.

offers.discounts.discountType

enum<string>

Discount Type

Available options:

PERCENTAGE_OFF,

AMOUNT_OFF,

FIXED_PRICE

offers.discounts.groupId

string

ID of the group or category this item belongs to

offers.discounts.isAlwaysApplied

boolean

A flag indicating whether the promotion is always applied. Set it to true if the promotion is always applied, even on non-stackable promotions and false to apply promotions based on configured conditions.

offers.discounts.level

integer

The promotion execution order. Promotion types are assigned default execution orders. Initial evaluation begins with level 1 promotions. The result of level 1 is used as the base price for level 2. Similarly, the result of level 2 becomes the base price for level 3, and so on.

offers.discounts.priority

integer

The order in which promotion should be applied. Promotion types are assigned a default priority. First, priority 1 promotions will be evaluated. The result of priority 1 will be used as a base price for priority 2. Similarly, the result of priority 2 will be used as a base price for priority 3 and so on.

offers.discounts.promotionId

string

Promotion ID

offers.discounts.promotionType

string

Promotion type

offers.discounts.proratedAmount

number

The BuyGet promotions distribute the discount across specified parameters. For example, when buying A results in a discount on B, the discount amount on B is prorated across both A and B. The distributed amount is reflected in proratedAmount, while the quantity is captured in proratedQuantity.

offers.discounts.proratedQuantity

integer

The proratedQuantity 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.

offers.discounts.quantity

integer

Item quantity

offers.discounts.stackable

boolean

true indicates promotions are stackable, meaning their discounts will be summed together. Stackable promotions will be applied regardless of other promotions being applied.<br /> false indicates promotions are non-stackable, meaning discounts will be compared, within the same priority, and the maximum discount will be applied for promotion.

offers.discounts.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 cannot 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 cannot 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

offers.discounts.title

string

Promotion title

offers.discounts.value

number

Discount in percent or amount

offers.kind

string

Price kind name

offers.price

object

Show child attributes

offers.price.base

number

Minimum fixed price of a single unit of the item

offers.price.cost

number

Cost price. Displayed if configured earlier

offers.price.currency

string

Currency

offers.price.finalPrice

number

Final calculated price of the item. Does not include discounts.

offers.price.sale

number

Price at which the product is offered for sale

offers.price.totalPrice

number

Final calculated price of the item, include discounts.

priceList

string

Price List ID

sku

string

Item SKU