Dynamic Pricing APIs (1.0.0)

Download OpenAPI specification:Download

E-mail: support@fabric.inc License: fabric INC

fabric's Dynamic Pricing Engine provides APIs that help to evaluate promotions and calculate prices instantly for the cart items using real-time price calculation method, that incorporates the latest information, to provide personalized and competitive prices for specific customers. It supports formula based custom SKU dynamic pricing, and shows discount breakdown details for separate items having separate promotions.

It uses the cache information, instead of fetching offer details of items from database, to evaluate promotions and calculate prices instantly. It is fast, scalable to millions of pricing requests per day, and supports complex promotional strategies.

Promotions

Promotions endpoint lets you evaluate promotions and discount coupons for one or more items instantly.

Evaluate promotions for items

Evaluates a cart's promotions, discount coupons and implicit promotions,either by specified itemId or by SKU (based on the customer specific configuration).

Request

header Parameters

x-api-key required	string The `x-api-key` lets you access fabric APIs without `Authorization`. You must request fabric Inc to obtain this key.
tenant-key required	string Tenant ID or Merchant account ID. It's a 10 character client's co-pilot account ID provided by fabric.

Request Body schema: application/json

isLoggedIn	boolean True if the user logged in, otherwise false
userId	string User identification number
audit	boolean True if audit is required, otherwise false
promoCodes	Array of strings List of all the promotion codes to apply
	Array of objects (promotion-request-shipping) Shipping Information
required	Array of objects (promotion-request-item) List of item information objects
date	string <date-time> yyyy-MM-ddThh:mm:ssZ Date for which the promotions are evaluated.
	Array of objects Segment the user belongs to

Responses

200

Successfully evaluated the promotions

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error

post/promo/evaluate-promotions

Request samples

Payload

application/json

{"isLoggedIn": true,
"userId": "5e2cfb9b45570b000864c4b5",
"audit": true,
"promoCodes": ["SUPERCOUPON1",
"FIRSTPURCHASE10"
],
"shipping": [{"shippingMethodId": 123,
"shippingPrice": 20
}
],
"items": [{"lineItemId": 1,
"priceList": "100275",
"sku": "1111111",
"itemId": 1111111,
"quantity": 5,
"group": ["5e2cfb9b45570b000863c4b5"
],
"hierarchy": [["clothingId1",
"footwear",
"sandalsId1"
],
["nike",
"sandalsId2"
],
["clothingId2",
"beach"
]
],
"productAttributes": {"color": "Red",
"brand": "Nike",
"size": "10"
},
"priceParams": {"options": {"length": "2",
"width": "15",
"blindMotor": true
}
},
"price": {"sale": 10,
"cost": 9,
"base": 10,
"finalPrice": 20,
"currency": "USD"
},
"channel": [12,
15
],
"shippingMethodId": 123,
"shippingPrice": 20
}
],
"date": "2019-08-24T14:15:22Z",
"userProfile": {"Customer Type": ["Wholesale"
]
}
}

Response samples

application/json

[{"items": [{"lineItemId": 1,
"sku": "1111111",
"itemId": 1111111,
"priceList": "100275",
"group": ["5e2cfb9b45570b000863c4b5",
"clothingId1",
"footwear"
],
"quantity": 5,
"price": {"currency": "USD",
"base": 10,
"kind": "BASE",
"totalPrice": 50,
"finalPrice": 50,
"sale": 50
},
"priceAttributes": {"cost": 9,
"floor": 10,
"clearance": 10
},
"discount": [{"quantity": 5,
"amount": 10,
"unit": "%OFF",
"value": 10,
"promoId": "6197ec46e836ff000952c668",
"promoCode": "SUPERCOUPON20",
"promoTitle": "20% off",
"type": "COUPON"
}
],
"attributes": {"color": "red",
"brand": "Nike",
"size": "10"
},
"shippingPrice": 20,
"shippingMethodId": 123,
"shippingDiscount": 5
}
],
"errors": [["Parameter does not exist"
]
],
"shipping": [{"shippingMethodId": 456,
"shippingPrice": 5,
"shippingDiscount": 5
}
],
"appliedDiscounts": [{"promoId": "6197ec46e836ff000952c668",
"promoCode": "SUPERCOUPON20",
"promoTitle": "20% off",
"type": "COUPON",
"amount": 10
}
],
"notAppliedCoupons": [{"promoCode": "SUPERCOUPON",
"message": "Invalid coupon"
}
],
"success": true
}
]

Price

Price endpoint lets you calculate instant prices for one or more items.

Get calculated prices by SKU

Gets final prices for items, after applying discount coupons and promotions, either by SKUs or by itemIds (based on the customer specific configuration).

Request

header Parameters

x-api-key required	string The `x-api-key` lets you access fabric APIs without `Authorization`. You must request fabric Inc to obtain this key.
tenant-key required	string Tenant ID or Merchant account ID. It's a 10 character client's co-pilot account ID provided by fabric.

Request Body schema: application/json

priceList required	Array of strings List of price list Ids for which items or skus belong to
sku	Array of strings List of SKU Ids of items for which prices are calcluated.Either SKUs or ItemIds required. If both are provided, SKU overrides itemId.
itemId	Array of integers <int32> List of Item Ids for which prices are calculated. Either SKUs or ItemIds required. If both are provided, SKU overrides itemId.
userId	string User Id
	object Segment the user belongs to
isLoggedIn	boolean True if the user logged in, otherwise false
channel	Array of integers <int32> List of channel id from where the request is coming
date	string <date-time> yyyy-MM-ddThh:mm:ssZ Date for which the prices are calculatedd.
	Array of objects (price-request-param) Various price parameters to calculate the final price
audit	boolean True if audit required, otherwise false

Responses

200

Successfully retrieved the prices

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error

post/price/get-by-sku

Request samples

Payload

application/json

{"priceList": [100275,
100276
],
"sku": [1000019501,
1000019502
],
"itemId": [111111,
222222
],
"userId": "5e2cfb9b45570b000864c4b5",
"userProfile": {"Customer Type": ["Wholesale"
]
},
"isLoggedIn": true,
"channel": [12,
15
],
"date": "2019-08-24T14:15:22Z",
"priceParams": [{"options": {"length": "2",
"width": "15",
"blindMotor": true
},
"sku": "11111",
"quantity": 5,
"itemId": 12345
}
],
"audit": true
}

Response samples

application/json

[{"priceList": "100275",
"sku": "11111111",
"itemId": 11111111,
"offers": {"price": {"sale": 10,
"cost": 9,
"base": 10,
"finalPrice": 20,
"currency": "USD",
"totalPrice": 15
},
"kind": "1",
"channel": 12,
"discounts": [{"amount": 10,
"value": 20,
"groupId": "61a6354d0d70e30009415f16",
"promotionId": "6197ec46e836ff000952c668",
"priority": 1,
"stackable": true,
"title": "20% off",
"quantity": 5,
"promotionType": "COUPON",
"discountType": "PERCENTAGE"
}
]
},
"audit": true
}
]