Skip to content

Get the forgotten-cart reminder

Try it

Whether the store sends ONE “you left something in your cart” email (in the business's name) to shoppers who ticked the box at checkout and left without ordering, after how many hours, its words, and the last 30 days' counts.

GET/api/v1/sites/{site_id}/store/cart-reminders

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the store:read scope — read store products, stock and orders.

store:readRead onlyMCP tool: get_cart_reminders

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringPath · required
The site's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl
curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/store/cart-reminders' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"
Example arguments
{
  "site_id": "SITE_ID"
}
Response schema
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Shoppers see “If I don't finish, email me one reminder about my cart” under Email at checkout; ticked carts get ONE reminder."
    },
    "hours": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Hours after the shopper's last cart change before the reminder goes (1–72)."
    },
    "subject": {
      "type": "string",
      "description": "The email subject; \"\" = \"You left something in your cart at {business}\"."
    },
    "words": {
      "type": "string",
      "description": "What the email says above the cart and the link; \"\" = the default words."
    },
    "last_30_days": {
      "type": "object",
      "properties": {
        "sent": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "came_back": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991,
          "description": "Opened “Back to my cart”."
        },
        "ordered": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991,
          "description": "Ordered after their reminder."
        },
        "waiting": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991,
          "description": "Carts kept with consent, not reminded yet."
        },
        "stopped": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991,
          "description": "Addresses that asked for no more cart reminders from this site (all time)."
        }
      },
      "required": [
        "sent",
        "came_back",
        "ordered",
        "waiting",
        "stopped"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "enabled",
    "hours",
    "subject",
    "words",
    "last_30_days"
  ],
  "additionalProperties": false
}