List all active upsell configuration rows for a merchant

https://api.kustom.co/config/checkout/v1/config/upsell

Returns all active value rows for this merchant across all configured countries.

Parameters

200

Example

Parameters1 field

• X-merchant-idstringrequiredin header

  Merchant identifier

200

Response13 fields

OK

• merchantIdstringoptional
• countrystringoptional
• upsellConfigobjectoptional

  The configuration for upsell features.

  7 fields in upsellConfig

  • disabledbooleanoptional

    Indicates whether the upsell feature is disabled. This takes precedence over the alwaysEnable flag.

  • alwaysEnablebooleanoptional

    Indicates whether the upsell feature should be enabled even if the upsell configs are missing on orders.

  • displayOptionsobjectoptional

    Display options for the upsell feature.

    3 fields in displayOptions

    • uiTimerDisabledbooleanoptional

      Indicates whether the timer should not be shown during upsell.

    • uiTimerDisabledCountries[]array<string>optional

      The countries in which the timer should not be shown during upsell.

    • imageAspectRatiostringoptional

      The aspect ratio of images shown on the upsell page.

  • durationSecondsinteger · int32optional

    The duration (in seconds) for which upsell will be available.

• revisioninteger · int64optional
• updatedBystringoptional
• updatedAtstring · date-timeoptional

GET https://api.kustom.co/config/checkout/v1/config/upsell

Response200

Response 200· OK

[
  {
    "merchantId": "<string>",
    "country": "<string>",
    "upsellConfig": {
      "disabled": false,
      "alwaysEnable": false,
      "displayOptions": {
        "uiTimerDisabled": false,
        "uiTimerDisabledCountries": [
          "US",
          "GB"
        ],
        "imageAspectRatio": "2:3"
      },
      "durationSeconds": 120
    },
    "revision": 0,
    "updatedBy": "<string>",
    "updatedAt": "<date-time>"
  }
]

22 linesCopy