Endpoint: https://api.omnisend.com/v3/carts
For "abandoned carts" workflow to work right - it's needed:
- integrate carts and orders API (backend api or frontend or mixed)
- integrate tracking from abandoned cart email part
Abandoned cart email tracking
- When user will click on link in abandoned cart email, we'll pass url parameters
omnisendContactID
and write them according toomnisendContactID
cookies. - Link example:
http://www.your-store.com/cartrestore/cart1234567/?omnisendContactID=4785497456
- when user will make order - pass back
cartID
along other order information - if your client will add products to basket and wont be logged in - use
omnisendContactID
cookie to identify user - if you need to get user's
email
fromcontactID
use API methodGET /contacts/{contactID}
Read more about abandoned cart integration in Guides part.
Parameters
Parameter | Type | Description |
---|---|---|
contactID | string | Contact's identifier |
cartID | string | Unique cart ID. Generate your own ID. Later you can use it to restore abandoned cart. |
string | Contact's email | |
phone | string | Contact's phone number |
createdAt | string | Cart creation date. ISO 8601 format. (example: 2017-05-30T14:11:12Z) |
updatedAt | string | Cart update date. ISO 8601 format. (example: 2017-05-30T14:11:12Z) |
currency | string | ISO 4217 currency code |
cartSum | integer | Cart total sum (with taxes and discounts) in cents. For example for 1.25 USD will be 125 |
cartRecoveryUrl | string(format:url) | Link to your store to restore abandoned cart. We'll add cartID query parameter to this link and use this link in abandoned cart workflow emails. When user clicks this link, your system should restore user cart. |
products | array of objects | Array of products (max 500) |
products.cartProductID | string | Product identificator in cart. Generate your own. |
products.productID | string | Product ID |
products.variantID | string | Product modification identificator |
products.sku | string | Product stock keeping unit |
products.title | string | Product or variant title |
products.description | string | Product description. We'll strip it to 30 words. |
products.quantity | integer | Quantity - only whole number. |
products.price | integer | Final price in cents (with discount, with taxes, etc.) |
products.oldPrice | integer | Products old price in cents (with discount, with taxes, etc.) |
products.discount | integer | Discount sum in cents. |
products.imageUrl | string | Link to product image |
products.productUrl | string | Link to product page |