Upsell Settings

Get store upselling settings

get

Retrieves upselling settings for the store.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

enabledbooleanRequired

automatic_recommendations_enabledbooleanRequired

automatic_recommendations_discount_typestring · enumRequiredPossible values:

automatic_recommendations_discount_amountinteger · int64Required

recommendation_overrides_enabledbooleanRequired

checkout_stylestring · enumRequiredPossible values:

updated_atstring · date-timeRequired

default

Error response

application/json

get/v1/stores/{storeId}/upsell-settings

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/upsell-settings HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "enabled": true,
  "automatic_recommendations_enabled": true,
  "automatic_recommendations_discount_type": "unknown",
  "automatic_recommendations_discount_amount": 1,
  "recommendation_overrides_enabled": true,
  "recommendation_overrides": [
    {
      "recommended_product_id": "411486491630370816",
      "type": "unknown",
      "discount_type": "unknown",
      "discount_amount": 1,
      "minimum_base_product_quantity": null,
      "quantity_to_add": null,
      "prefer_as_subscription": true
    }
  ],
  "checkout_style": "unknown",
  "updated_at": "2026-08-09T07:32:51.825Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Updates store upselling settings

patch

Updates upselling settings for a store.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

enabledbooleanOptional

automatic_recommendations_enabledbooleanOptional

automatic_recommendations_discount_typestring · enumOptionalPossible values:

automatic_recommendations_discount_amountinteger · int64Optional

recommendation_overrides_enabledbooleanOptional

checkout_stylestring · enumOptionalPossible values:

Responses

204

No Content

No content

default

Error response

application/json

patch/v1/stores/{storeId}/upsell-settings

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/upsell-settings HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 452

{
  "enabled": true,
  "automatic_recommendations_enabled": true,
  "automatic_recommendations_discount_type": "unknown",
  "automatic_recommendations_discount_amount": 1,
  "recommendation_overrides_enabled": true,
  "recommendation_overrides": [
    {
      "recommended_product_id": "411486491630370816",
      "type": "unknown",
      "discount_type": "unknown",
      "discount_amount": 1,
      "minimum_base_product_quantity": null,
      "quantity_to_add": null,
      "prefer_as_subscription": true
    }
  ],
  "checkout_style": "unknown"
}

application/jsontext/jsonapplication/*+json

No content