Dynamic Pricing or Basket API
For your webshop, CloudSuite may choose to work with dynamic price calculation on the PLP, PDP, and Basket (a.k.a, https://cloudsuite.atlassian.net/wiki/spaces/CFL/pages/1800798286).
When the shop uses dynamic pricing, all prices are retrieved from your ERP system. The Basket / Dynamic Pricing API handles this functionality and calls to an external web service implemented by the customer. https://cloudsuite.atlassian.net/wiki/spaces/CFL/pages/1802502560/Data+API#Basket-API
When using Dynamic pricing, some features in the CloudSuite platform are limited in functionality, such as Prices, Discounts, Promotion bundles, and the use of coupons.
This functionality only works with the prices ex. VAT setting on shop level.
To ensure the correct prices are presented, the user needs to be registered and logged in to the webshop. Before login, we can show a generic price list.
Request
The call contains the party, product codes, and related quantities. It is also possible to support a price-UOM. This feature allows the customer to see the product price and another price like Kg or liters, comparing products to similar products based on price UOM.
Also, you can request multiple products to show prices on the product overview pages (PLP), for example.
URL
The customer defines the URL.
Method
POST
Mapping
Extrinsic Field | Description | Remarks |
---|---|---|
party | Code of the party | |
incTiers | Include tiers in the result | Tiers are only used for informational display on the Product Detail Page (PDP). |
page | the type of page doing the request | plp, pdp or basket |
lines | An array of product info | |
lines - price_info | An array of additonal info which can be shown on the page. | Only for the PDP, only text |
lines - product | Import_key of the product | |
lines - uom | the import_key of the UOM | Not needed in reponse |
lines - product_code | The code of the product | Not needed in reponse |
lines - quantity | Quantity | |
lines - grossprice | Grossprice | |
lines - discount | Discount in percent | |
lines - nettprice | Nettprice | |
lines - priceuom | The key to the price UOM | Necessary to show the correct price unit, when you want to show both the item price and a price per kilo or m2 (priceunit) OPTIONAL |
lines - priceuomprice | The price of the price unit | Necessary to show the correct price unit. This can be used when the customer wants to see the item price and price per UOM (kilo/m2, box). OPTIONAL |
Request single product (PDP)
{
"party": "14835FDG",
"incTiers": 1,
"page": "pdp",
"lines": [
{
"product": "21695_STK",
"uom": "STK",
"product_code": "21695",
"quantity": 3
}
]
}
Request multiple products (PLP)
{
"party": "14835FDG",
"page": "plp",
"lines": [
{
"product": "21695_STK",
"uom": "STK",
"product_code": "21695",
"quantity": 3
},
{
"product": "21456_STK",
"uom": "STK",
"product_code": "21456",
"quantity": 2
}
]
}
Request multiple products (basket)
{
"party": "14835FDG",
"page": "basket",
"lines": [
{
"product": "21695_STK",
"uom": "STK",
"product_code": "21695",
"quantity": 3
},
{
"product": "21456_STK",
"uom": "STK",
"product_code": "21456",
"quantity": 2
}
]
}
Response without price-uom (single product / PDP)
Response with price-UOM (single product / PDP)
Response (basket / PLP, multiple products)
Response with price-uom (basket / PLP, multiple products)
© 2024 CloudSuite BV, All rights reserved