v1
latestOpenAPI 3.0.02026-07-2475182625.5 KBProducts
Retrieve product offers
Retrieves product offers based on a specific product_path and offer type.
get/products/offers/{product_path}
Path parameters
product_pathstring required
Unique identifier to reference a specific product, also known as the product path ID.
Query parameters
type'addon' | 'alternatives' | 'cross-sell' | 'crossgrade' | 'downgrade' | 'downsell' | 'upsell' | 'upgrade'
A specific type of offer available for the product.
Response
OK
Example response
{
"products": [
{
"action": "products.offers.get",
"result": "success",
"product": "basic-laptop",
"offers": [
{
"type": "cross-sell",
"display": {
"en": "Discover our complementary products to maximize your results."
},
"items": [
"wireless-mouse",
"keyboard-cover"
]
},
{
"type": "addon",
"display": {
"en": "Enhance your experience with additional features."
},
"items": [
"extra-storage"
]
},
{
"type": "upsell",
"display": {
"en": "Upgrade to the premium version for more features."
},
"items": [
"premium-laptop"
]
},
{
"type": "downsell",
"display": {
"en": "Switch to a more affordable version of the product."
},
"items": [
"basic-laptop"
]
}
]
}
]
}