csharp
java
javascript
php
python
ruby
typescript

storefront

/storefront

Add to library

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/code_library

Parameters
Parameter Description Location Data Type Required
add_library_request New library item body AddLibraryItemRequest required
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get library values used to populate drop down boxes for filtering.

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/code_library/filter_values

Responses
Status Code Reason Response Model
200
 Successful response LibraryFilterValuesResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Retrieve library items

Permissions:
  • affiliate_read

Produces: application/json
post
/storefront/code_library/search

Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters
Parameter Description Location Data Type Required
item_query Item query body LibraryItemQuery required
_limit The maximum number of records to return on this one API call. (Maximum 10000)
Default: 10000 		query integer optional
_offset Pagination of the record set. Offset is a zero based index.
Default: 0 		query integer optional
_sort The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
Allowed Values
  • title
  • description
  • published_dts_begin
  • published_dts_end
  • price_low
  • price_high
  • category
  • industry
  • type
  • style
  • public_items
 query string optional
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Retrieve library items

Permissions:
  • affiliate_read

Produces: application/json
post
/storefront/code_library/search_published

Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters
Parameter Description Location Data Type Required
item_query Item query body LibraryItemQuery required
_limit The maximum number of records to return on this one API call. (Maximum 10000)
Default: 10000 		query integer optional
_offset Pagination of the record set. Offset is a zero based index.
Default: 0 		query integer optional
_sort The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
Allowed Values
  • title
  • description
  • published_dts_begin
  • published_dts_end
  • price_low
  • price_high
  • category
  • industry
  • type
  • style
  • public_items
 query string optional
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Retrieve library items

Permissions:
  • affiliate_read

Produces: application/json
post
/storefront/code_library/search_shared

Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters
Parameter Description Location Data Type Required
item_query Item query body LibraryItemQuery required
_limit The maximum number of records to return on this one API call. (Maximum 10000)
Default: 10000 		query integer optional
_offset Pagination of the record set. Offset is a zero based index.
Default: 0 		query integer optional
_sort The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
Allowed Values
  • title
  • description
  • published_dts_begin
  • published_dts_end
  • price_low
  • price_high
  • category
  • industry
  • type
  • style
  • public_items
 query string optional
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Delete library item

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/code_library/{library_item_oid}

Parameters
Parameter Description Location Data Type Required
library_item_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get library item.

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/code_library/{library_item_oid}

Parameters
Parameter Description Location Data Type Required
library_item_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update library item. Note that only certain fields may be updated via this method.

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/code_library/{library_item_oid}

Parameters
Parameter Description Location Data Type Required
library_item_oid ${parameter.description} path integer (int32) optional
library_item Library item body LibraryItem required
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Apply library item to storefront.

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/code_library/{library_item_oid}/applyToStoreFront/{storefront_oid}

Parameters
Parameter Description Location Data Type Required
library_item_oid ${parameter.description} path integer (int32) optional
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response ApplyLibraryItemResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Duplicate library item.

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/code_library/{library_item_oid}/duplicate

Parameters
Parameter Description Location Data Type Required
library_item_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Publish library item.

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/code_library/{library_item_oid}/publish

Parameters
Parameter Description Location Data Type Required
library_item_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Purchase public library item, which creates a copy of the item in your personal code library

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/code_library/{library_item_oid}/purchase

Parameters
Parameter Description Location Data Type Required
library_item_oid ${parameter.description} path integer (int32) optional
storefront_oid ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response LibraryItemResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email globalsettings

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/email/global_settings

Responses
Status Code Reason Response Model
200
 Successful response EmailGlobalSettingsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email global settings

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/email/global_settings

Parameters
Parameter Description Location Data Type Required
global_settings global settings request body EmailGlobalSettings required
Responses
Status Code Reason Response Model
200
 Successful response EmailGlobalSettingsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email sending domain

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/email/sending_domain/{domain}

Parameters
Parameter Description Location Data Type Required
domain ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSendingDomainResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email sending domains

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/email/sending_domains

Responses
Status Code Reason Response Model
200
 Successful response EmailSendingDomainsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

delete email campaign

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/email/sending_domains/{domain}

Parameters
Parameter Description Location Data Type Required
domain ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response BaseResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Create email campaign

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/email/sending_domains/{domain}/create

Parameters
Parameter Description Location Data Type Required
domain ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSendingDomainResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email sending domain status

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/email/sending_domains/{domain}/status

Parameters
Parameter Description Location Data Type Required
domain ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSendingDomainResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Searches for all matching values

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/search

Parameters
Parameter Description Location Data Type Required
category ${parameter.description} query string optional
matches ${parameter.description} query string optional
storefront_oid ${parameter.description} query string optional
max_hits ${parameter.description} query integer (int32) optional
subcategory ${parameter.description} query string optional
Responses
Status Code Reason Response Model
200
 Successful response LookupResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get thumbnail parameters

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/thumbnailParameters

Parameters
Parameter Description Location Data Type Required
thumbnail_parameters Thumbnail Parameters body ThumbnailParametersRequest required
Responses
Status Code Reason Response Model
200
 Successful response ThumbnailParametersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Gets editor token

Permissions:
  • storefront_read

get
/storefront/{storefront_oid}/editor_token

Fetches a temporary authentication token for the editor

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailEditorTokenResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email communication base templates

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/baseTemplates

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailBaseTemplateListResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email campaigns

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/campaigns

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCampaignsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Insert email campaign

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/campaigns

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_campaign Email campaign body EmailCampaign required
Responses
Status Code Reason Response Model
200
 Successful response EmailCampaignResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email campaign

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_campaign_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCampaignResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email campaign

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_campaign_uuid ${parameter.description} path string optional
email_campaign Email campaign body EmailCampaign required
Responses
Status Code Reason Response Model
200
 Successful response EmailCampaignResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Clone email campaign

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_campaign_uuid ${parameter.description} path string optional
target_storefront_oid ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCampaignResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email campaign screenshots

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/screenshots

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_campaign_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response ScreenshotsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Start email campaign

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_campaign_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response BaseResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email campaigns with stats

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/campaignsWithStats/{stat_days}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
stat_days ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCampaignsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email commseqs

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/commseqs

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Insert email commseq

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/commseqs

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_commseq Email commseq body EmailCommseq required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email commseq

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email commseq

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
email_commseq Email commseq body EmailCommseq required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email communication sequence emails stats

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
statsRequest StatsRequest body EmailStatSummaryRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailStatSummaryResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email communication sequence postcard stats

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
statsRequest StatsRequest body EmailStatPostcardSummaryRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailStatPostcardSummaryResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Delete communication sequence stats

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get communication sequence stats overall

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqStatResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email communication sequence step stats

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
statsRequest StatsRequest body EmailStepStatRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailStepStatResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email email clicks

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
commseq_step_uuid ${parameter.description} path string optional
commseq_email_uuid ${parameter.description} path string optional
days ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailClicksResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email email orders

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/orders

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
commseq_step_uuid ${parameter.description} path string optional
commseq_email_uuid ${parameter.description} path string optional
days ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailOrdersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email communication sequence customers waiting at each requested step

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
waitingRequest WaitingRequest body EmailStepWaitingRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailStepWaitingResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Release email communication sequence customers waiting at the specified step

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_uuid ${parameter.description} path string optional
commseq_step_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get countries

Permissions:
  • storefront_read

get
/storefront/{storefront_oid}/email/countries

Obtain a list of all the countries

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response CountriesResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email customers

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/customers

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
pageNumber ${parameter.description} query integer (int32) optional
pageSize ${parameter.description} query integer (int32) optional
searchEmailPrefix ${parameter.description} query string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCustomersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email customer

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/customers/{email_customer_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_customer_uuid ${parameter.description} path string optional
email_customer Email customer body EmailCustomer required
Responses
Status Code Reason Response Model
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get customers editor URL

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_customer_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCustomerEditorUrlResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email dashboard activity

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/dashboard_activity

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
last_records ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailDashboardActivityResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get dashboard stats

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/dashboard_stats

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
days ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailDashboardStatsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email emails

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/emails

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqEmailsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Insert email email

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/emails

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_commseq_email Email email body EmailCommseqEmail required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqEmailResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email emails multiple

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/{storefront_oid}/email/emails/multiple

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_commseq_emails_request Request of email uuids body EmailCommseqEmailsRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqEmailsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Delete email email

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_email_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response BaseResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email email

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_email_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqEmailResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email email

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_email_uuid ${parameter.description} path string optional
email_commseq_email Email commseq email body EmailCommseqEmail required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqEmailResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email order customer editor url

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_email_uuid ${parameter.description} path string optional
order_id ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCustomerEditorUrlResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Request a review of an email

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_email_uuid ${parameter.description} path string optional
email_commseq_email_review_request Email commseq email review request body EmailCommseqEmailSendTestRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqEmailSendTestResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Send email test

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_email_uuid ${parameter.description} path string optional
email_commseq_email_test_request Email commseq email test request body EmailCommseqEmailSendTestRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqEmailSendTestResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email flows

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/flows

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailFlowsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Insert email flow

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/flows

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_flow Email flow body EmailFlow required
Responses
Status Code Reason Response Model
200
 Successful response EmailFlowResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email flow

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/flows/{email_flow_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_flow_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailFlowResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email flow

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/flows/{email_flow_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_flow_uuid ${parameter.description} path string optional
email_flow Email flow body EmailFlow required
Responses
Status Code Reason Response Model
200
 Successful response EmailFlowResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Back populate email flow

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/backfill

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_flow_uuid ${parameter.description} path string optional
back_populate_request The request to back populate body EmailFlowBackPopulateRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailFlowBackPopulateResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Clone email flow

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_flow_uuid ${parameter.description} path string optional
target_storefront_oid ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailFlowResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email flow screenshots

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/screenshots

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_flow_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response ScreenshotsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Obtain lat/long for an address

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/{storefront_oid}/email/geocode

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
geocode_request geocode request body GeocodeRequest required
Responses
Status Code Reason Response Model
200
 Successful response GeocodeResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Globally unsubscribe a customer

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/globalUnsubscribe

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
unsubscribe Unsubscribe body EmailGlobalUnsubscribeRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailGlobalUnsubscribeResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get histogram property names

Permissions:
  • storefront_read

get
/storefront/{storefront_oid}/email/histogram/property_names

Obtain a list of property names for a given property type

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
property_type ${parameter.description} query string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailHistogramPropertyNamesResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get histogram property values

Permissions:
  • storefront_read

get
/storefront/{storefront_oid}/email/histogram/property_values

Obtain a list of property values for a given property name and type

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
property_name ${parameter.description} query string optional
property_type ${parameter.description} query string optional
limit ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailHistogramPropertyValuesResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email lists

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/lists

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailListsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Insert email list

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/lists

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list Email list body EmailList required
Responses
Status Code Reason Response Model
200
 Successful response EmailListResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email list

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/lists/{email_list_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailListResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email list

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/lists/{email_list_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list_uuid ${parameter.description} path string optional
email_list Email list body EmailList required
Responses
Status Code Reason Response Model
200
 Successful response EmailListResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Archive email list

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailListArchiveResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email list customers

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list_uuid ${parameter.description} path string optional
pageNumber ${parameter.description} query integer (int32) optional
pageSize ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailListCustomersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Delete email list customer

Permissions:
  • storefront_read

Produces: application/json
delete
/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list_uuid ${parameter.description} path string optional
email_customer_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response BaseResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email list customer editor url

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list_uuid ${parameter.description} path string optional
email_customer_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCustomerEditorUrlResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Search email list customers

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/lists/{email_list_uuid}/search

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list_uuid ${parameter.description} path string optional
startsWith ${parameter.description} query string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailListCustomersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Subscribe customers to email list

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_list_uuid ${parameter.description} path string optional
customers Customers body array of EmailCustomer required
Responses
Status Code Reason Response Model
200
 Successful response EmailListSubscribeResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email performance

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/performance

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailPerformanceResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email plan

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/plan

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailPlanResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email plan

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/plan

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
settings plan request body EmailPlan required
Responses
Status Code Reason Response Model
200
 Successful response EmailPlanResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email postcards

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/postcards

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqPostcardsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Insert email postcard

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/postcards

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_commseq_postcard Email postcard body EmailCommseqPostcard required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqPostcardResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email postcards multiple

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/{storefront_oid}/email/postcards/multiple

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_commseq_postcards_request Request of postcard uuids body EmailCommseqPostcardsRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqPostcardsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Delete email postcard

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_postcard_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response BaseResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email postcard

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_postcard_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqPostcardResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email postcard

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_postcard_uuid ${parameter.description} path string optional
email_commseq_postcard Email commseq postcard body EmailCommseqPostcard required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqPostcardResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Send postcard test

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
commseq_postcard_uuid ${parameter.description} path string optional
email_commseq_postcard_test_request Email commseq email test request body EmailCommseqPostcardSendTestRequest required
Responses
Status Code Reason Response Model
200
 Successful response EmailCommseqPostcardSendTestResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email segments

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/segments

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Insert email segment

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/segments

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment Email segment body EmailSegment required
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email segment

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/segments/{email_segment_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email segment

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/segments/{email_segment_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment_uuid ${parameter.description} path string optional
email_segment Email segment body EmailSegment required
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Archive email segment

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/archive

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentArchiveResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email segment customers

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment_uuid ${parameter.description} path string optional
pageNumber ${parameter.description} query integer (int32) optional
pageSize ${parameter.description} query integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentCustomersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email segment customers editor URL

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment_uuid ${parameter.description} path string optional
email_customer_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailCustomerEditorUrlResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Prepare download of email segment

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentDownloadPrepareResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Check download of email segment

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment_uuid ${parameter.description} path string optional
email_segment_rebuild_uuid ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentDownloadPrepareResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Search email segment customers

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/search

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_segment_uuid ${parameter.description} path string optional
startsWith ${parameter.description} query string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSegmentCustomersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email settings

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/settings

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailSettingsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update email settings

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/settings

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
settings settings request body EmailSettings required
Responses
Status Code Reason Response Model
200
 Successful response EmailSettingsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email templates

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/templates

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
trigger_type ${parameter.description} query string optional
Responses
Status Code Reason Response Model
200
 Successful response EmailTemplatesResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get email template

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/templates/{email_template_oid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_template_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailTemplate
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get a list of third party email providers

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/third_party_providers

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response EmailThirdPartyProvidersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Import a third party provider list

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/{storefront_oid}/email/third_party_providers/import

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
import_request lists to import body EmailThirdPartyListImportRequest required
Responses
Status Code Reason Response Model
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Get experiments

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/experiments

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response ExperimentsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Delete experiment

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/{storefront_oid}/experiments/{storefront_experiment_oid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
storefront_experiment_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update experiment

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/experiments/{storefront_experiment_oid}

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
storefront_experiment_oid ${parameter.description} path integer (int32) optional
experiment Experiment body Experiment required
Responses
Status Code Reason Response Model
200
 Successful response ExperimentResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Gets a list of transaction email names

Permissions:
  • storefront_read

get
/storefront/{storefront_oid}/transaction_email/list

Obtain a list of all transactional emails and return back just their names

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
Responses
Status Code Reason Response Model
200
 Successful response TransactionEmailListResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Gets a transaction email object

Permissions:
  • storefront_read

get
/storefront/{storefront_oid}/transaction_email/list/{email_id}

Fetch a transactional email

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_id ${parameter.description} path string optional
Responses
Status Code Reason Response Model
200
 Successful response TransactionEmailResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Updates a transaction email object

Permissions:
  • storefront_read

put
/storefront/{storefront_oid}/transaction_email/list/{email_id}

Updates a transactional email

Parameters
Parameter Description Location Data Type Required
storefront_oid ${parameter.description} path integer (int32) optional
email_id ${parameter.description} path string optional
transaction_email TransactionEmail body TransactionEmail required
Responses
Status Code Reason Response Model
200
 Successful response TransactionEmailResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

AddLibraryItemRequest

Attributes
Name Data Type Description
cjson string Cjson to be added to library
content_type string flow, campaign, cjson, email, transactional_email or upsell
description string description of library item
email_name string Required if content_type is transactional_email. This is the name of the email template (html, not text). This name should have a .vm file extension. An example is auto_order_cancel_html.vm
email_path string Required if content_type is transactional_email. This is the full path to the email template stored in the file system. This defines which StoreFront contains the desired email template. An example is /themes/Elements/core/emails/auto_order_cancel_html.vm
screenshots array of LibraryItemScreenshot Screenshot urls for display
storefront_oid integer (int32) StoreFront oid where content originates necessary for tracking down relative assets
title string title of library item, usually the name of the flow or campaign, or description of cjson
upsell_offer_oid integer (int32) Required if content_type is upsell. This is object identifier of a StoreFront Upsell Offer.
uuid string UUID of communication flow or campaign, null if this item is neither

ApplyLibraryItemResponse

Attributes
Name Data Type Description
cjson string Cjson from library item, only populated if this library item was a cjson snippet
content_type string flow, campaign, cjson, or upsell
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
storefront_oid integer (int32) StoreFront oid where content originates necessary for tracking down relative assets
success boolean Indicates if API call was successful
title string title of library item, usually the name of the flow or campaign, or description of cjson
uuid string UUID of communication flow or campaign if this library item was a campaign or flow
warning Warning Warning object if a non-fatal issue or side-effect occurs

BaseResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

CountriesResponse

Attributes
Name Data Type Description
countries array of Country

Country

Attributes
Name Data Type Description
iso_2_code string(2) iso_2_code
name string(50) name

Currency

Attributes
Name Data Type Description
currency_code string Currency code of the localized value
exchange_rate number Exchange rate used to localize
localized number Value localized to the customer
localized_formatted string Value localized and formatted for the customer
value number Value in base currency

EmailBaseTemplateListResponse

Attributes
Name Data Type Description
templatePaths array of string

EmailCampaign

Attributes
Name Data Type Description
click_rate_formatted (read only) string Click rate of emails
created_dts (read only) string (dateTime) Created date
deleted boolean True if this campaign was deleted
email_campaign_uuid (read only) string Email campaign UUID
email_communication_sequence_uuid (read only) string Email communication sequence UUID
end_once_customer_purchases (read only) boolean True if the customer should end the flow once they purchase
esp_domain_user string User of the sending address
esp_domain_uuid string UUID of the sending domain
esp_friendly_name string Friendly name of the sending email
memberships array of EmailListSegmentMembership List and segment memberships
merchant_id (read only) string Merchant ID
name string(250) Name of email campaign
open_rate_formatted (read only) string Open rate of emails
prevent_sending_due_to_spam boolean True if this campaign is prevented from sending at this time due to spam complaints.
revenue_formatted (read only) string Revenue associated with campaign
scheduled_dts string (dateTime) Scheduled date
screenshot_large_full_url string URL to a large full length screenshot
status string Status of the campaign of draft, archived, and sent
status_dts (read only) string (dateTime) Timestamp when the last status change happened
storefront_oid (read only) integer (int32) Storefront oid

EmailCampaignResponse

Attributes
Name Data Type Description
campaign EmailCampaign
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

EmailCampaignsResponse

Attributes
Name Data Type Description
campaigns array of EmailCampaign
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

EmailClick

Attributes
Name Data Type Description
click_count (read only) integer (int32) Click Count
url (read only) string url

EmailClicksResponse

Attributes
Name Data Type Description
clicks array of EmailClick
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

EmailCommseq

Attributes
Name Data Type Description
email_communication_sequence_steps array of EmailCommseqStep Array of steps
email_communication_sequence_uuid (read only) string Email commseq UUID
merchant_id (read only) string Merchant ID
storefront_oid (read only) integer (int32) Storefront oid

EmailCommseqEmail

Attributes
Name Data Type Description
deleted boolean Deleted
edited_by_user string Edited by user
email_communication_sequence_email_uuid string Email communication sequence email uuid
email_communication_sequence_uuid (read only) string Email commseq UUID
email_container_cjson string Email container cjson
email_container_cjson_last_modified_dts string (dateTime) Timestamp the last time the container was modified.
email_template_vm_path string Email template virtual path
filter_profile_equation_json string Filter profile equation json
individually_render boolean Individually render
merchant_id (read only) string Merchant ID
pending_review (read only) boolean True if the content of this email is pending review by UltraCart
preview_text string Preview text
rejected (read only) boolean True if the content of this email was rejected during review by UltraCart
requires_review (read only) boolean True if the content of this email is requires review by UltraCart
screenshot_large_full_url (read only) string URL to screenshot in large form factor full page
screenshot_large_viewport_url (read only) string URL to screenshot in large form factor viewport
screenshot_small_full_url (read only) string URL to screenshot in small form factor full page
screenshot_small_viewport_url (read only) string URL to screenshot in small form factor viewport
smart_sending boolean Smart sending
storefront_oid (read only) integer (int32) Storefront oid
subject string Subject
transactional_email boolean Transactional email
version integer (int32) Version

EmailCommseqEmailResponse

Attributes
Name Data Type Description
email EmailCommseqEmail
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

EmailCommseqEmailSendTestRequest

Attributes
Name Data Type Description
cart_id string
cart_item_ids array of string
esp_commseq_email_uuid string
esp_commseq_step_uuid string
esp_commseq_uuid string
name string
order_id string
please_review boolean
send_to_additional_emails array of string
send_to_logged_in_user boolean

EmailCommseqEmailSendTestResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

EmailCommseqEmailsRequest

Attributes
Name Data Type Description
error Error Error object if unsuccessful
esp_commseq_email_uuids array of string