Calculate prices for products by SKUs

Use this endpoint to calculate prices for one or more products in a specific price list by product SKUs. If you prefer to use item IDs to calculate product prices, use the calculate prices for products by item IDs endpoint.

itemId is used as the default identifier for a product. If you want to set SKUs as product identifiers and use this endpoint, you must contact fabric support at [e-mail].

Authorizations

Authorization

string

header

required

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.

Example:

"2022-09-06T14:07:17.000Z"

x-fabric-request-id

string

A unique request ID.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

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.

Example:

"12"

Body

application/json

Evaluate prices for products based on their individual SKUs.

priceListId

integer

required

Price list ID of the item.

Example:

100275

skus

string[]

required

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

Product SKU

Example:

["1000019501", "1000019502"]

customer

object

Customer details

Show child attributes

customer.id

string

Unique identifier for the customer

Example:

"5e2cfb9b45570b000864c4b5"

customer.segments

object[]

A list of segments the customer belongs to.

Show child attributes

customer.segments.name

string

The name of the segment the customer belongs to.

Example:

"category"

customer.segments.value

string[]

The values of the segment associated with the customer.

Segment item

Example:

[
  {
    "name": "category",
    "value": ["GOLD", "YELLOW"]
  },
  { "name": "ageGroup", "value": ["elderly"] }
]

priceParameters

object[]

The parameters used to calculate the price.

The additional parameters for calculating the price.

Show child attributes

priceParameters.additionalProperties

object[]

The additional properties for calculating the price.

Show child attributes

priceParameters.additionalProperties.id

string

The variable ID.

Example:

"length"

priceParameters.additionalProperties.value

number

The variable value.

Example:

10

Example:

[
  { "id": "length", "value": 10 },
  { "id": "width", "value": 20 }
]

priceParameters.selectedAddOns

string[]

List of add-ons selected for the product.

Add-on name

Example:

["blind_motor"]

priceParameters.sku

string

Product SKU

Example:

"1000019501"

priceParameters.quantity

integer

Number of products ordered. This value is required for the range-based pricing method.

Example:

500

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.

Example:

true

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.

Example:

"en-US"

Response

200

application/json

OK

Sample response including successful retrievals and potential errors.

errors

object[]

An array containing error codes and corresponding messages.

The validation errors related to the price.

Show child attributes

errors.type

string

The error code.

Example:

"Not found"

errors.message

string

An error message corresponding to the type.

Example:

"Price doesn't exist for product 179089, channels [12, 10], date Wed Nov 16 14:11:16 UYT 2022 and price lists [197090]"

data

object[]

Calculated price details

Show child attributes

data.priceListId

integer

The price list ID of the item.

Example:

100275

data.sku

string

Product SKU

Example:

"SKU1234"

data.offer

object

Discounts or special offers applied to the price.

Show child attributes

data.offer.price

object

The calculated price details for line items.

Show child attributes

data.offer.price.sale

number | null

Sale price of the product.

Example:

1000.15

data.offer.price.cost

number

Cost of goods sold, from either producing or purchasing from other vendors.

Example:

900.15

data.offer.price.base

number

The base price of a single item before any discounts.

Example:

2000.15

data.offer.price.unitPriceWithoutDiscounts

number | null

Price of a single item without discount. This price is either the base or sale price. The type used is noted in the type property.

Example:

2000.15

data.offer.price.lineTotalWithoutDiscounts

number | null

Total price of all items without calculating discounts. This is the unitPriceWithoutDiscounts multiplied by the quantity.

Example:

5000.15

data.offer.price.lineTotalWithDiscounts

number | null

Total price of all items after all discounts. This is the unitPriceWithoutDiscounts multiplied by the quantity, less the promotion discounts.

Example:

5000.15

data.offer.price.type

string | null

Price type

Example:

"BASE"

data.offer.price.currency

string

Currency string value

Example:

"USD"

Example:

{
  "sale": 1000.15,
  "cost": 900.15,
  "base": 2000.15,
  "unitPriceWithoutDiscounts": 2000.15,
  "lineTotalWithoutDiscounts": 2000.15,
  "lineTotalWithDiscounts": 2000.15,
  "type": "BASE"
}

data.offer.discounts

object[]

A list of discounts applied to the price.

Promotion discount

Show child attributes

data.offer.discounts.amount

number

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

Example:

100.15

data.offer.discounts.quantity

integer

The number of items eligible for the promotional discount.

Example:

5

data.offer.discounts.application

integer | null

The number of times the BuyGet promotion can be used, indicating how many times you can use the promotions, such as get a certain amount or percentage off, or get free items when making a purchase.

Example:

1

data.offer.discounts.promotion

object

Promotion object

Show child attributes

data.offer.discounts.promotion.id

string

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

Example:

"6197ec46e836ff000952c667"

data.offer.discounts.promotion.value

number

The discount applied to the price. This can be specified as a percentage or a fixed amount.

Example:

2000.15

data.offer.discounts.promotion.groupId

string | null

ID of the group or category this product belongs to

Example:

"61a6354d0d70e30009415f16"

data.offer.discounts.promotion.level

integer | null

The order in which the current promotion is executed.

Example:

1

data.offer.discounts.promotion.isStackable

boolean | null

Specifies whether the promotion is stackable. You can set one of the following: - true: This promotion can be combined with other stackable promotions, allowing multiple discounts to be applied together. - false: The promotion isn't stackable. You can't combine this promotion with other promotions.

Example:

true

data.offer.discounts.promotion.isAlwaysApplied

boolean | null

Specifies whether the promotion is applied regardless of the exclusive promotions on the same item. You can set one of the following values: - true: Promotion is applied regardless of the exclusive promotions on the same item. - false: Promotion isn't applied on the item.

Example:

true

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

Example:

"STACKABLE"

data.offer.discounts.promotion.name

string

Promotion name

Example:

"20% off"

data.offer.discounts.promotion.type

string

Promotion type

Example:

"COUPON"

data.offer.discounts.promotion.discountType

enum<string>

Discount type

Available options:

PERCENTAGE_OFF,

AMOUNT_OFF,

FIXED_PRICE

Example:

"PERCENTAGE_OFF"

data.offer.discounts.promotion.promotionMessages

object[]

The promotion message that is displayed to the customer.

Message description for the promotion

Show child attributes

Example:

{
  "id": "6197ec46e836ff000952c668",
  "value": 2000.15,
  "groupId": "61a6354d0d70e30009415f16",
  "level": 1,
  "isStackable": true,
  "isAlwaysApplied": true,
  "name": "20% OFF",
  "type": "Coupon",
  "discountType": "AMOUNT_OFF",
  "stackingType": "STACKABLE",
  "promotionMessages": [
    {
      "promoId": "6197ec46e836ff000952c666",
      "title": "Get 50% off socks when buying shoes!",
      "message": "Buy any pair of shoes and get 50% off a pair of socks.",
      "locales": ["en-US", "en-GB"],
      "pages": ["PDP", "CART"],
      "type": "DISCOUNT"
    }
  ]
}

data.offer.suggestedProducts

array

The suggested products.

A list of suggested products.

data.offer.additionalAttributes

object[]

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

data.offer.promotionMessages

object[]

The promotion message that is displayed to the customer.

Message description for the promotion

Show child attributes

data.offer.promotionMessages.title

string

Message name

Example:

"Buy 2 get 1 free"

data.offer.promotionMessages.message

string

Message description

Example:

"Offer valid at participating stores through September 5, 2023."

data.offer.promotionMessages.pages

enum<string>[]

The types of web pages where the message is displayed.

Page type

Available options:

PDP,

PLP,

Cart,

Checkout

data.offer.promotionMessages.locales

string[]

The geographic regions where the promotion message is displayed, determined by the user's IP address. Locales define language and country-specific settings for promotions.

Locale

data.offer.promotionMessages.type

enum<string>

Specifies the promotion message type.

• DISCOUNT: The discount has been applied.
• PROXIMITY: The product or cart is close to meeting discount conditions.
• POTENTIAL_DISCOUNT: The product could qualify for a discount but has not yet.

Available options:

DISCOUNT,

PROXIMITY,

POTENTIAL_DISCOUNT

Example:

"DISCOUNT"

data.offer.promotionMessages.threshold

integer

Indicates a quantity or amount that is close to meeting the discount requirement. If the user reaches this value, a promotion message is displayed. This field is only valid for PROXIMITY messages.

Example:

2

data.offer.promotionMessages.promoId

string

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

Example:

"61df12345678900009b7091c"

data.audit

object

Details involved in calculating the price.

Show child attributes

data.audit.userId

string

The auto populated ID of the user who created the price.

Example:

"62f5e25ca090100009c6e0f0"

data.audit.priceMethodType

string

The method used to calculate the price.

Example:

"SurfaceArea_Square_Increment"

data.audit.quantity

integer

The quantity of items for which the price is calculated.

Example:

50

data.audit.priceParameters

object

The additional parameters for calculating the price.

Show child attributes

data.audit.priceParameters.additionalProperties

object[]

The additional properties for calculating the price.

Show child attributes

data.audit.priceParameters.additionalProperties.id

string

The variable ID.

Example:

"length"

data.audit.priceParameters.additionalProperties.value

number

The variable value.

Example:

10

Example:

[
  { "id": "length", "value": 10 },
  { "id": "width", "value": 20 }
]

data.audit.appliedAddons

object[]

List of additional components used in the price calculation