Upsell

Search and filter upsell campaigns

get

Search and filter upsell campaigns

Query parameters

NamestringOptional

The title of the campaign

PrimaryProductCodesstring[]Optional

Array of primary product codes

RecommendedProductCodesstring[]Optional

Array of recommended product codes

StartsBeforestringOptional

The UTC date in Y-m-d format

Example: 2019-11-05

StartsAfterstringOptional

The UTC date in Y-m-d format

Example: 2019-11-05

EndsBeforestringOptional

The UTC date in Y-m-d format

Example: 2022-11-10

EndsAfterstringOptional

The UTC date in Y-m-d format

Example: 2020-10-02

EnabledForRenewalsbooleanOptional

Retrieve upsells that are or are not enabled for renewals

CampaignCodesstring[]Optional

Array of campaign UUIDs

PagenumberOptional

Page number

LimitnumberOptional

Number of campaigns per page

Header parameters

X-Avangate-AuthenticationstringRequired

Responses

200

OK

application/jsonapplication/xml

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/upsell

HTTPcURLJavaScriptPython

GET /rest/6.0/upsell HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: text
Accept: */*

{
  "Page": 1,
  "Limit": 1,
  "Upsells": [
    {
      "Code": "65d44020-66f3-4c7c-a391-93039cef839a",
      "Name": "Christmas Upsell campaign",
      "StartDate": "2020-12-25",
      "EndDate": "2021-12-27",
      "DisplayForManualRenewals": true,
      "Discount": {
        "Type": "FIXED",
        "Values": [
          {
            "Currency": "EUR",
            "Amount": 10
          }
        ],
        "DefaultCurrency": "EUR"
      },
      "PrimaryProduct": {
        "Code": "PC202012",
        "Quantity": 1,
        "PriceOptions": [
          {
            "Code": "POC1122",
            "Options": [
              {
                "Code": "POOCODE445",
                "Value": 1
              }
            ]
          }
        ]
      },
      "RecommendedProduct": {
        "Code": "PC202012",
        "Quantity": 1,
        "PriceOptions": [
          {
            "Code": "POC1122",
            "Options": [
              {
                "Code": "POOCODE445",
                "Value": 1
              }
            ]
          }
        ]
      },
      "Enabled": true,
      "Description": [
        {
          "Language": "EN",
          "Text": "Buy <!--{RECOMMENDED_PRODUCT_NAME}--> for just <!--{RECOMMENDED_PRODUCT_PRICE}--> until Dec 31st"
        }
      ]
    }
  ],
  "UpsellsCount": 1,
  "PagesCount": 1
}

Create Upsell campaign

post

Header parameters

X-Avangate-AuthenticationstringRequiredExample: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Body

application/json

NamestringRequired

Name of campaign, max 500 chars.

Example: Christmas Upsell campaign

StartDatestring · nullableOptional

When will campaign start

Example: 2020-12-25

EndDatestring · nullableOptional

When should campaign end

Example: 2021-12-27

DisplayForManualRenewalsbooleanRequired

Flag that controls compaign display for manual renewals

Example: true

Discountone ofRequired

or

EnabledbooleanRequired

Flag that controls if the compaign is enabled

Example: true

Responses

200

Create campaign response

application/json

400

Create campaign error response

application/json

post

/upsell

HTTPcURLJavaScriptPython

POST /rest/6.0/upsell HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Content-Type: application/json
Accept: */*
Content-Length: 629

{
  "Name": "Christmas Upsell campaign",
  "StartDate": "2020-12-25",
  "EndDate": "2021-12-27",
  "DisplayForManualRenewals": true,
  "Discount": {
    "Type": "FIXED",
    "Values": [
      {
        "Currency": "EUR",
        "Amount": 10
      }
    ],
    "DefaultCurrency": "EUR"
  },
  "PrimaryProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "RecommendedProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "Enabled": true,
  "Description": [
    {
      "Language": "EN",
      "Text": "Buy <!--{RECOMMENDED_PRODUCT_NAME}--> for just <!--{RECOMMENDED_PRODUCT_PRICE}--> until Dec 31st"
    }
  ]
}

{
  "Code": "65d44020-66f3-4c7c-a391-93039cef839a",
  "Name": "Christmas Upsell campaign",
  "StartDate": "2020-12-25",
  "EndDate": "2021-12-27",
  "DisplayForManualRenewals": true,
  "Discount": {
    "Type": "FIXED",
    "Values": [
      {
        "Currency": "EUR",
        "Amount": 10
      }
    ],
    "DefaultCurrency": "EUR"
  },
  "PrimaryProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "RecommendedProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "Enabled": true,
  "Description": [
    {
      "Language": "EN",
      "Text": "Buy <!--{RECOMMENDED_PRODUCT_NAME}--> for just <!--{RECOMMENDED_PRODUCT_PRICE}--> until Dec 31st"
    }
  ]
}

Get the recommended campaign based on product settings

get

Query parameters

ProductCodestringRequired

The primary product code

Example: PC202012

QuantityintegerOptional

The quantity for the primary product

Example: 1

PriceOptionsstringOptional

The price options for the primary product

EnabledForRenewalsbooleanOptional

Returns only upsell campaigns that are (or not) enabled for renewals

Header parameters

X-Avangate-AuthenticationstringRequiredExample: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

Found recommended campaign

application/json

400

Get recommended campaign error response

application/json

404

Recommended campaign not found

application/json

get

/upsell/recommended

HTTPcURLJavaScriptPython

GET /rest/6.0/upsell/recommended?ProductCode=PC202012 HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: */*

{
  "Code": "65d44020-66f3-4c7c-a391-93039cef839a",
  "Name": "Christmas Upsell campaign",
  "StartDate": "2020-12-25",
  "EndDate": "2021-12-27",
  "DisplayForManualRenewals": true,
  "Discount": {
    "Type": "FIXED",
    "Values": [
      {
        "Currency": "EUR",
        "Amount": 10
      }
    ],
    "DefaultCurrency": "EUR"
  },
  "PrimaryProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "RecommendedProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "Enabled": true,
  "Description": [
    {
      "Language": "EN",
      "Text": "Buy <!--{RECOMMENDED_PRODUCT_NAME}--> for just <!--{RECOMMENDED_PRODUCT_PRICE}--> until Dec 31st"
    }
  ]
}

Update Upsell campaign

put

Update Upsell campaign

Path parameters

upsellCodestringRequired

Header parameters

X-Avangate-AuthenticationstringRequired

Body

application/json

NamestringRequired

Name of campaign, max 500 chars.

Example: Christmas Upsell campaign

StartDatestring · nullableOptional

When will campaign start

Example: 2020-12-25

EndDatestring · nullableOptional

When should campaign end

Example: 2021-12-27

DisplayForManualRenewalsbooleanRequired

Flag that controls compaign display for manual renewals

Example: true

Discountone ofRequired

or

EnabledbooleanRequired

Flag that controls if the compaign is enabled

Example: true

Responses

200

OK

application/json

400

Bad Request

put

/upsell/{upsellCode}

HTTPcURLJavaScriptPython

PUT /rest/6.0/upsell/{upsellCode} HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: text
Content-Type: application/json
Accept: */*
Content-Length: 629

{
  "Name": "Christmas Upsell campaign",
  "StartDate": "2020-12-25",
  "EndDate": "2021-12-27",
  "DisplayForManualRenewals": true,
  "Discount": {
    "Type": "FIXED",
    "Values": [
      {
        "Currency": "EUR",
        "Amount": 10
      }
    ],
    "DefaultCurrency": "EUR"
  },
  "PrimaryProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "RecommendedProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "Enabled": true,
  "Description": [
    {
      "Language": "EN",
      "Text": "Buy <!--{RECOMMENDED_PRODUCT_NAME}--> for just <!--{RECOMMENDED_PRODUCT_PRICE}--> until Dec 31st"
    }
  ]
}

{
  "Code": "65d44020-66f3-4c7c-a391-93039cef839a",
  "Name": "Christmas Upsell campaign",
  "StartDate": "2020-12-25",
  "EndDate": "2021-12-27",
  "DisplayForManualRenewals": true,
  "Discount": {
    "Type": "FIXED",
    "Values": [
      {
        "Currency": "EUR",
        "Amount": 10
      }
    ],
    "DefaultCurrency": "EUR"
  },
  "PrimaryProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "RecommendedProduct": {
    "Code": "PC202012",
    "Quantity": 1,
    "PriceOptions": [
      {
        "Code": "POC1122",
        "Options": [
          {
            "Code": "POOCODE445",
            "Value": 1
          }
        ]
      }
    ]
  },
  "Enabled": true,
  "Description": [
    {
      "Language": "EN",
      "Text": "Buy <!--{RECOMMENDED_PRODUCT_NAME}--> for just <!--{RECOMMENDED_PRODUCT_PRICE}--> until Dec 31st"
    }
  ]
}

Delete an Upsell campaign

delete

Delete Upsell campaign

Path parameters

upsellCodestringRequired

Header parameters

X-Avangate-AuthenticationstringRequiredExample: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

AcceptstringRequiredExample: application/json

Responses

204

OK

No content

400

Delete campaign error response

application/json

delete

/upsell/{upsellCode}

HTTPcURLJavaScriptPython

DELETE /rest/6.0/upsell/{upsellCode} HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json

No content

Get Upsell campaig settings by vendor

get

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

Returns Upsell campaign settings

application/json

get

/upsell/settings/campaign/

HTTPcURLJavaScriptPython

GET /rest/6.0/upsell/settings/campaign/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

200

Returns Upsell campaign settings

{
  "UpsellingDisplayType": "overlay"
}

Update Upsell campaign settings

put

Update Upsell campaign settings displayType

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Body

application/json

UpsellingDisplayTypestringRequired

Update displayType setting

Example: overlay

Responses

200

OK

application/json

400

Upsell campaign settings error response

application/json

put

/upsell/settings/campaign/

HTTPcURLJavaScriptPython

PUT /rest/6.0/upsell/settings/campaign/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "UpsellingDisplayType": "overlay"
}

{
  "UpsellingDisplayType": "overlay"
}