---
title: "Search and filter upsell campaigns"
method: GET
path: "/upsell"
tags: ["Upsell"]
---

# Search and filter upsell campaigns

`GET /upsell`

Search and filter upsell campaigns

## Query parameters

- `Name` string
- `PrimaryProductCodes` string[]
- `RecommendedProductCodes` string[]
- `Statuses` string[]
- `StartsBefore` string
- `StartsAfter` string
- `EndsBefore` string
- `EndsAfter` string
- `EnabledForRenewals` boolean
- `CampaignCodes` string[]
- `Page` number
- `Limit` number

## Headers

- `X-Avangate-Authentication` string, required

## Response `200`

OK

- SearchUpsellResponse
  - `Page` integer — Current page number
  - `Limit` integer — Number of upsell campaigns in a page
  - `Upsells` UpsellResponse[] — Upsell collection from the current page
    - `Code` string — Uniquely generated campaign code
    - `Name` string — Name of campaign
    - `StartDate` string, nullable — When will campaign start
    - `EndDate` string, nullable — When will campaign end
    - `DisplayForManualRenewals` boolean — Flag that controls compaign display for manual renewals
    - `Discount` union
      - UpsellCampaignDiscountFixed
        - `Type` string — discount type (FIXED)
        - `Values` UpsellCampaignDiscountAmount[]
          - `Currency` string — price discount currency
          - `Amount` integer — price discount amount
        - `DefaultCurrency` string — discount default currency
      - UpsellCampaignDiscountPercent
        - `Type` string — discount type (PERCENT)
        - `Value` integer — the value of the percentage discount
    - `PrimaryProduct` UpsellCampaignProduct
      - `Code` string — Product code
      - `Quantity` integer — Product quantity (0 means any quantity)
      - `PriceOptions` UpsellCampaignProductPriceOption[]
        - `Code` string — Price option code
        - `Options` UpsellCampaignProductPriceOptionOption[]
          - `Code` string — Price option option code
          - `Value` integer, nullable — Value for price option option (inside the ScaleMin and ScaleMax range for that price option option)
    - `RecommendedProduct` UpsellCampaignProduct
      - `Code` string — Product code
      - `Quantity` integer — Product quantity (0 means any quantity)
      - `PriceOptions` UpsellCampaignProductPriceOption[]
        - `Code` string — Price option code
        - `Options` UpsellCampaignProductPriceOptionOption[]
          - `Code` string — Price option option code
          - `Value` integer, nullable — Value for price option option (inside the ScaleMin and ScaleMax range for that price option option)
    - `Enabled` boolean — Flag that controls if the compaign is enabled
    - `Description` UpsellCampaignLanguageDescription[] — The list of campaign language descriptions
      - `Language` string — language code
      - `Text` string — campaign text in the specified language code
  - `UpsellsCount` integer — Total number of filtered upsell campaigns
  - `PagesCount` integer — Total number of pages

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.dev/2checkout/apis/api-rest-documentation.md) · [All operations](https://skmtc.dev/2checkout/apis/api-rest-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/2checkout/api-rest-documentation/revisions/8a7ea610933e/schema)