Create or Update Product offers

This endpoint enables you to set or update related offers for a specific product. Related offers include various types such as upsell, cross-sell, downsell, upgrade, crossgrade, downgrade, addons, and alternatives. You can configure these offers to enhance the customer's shopping experience by suggesting complementary or alternative products.

Input

  • product-path (Path Parameter): A unique identifier for the product. It is used to specify the product for which you want to set or update Related Offers.
  • offer-type (request body): An array of objects specifying the related offers for the product. Each object contains the following attributes:
    • type: Describes the type of Related Offer. It can be one of the following:
    • "upsell": Encourages customers to purchase more expensive products.
    • "cross-sell": Offers related or complementary products.
    • "down-sell": Provides alternative products at a lower, more affordable price.
    • "upgrade": Suggests upgrading to a more advanced product.
    • "crossgrade": Suggests transitioning to a different but related product.
    • "downgrade": Suggests moving to a lower-tier product.
    • "addon": Offers additional items that can complement the main product.
    • "alternatives": Displays eligible items that can substitute the current product.
  • display: Contains localized display information for the Related Offer, providing a user-friendly label. (May be empty if not defined).
  • items: Lists the product identifiers associated with the Related Offer. These are the products that customers can choose when they select this offer.

Guidelines

  1. Updating an offer type replaces all existing offers of that same type for the product.
    1. For example, if you previously had a cross-sell offer configured for this product, updating it with a new cross-sell offer will replace the previous one.
  2. You can update multiple offer types in a single request.
    1. This allows you to efficiently configure various types of related offers for the same product in a unified process.
  3. You can provide multiple groups of the same offer type in the request.
    1. This enables you to offer multiple sets of Related Offers for different scenarios or customer segments.

Examples

Use Case: Create upgrade paths for the 'basic' plan

POST https://api.fastspring.com/products/offers/basic
//Request Body
{
    "products": [
        {
            "product": "basic",
            "offers": [
                {
                    "type": "upgrade",
                    "display": {
                        "en": "πŸš€ Supercharge your subscription with premium plans."
                    },
                    "items": [
                        "standard",
                        "pro",
                        "enterprise"
                    ]
                }
            ]
        }
    ]
}
{
    "product": "basic",
    "action": "products.offers.update",
    "result": "success"
}

Use Case: Setup cross-sell items for the 'basic' plan

POST https://api.fastspring.com/products/offers/basic
//Request Body
{
    "products": [
        {
            "product": "basic",
            "offers": [
                {
                    "type": "cross-sell",
                    "display": {
                        "en": "πŸ’‘ Discover our complementary products to maximize your results."
                    },
                    "items": [
                       "support-module",
                        "social-media-monitoring"
                    ]
                }
            ]
        }
    ]
}
{
    "product": "basic",
    "action": "products.offers.update",
    "result": "success"
}
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!