Abandoned Cart Emails
Abandoned Cart Emails V3 API managing Handlebars-based emails.
Get all abandoned cart email templates
GET /stores/{store_hash}/v3/marketing/abandoned-cart-emails
Request
An array of abandoned cart emails pertaining to a store.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- channel_id in query - integer
Channel ID to use for channel-level data.
example
Response
OK
Body
dataarray[object]
metaobject
Response metadata.
List of abandoned cart templates
Create abandoned cart email template
POST /stores/{store_hash}/v3/marketing/abandoned-cart-emails
Request
Create an Abandoned Cart Email template.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- channel_id in query - integer
Channel ID to use for channel-level data.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
is_activeboolean
coupon_codestring
Example: FF11-22X4
notify_at_minutesinteger
Describes when this email will be sent, in minutes. Only supports certain intervals described in the enum.
Allowed: 60 | 120 | 180 | 240 | 300 | 360 | 420 | 480 | 540 | 600 | 660 | 720 | 780 | 840 | 900 | 960 | 1020 | 1080 | 1140 | 1200 | 1260 | 1320 | 1380 | 1440 | 2880 | 4320 | 5760 | 7200 | 8640 | 10080 | 11520 | 12960 | 14400
Example: 60
templateobject
Add active abandoned cart email template
Response
OK
Body
dataobject
metaobject
Response metadata.
example
Get an email template
GET /stores/{store_hash}/v3/marketing/abandoned-cart-emails/{id}
Request
Get a single Abandoned Cart Email template.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the Abandoned Cart Email template.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
OK
Body
dataobject
metaobject
Response metadata.
example
Update an email template
PUT /stores/{store_hash}/v3/marketing/abandoned-cart-emails/{id}
Request
Update an email template.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the Abandoned Cart Email template.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
is_activeboolean
coupon_codestring
Example: FF11-22X4
notify_at_minutesinteger
Describes when this email will be sent, in minutes. Only supports certain intervals described in the enum.
Allowed: 60 | 120 | 180 | 240 | 300 | 360 | 420 | 480 | 540 | 600 | 660 | 720 | 780 | 840 | 900 | 960 | 1020 | 1080 | 1140 | 1200 | 1260 | 1320 | 1380 | 1440 | 2880 | 4320 | 5760 | 7200 | 8640 | 10080 | 11520 | 12960 | 14400
Example: 60
templateobject
Update Abandoned Cart Email template
Enable email
Disable email
Update coupon code and notification time
Response
OK
Body
dataobject
metaobject
Response metadata.
example
Delete email template
DELETE /stores/{store_hash}/v3/marketing/abandoned-cart-emails/{id}
Request
Delete Abandoned Cart Email template.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the Abandoned Cart Email template.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
No Content
Get default email template
GET /stores/{store_hash}/v3/marketing/abandoned-cart-emails/default
Request
Return default Abandoned Cart Email template.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
OK
Body
subjectstring
required>= 1 charactersbodystring
required>= 1 characterstranslationsarray[]
required