Marketing

Gets the abandoned checkout behaviour for a store

get

Authorizations

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/marketing/abandoned-checkouts/configuration

GET /v1/stores/{storeId}/marketing/abandoned-checkouts/configuration HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "store_id": "411486491630370816",
  "enabled": true,
  "invalid": true,
  "trigger_after": "P1Y2M3DT4H5M6S",
  "minimum_order_value": 1,
  "maximum_order_value": null,
  "max_coupons_per_customer_amount": null,
  "max_coupons_per_customer_period": "P1Y2M3DT4H5M6S",
  "max_coupons_global_amount": null,
  "max_coupons_global_period": "P1Y2M3DT4H5M6S",
  "coupon_configuration": {
    "duration": "once",
    "duration_in_months": null,
    "discount_type": "unspecified",
    "discount_amount": 1,
    "discount_only_required_tags_or_products": true,
    "discount_apply_before_sales": true,
    "required_tag_ids": [
      "411486491630370816"
    ],
    "required_product_ids": [
      "411486491630370816"
    ],
    "minimum_order_value": 1,
    "customer_redeem_limit_enabled": true,
    "customer_redeem_limit": 1,
    "usable_on_one_time_purchases": true,
    "usable_on_subscriptions": true,
    "expires_after": "P1Y2M3DT4H5M6S"
  },
  "commands": [
    {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "command": "text",
      "online_only": true
    }
  ],
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-12-12T13:18:48.922Z"
}

Sets the abandoned checkout behaviour for a store

put

Authorizations

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

Used for updating the store-level configuration for abandoned checkout settings.

enabledbooleanRequired

A value indicating whether the abandoned checkout feature is enabled for the store.

trigger_afterstring · periodRequired

ISO 8601 duration format

Example: P1Y2M3DT4H5M6S

minimum_order_valueinteger · int64Required

The minimum order value required to trigger an abandoned checkout email.

maximum_order_valuenull | integerOptional

The optional maximum order value beyond which an abandoned checkout email will not be sent.

max_coupons_per_customer_amountnull | integerOptional

The optional maximum coupons limit per customer beyond which an abandoned checkout email will not be sent.

max_coupons_per_customer_periodstring · periodOptional

ISO 8601 duration format

Example: P1Y2M3DT4H5M6S

max_coupons_global_amountnull | integerOptional

The optional maximum coupons limit store wide beyond which an abandoned checkout email will not be sent.

max_coupons_global_periodstring · periodOptional

ISO 8601 duration format

Example: P1Y2M3DT4H5M6S

Responses

200

application/json

204

No Content

default

Error response

application/json

put

/v1/stores/{storeId}/marketing/abandoned-checkouts/configuration

PUT /v1/stores/{storeId}/marketing/abandoned-checkouts/configuration HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 795

{
  "enabled": true,
  "trigger_after": "P1Y2M3DT4H5M6S",
  "minimum_order_value": 1,
  "maximum_order_value": null,
  "max_coupons_per_customer_amount": null,
  "max_coupons_per_customer_period": "P1Y2M3DT4H5M6S",
  "max_coupons_global_amount": null,
  "max_coupons_global_period": "P1Y2M3DT4H5M6S",
  "commands": [
    {
      "command": "text",
      "online_only": true
    }
  ],
  "coupon_configuration": {
    "duration": "once",
    "duration_in_months": null,
    "discount_type": "unspecified",
    "discount_amount": 1,
    "discount_only_required_tags_or_products": true,
    "discount_apply_before_sales": true,
    "required_tag_ids": [
      "411486491630370816"
    ],
    "required_product_ids": [
      "411486491630370816"
    ],
    "minimum_order_value": 1,
    "customer_redeem_limit_enabled": true,
    "customer_redeem_limit": 1,
    "usable_on_one_time_purchases": true,
    "usable_on_subscriptions": true,
    "expires_after": "P1Y2M3DT4H5M6S"
  }
}

{
  "store_id": "411486491630370816",
  "enabled": true,
  "invalid": true,
  "trigger_after": "P1Y2M3DT4H5M6S",
  "minimum_order_value": 1,
  "maximum_order_value": null,
  "max_coupons_per_customer_amount": null,
  "max_coupons_per_customer_period": "P1Y2M3DT4H5M6S",
  "max_coupons_global_amount": null,
  "max_coupons_global_period": "P1Y2M3DT4H5M6S",
  "coupon_configuration": {
    "duration": "once",
    "duration_in_months": null,
    "discount_type": "unspecified",
    "discount_amount": 1,
    "discount_only_required_tags_or_products": true,
    "discount_apply_before_sales": true,
    "required_tag_ids": [
      "411486491630370816"
    ],
    "required_product_ids": [
      "411486491630370816"
    ],
    "minimum_order_value": 1,
    "customer_redeem_limit_enabled": true,
    "customer_redeem_limit": 1,
    "usable_on_one_time_purchases": true,
    "usable_on_subscriptions": true,
    "expires_after": "P1Y2M3DT4H5M6S"
  },
  "commands": [
    {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "command": "text",
      "online_only": true
    }
  ],
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-12-12T13:18:48.922Z"
}

Gets the purchase follow up behaviour for a store

get

Authorizations

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/marketing/purchase-follow-ups/configuration

GET /v1/stores/{storeId}/marketing/purchase-follow-ups/configuration HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "store_id": "411486491630370816",
  "enabled": true,
  "invalid": true,
  "trigger_after": "P1Y2M3DT4H5M6S",
  "minimum_order_value": 1,
  "maximum_order_value": null,
  "max_coupons_per_customer_amount": null,
  "max_coupons_per_customer_period": "P1Y2M3DT4H5M6S",
  "max_coupons_global_amount": null,
  "max_coupons_global_period": "P1Y2M3DT4H5M6S",
  "coupon_configuration": {
    "duration": "once",
    "duration_in_months": null,
    "discount_type": "unspecified",
    "discount_amount": 1,
    "discount_only_required_tags_or_products": true,
    "discount_apply_before_sales": true,
    "required_tag_ids": [
      "411486491630370816"
    ],
    "required_product_ids": [
      "411486491630370816"
    ],
    "minimum_order_value": 1,
    "customer_redeem_limit_enabled": true,
    "customer_redeem_limit": 1,
    "usable_on_one_time_purchases": true,
    "usable_on_subscriptions": true,
    "expires_after": "P1Y2M3DT4H5M6S"
  },
  "commands": [
    {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "command": "text",
      "online_only": true
    }
  ],
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-12-12T13:18:48.922Z"
}

Sets the purchase follow up behaviour for a store

put

Authorizations

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

Used for updating the store-level configuration for abandoned checkout settings.

enabledbooleanRequired

A value indicating whether the abandoned checkout feature is enabled for the store.

trigger_afterstring · periodRequired

ISO 8601 duration format

Example: P1Y2M3DT4H5M6S

minimum_order_valueinteger · int64Required

The minimum order value required to trigger an abandoned checkout email.

maximum_order_valuenull | integerOptional

The optional maximum order value beyond which an abandoned checkout email will not be sent.

max_coupons_per_customer_amountnull | integerOptional

The optional maximum coupons limit per customer beyond which an abandoned checkout email will not be sent.

max_coupons_per_customer_periodstring · periodOptional

ISO 8601 duration format

Example: P1Y2M3DT4H5M6S

max_coupons_global_amountnull | integerOptional

The optional maximum coupons limit store wide beyond which an abandoned checkout email will not be sent.

max_coupons_global_periodstring · periodOptional

ISO 8601 duration format

Example: P1Y2M3DT4H5M6S

Responses

200

application/json

204

No Content

default

Error response

application/json

put

/v1/stores/{storeId}/marketing/purchase-follow-ups/configuration

PUT /v1/stores/{storeId}/marketing/purchase-follow-ups/configuration HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 795

{
  "enabled": true,
  "trigger_after": "P1Y2M3DT4H5M6S",
  "minimum_order_value": 1,
  "maximum_order_value": null,
  "max_coupons_per_customer_amount": null,
  "max_coupons_per_customer_period": "P1Y2M3DT4H5M6S",
  "max_coupons_global_amount": null,
  "max_coupons_global_period": "P1Y2M3DT4H5M6S",
  "commands": [
    {
      "command": "text",
      "online_only": true
    }
  ],
  "coupon_configuration": {
    "duration": "once",
    "duration_in_months": null,
    "discount_type": "unspecified",
    "discount_amount": 1,
    "discount_only_required_tags_or_products": true,
    "discount_apply_before_sales": true,
    "required_tag_ids": [
      "411486491630370816"
    ],
    "required_product_ids": [
      "411486491630370816"
    ],
    "minimum_order_value": 1,
    "customer_redeem_limit_enabled": true,
    "customer_redeem_limit": 1,
    "usable_on_one_time_purchases": true,
    "usable_on_subscriptions": true,
    "expires_after": "P1Y2M3DT4H5M6S"
  }
}

{
  "store_id": "411486491630370816",
  "enabled": true,
  "invalid": true,
  "trigger_after": "P1Y2M3DT4H5M6S",
  "minimum_order_value": 1,
  "maximum_order_value": null,
  "max_coupons_per_customer_amount": null,
  "max_coupons_per_customer_period": "P1Y2M3DT4H5M6S",
  "max_coupons_global_amount": null,
  "max_coupons_global_period": "P1Y2M3DT4H5M6S",
  "coupon_configuration": {
    "duration": "once",
    "duration_in_months": null,
    "discount_type": "unspecified",
    "discount_amount": 1,
    "discount_only_required_tags_or_products": true,
    "discount_apply_before_sales": true,
    "required_tag_ids": [
      "411486491630370816"
    ],
    "required_product_ids": [
      "411486491630370816"
    ],
    "minimum_order_value": 1,
    "customer_redeem_limit_enabled": true,
    "customer_redeem_limit": 1,
    "usable_on_one_time_purchases": true,
    "usable_on_subscriptions": true,
    "expires_after": "P1Y2M3DT4H5M6S"
  },
  "commands": [
    {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "command": "text",
      "online_only": true
    }
  ],
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-12-12T13:18:48.922Z"
}

PreviousGlobal Commands NextNavlinks

Last updated 1 day ago

Was this helpful?