Skip to main content
GET
/
v1
/
abandoned_checkout_protocol
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/abandoned_checkout_protocol \
  --header 'Authorization: Bearer <token>'
{
  "id": "85789eeb-dcf4-47a4-a2d4-176481547f39",
  "object": "abandoned_checkout_protocol",
  "enabled": false,
  "first_promotion_notification": null,
  "grace_period_days": 0,
  "ignore_purchased_products": false,
  "notification_delays": [
    3600,
    86400,
    432000
  ],
  "promotion_expires_after_days": null,
  "test_mode_enabled": true,
  "coupon": "3d76d094-38e7-46b4-b8ce-40214a51b521",
  "created_at": 1767909648,
  "updated_at": 1767909648
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
enabled
boolean

If set to true abandonded checkout reminder emails will be sent to customers.

​
first_promotion_notification
integer | null

The first notification that should have an auto-generated promotion code – can be one of 1, 2, 3 or null. For example, if set to 2 the promotion code will be generated when the second notification is sent. If null a promotion code will never be generated.

​
grace_period_days
integer

The number of days to wait after a customer's purchase before allowing an abandoned checkout to be created. This helps to prevent abandoned checkouts being created for customers very soon after they have made a purchase.

​
ignore_purchased_products
boolean

Whether or not to ignore checkouts where the customer has already purchased all of the products in the checkout.

​
notification_delays
array

The timing schedule for abandoned checkout notifications. It is an array of integers representing the delay in seconds for all notifications. For example, a value of [3600, 86400, 432000] indicates that notifications will be sent 1 hour, 24 hours, and 5 days after a checkout is abandoned. The number of notifications (items in array) must be between 1 and 3.

​
promotion_expires_after_days
integer | null

The number of days that the auto-generated promotion code should be valid for. If set to 'null' it is valid forever.

​
test_mode_enabled
boolean

Whether or not abandoned checkouts should be created for test mode checkouts.

​
coupon

The coupon that is used when creating discounts for abandoned checkouts.

Expandable – The associated coupon ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.