csharp

java

javascript

php

python

ruby

typescript

storefront

/storefront




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.storefront
{
    public class introduction
    {

        [Test]
        public void ExecuteTest()
        {
            // Please see the README.md in this directory for an explanation about StoreFrontApi samples.
        }

        public static void introductionCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new StorefrontApi(simpleKey);
        }


    }
}

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get storefronts (internal use only for security reasons)

Produces: application/json

get

/storefront

SDK Function Name: getStoreFronts

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Add to library

Permissions:
Produces: application/json

post

/storefront/code_library

SDK Function Name: addToLibrary

Parameters

Parameter	Description	Location	Data Type	Required
add_library_request	New library item request	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Internal API - no sample for this method.// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Apply library item to storefront.

Permissions:
Produces: application/json

post

/storefront/code_library/apply

SDK Function Name: applyToStoreFront

Parameters

Parameter	Description	Location	Data Type	Required
apply_library_request	New library item	body	ApplyLibraryItemRequest	required

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Internal API - no sample for this method.// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

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

Permissions:
Produces: application/json

get

/storefront/code_library/filter_values

SDK Function Name: getLibraryFilterValues

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Retrieve library items

Permissions:
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.

SDK Function Name: searchLibraryItems

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Retrieve library items

Permissions:
Produces: application/json

post

/storefront/code_library/search_published

SDK Function Name: searchPublishedItems

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Retrieve library items needing review or rejected

Permissions:
Produces: application/json

post

/storefront/code_library/search_review

SDK Function Name: searchReviewItems

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Retrieve library items

Permissions:
Produces: application/json

post

/storefront/code_library/search_shared

SDK Function Name: searchSharedItems

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete library item

Permissions:
Produces: application/json

delete

/storefront/code_library/{library_item_oid}

SDK Function Name: deleteLibraryItem

Parameters

Parameter	Description	Location	Data Type	Required
library_item_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get library item.

Permissions:
Produces: application/json

get

/storefront/code_library/{library_item_oid}

SDK Function Name: getLibraryItem

Parameters

Parameter	Description	Location	Data Type	Required
library_item_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

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

Permissions:
Produces: application/json

put

/storefront/code_library/{library_item_oid}

SDK Function Name: updateLibraryItem

Parameters

Parameter	Description	Location	Data Type	Required
library_item_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Duplicate library item.

Permissions:
Produces: application/json

post

/storefront/code_library/{library_item_oid}/duplicate

SDK Function Name: duplicateLibraryItem

Parameters

Parameter	Description	Location	Data Type	Required
library_item_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Publish library item.

Permissions:
Produces: application/json

post

/storefront/code_library/{library_item_oid}/publish

SDK Function Name: publishLibraryItem

Parameters

Parameter	Description	Location	Data Type	Required
library_item_oid		path	integer (int32)	optional
publish_library_request	Publish library item request	body	PublishLibraryItemRequest	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete all published versions for a library item, including anything in review.

Permissions:
Produces: application/json

delete

/storefront/code_library/{library_item_oid}/published_versions

SDK Function Name: deleteLibraryItemPublishedVersions

Parameters

Parameter	Description	Location	Data Type	Required
library_item_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get all published versions for a library item.

Permissions:
Produces: application/json

get

/storefront/code_library/{library_item_oid}/published_versions

SDK Function Name: getLibraryItemPublishedVersions

Parameters

Parameter	Description	Location	Data Type	Required
library_item_oid		path	integer (int32)	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

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

Permissions:
Produces: application/json

post

/storefront/code_library/{library_item_oid}/purchase

SDK Function Name: purchaseLibraryItem

Parameters

Parameter	Description	Location	Data Type	Required
library_item_oid		path	integer (int32)	optional
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email globalsettings

Permissions:
Produces: application/json

get

/storefront/email/global_settings

SDK Function Name: getEmailGlobalSettings

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email global settings

Permissions:
Produces: application/json

post

/storefront/email/global_settings

SDK Function Name: updateEmailGlobalSettings

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email sending domain

Permissions:
Produces: application/json

get

/storefront/email/sending_domain/{domain}

SDK Function Name: getEmailSendingDomain

Parameters

Parameter	Description	Location	Data Type	Required
domain		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email sending domains

Permissions:
Produces: application/json

get

/storefront/email/sending_domains

SDK Function Name: getEmailSendingDomains

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Create email sending domain for various providers

Permissions:
Produces: application/json

post

/storefront/email/sending_domains

SDK Function Name: createEmailSendingDomain2

Parameters

Parameter	Description	Location	Data Type	Required
email_domain	EmailDomain	body	EmailDomain	required

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

# Internal API.  No samples are provided as merchants will never need this api method

delete email campaign

Permissions:
Produces: application/json

delete

/storefront/email/sending_domains/{domain}

SDK Function Name: deleteEmailSendingDomain

Parameters

Parameter	Description	Location	Data Type	Required
domain		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email sending domain

Permissions:
Produces: application/json

put

/storefront/email/sending_domains/{domain}

SDK Function Name: updateEmailSendingDomain

Parameters

Parameter	Description	Location	Data Type	Required
domain		path	string	optional
email_domain	EmailDomain	body	EmailDomain	required

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Create email campaign

Permissions:
Produces: application/json

post

/storefront/email/sending_domains/{domain}/create

SDK Function Name: createEmailSendingDomain

Parameters

Parameter	Description	Location	Data Type	Required
domain		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email sending domain status

Permissions:
Produces: application/json

post

/storefront/email/sending_domains/{domain}/status

SDK Function Name: getEmailSendingDomainStatus

Parameters

Parameter	Description	Location	Data Type	Required
domain		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Retrieve pricing tiers

Permissions:
Produces: application/json

get

/storefront/pricing_tiers

Retrieves the pricing tiers

SDK Function Name: getStoreFrontPricingTiers

Parameters

Parameter	Description	Location	Data Type	Required
_expand	The object expansion to perform on the result. See documentation for examples	query	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Validate AWS Event Ruler

Permissions:
Produces: application/json

post

/storefront/ruler/validate

SDK Function Name: validateRuler

Parameters

Parameter	Description	Location	Data Type	Required
ruler_validate_request	Ruler Validate Request	body	RulerValidationRequest	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Searches for all matching values

Permissions:
Produces: application/json

get

/storefront/search

SDK Function Name: search

Parameters

Parameter	Location	Data Type	Required
category	query	string	optional
matches	query	string	optional
storefront_oid	query	string	optional
max_hits	query	integer (int32)	optional
subcategory	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Searches for all matching values (using POST)

Permissions:
Produces: application/json

post

/storefront/search

SDK Function Name: search2

Parameters

Parameter	Description	Location	Data Type	Required
lookup_request	LookupRequest	body	LookupRequest	required

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get thumbnail parameters

Permissions:
Produces: application/json

post

/storefront/thumbnailParameters

SDK Function Name: getThumbnailParameters

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get all Twilio accounts

Permissions:
Produces: application/json

get

/storefront/twilio/accounts

SDK Function Name: getTwilioAccounts

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Create Twilio account

Permissions:
Produces: application/json

post

/storefront/twilio/accounts

SDK Function Name: createTwilioAccount

Parameters

Parameter	Description	Location	Data Type	Required
twilio	Twilio	body	Twilio	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

delete Twilio account

Permissions:
Produces: application/json

delete

/storefront/twilio/accounts/{esp_twilio_uuid}

SDK Function Name: deleteTwilioAccount

Parameters

Parameter	Description	Location	Data Type	Required
esp_twilio_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get Twilio account

Permissions:
Produces: application/json

get

/storefront/twilio/accounts/{esp_twilio_uuid}

SDK Function Name: getTwilioAccount

Parameters

Parameter	Description	Location	Data Type	Required
esp_twilio_uuid		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update Twilio account

Permissions:
Produces: application/json

put

/storefront/twilio/accounts/{esp_twilio_uuid}

SDK Function Name: updateTwilioAccount

Parameters

Parameter	Description	Location	Data Type	Required
esp_twilio_uuid		path	string	optional
twilio	Twilio	body	Twilio	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get file manager directory

Permissions:
Produces: application/json

get

/storefront/{id}/fs/dir

SDK Function Name: getFsDirectory

Parameters

Parameter	Location	Data Type	Required
id	path	integer (int32)	optional
path	query	string	optional
storefront_fs_directory_oid	query	integer (int32)	optional
storefront_theme_oid	query	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Create file manager directory

Permissions:
Produces: application/json

post

/storefront/{id}/fs/dir

SDK Function Name: createFsDirectory

Parameters

Parameter	Location	Data Type	Required
id	path	integer (int32)	optional
name	query	string	optional
parent_storefront_fs_directory_oid	query	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Delete file manager directory

Permissions:
Produces: application/json

delete

/storefront/{id}/fs/file

SDK Function Name: deleteFsFile

Parameters

Parameter	Location	Data Type	Required
id	path	integer (int32)	optional
parent_storefront_fs_directory_oid	query	integer (int32)	optional
storefront_fs_file_oid	query	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

// Internal API - no sample for this method.

This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.

Permissions:
Produces: application/json

post

/storefront/{id}/fs/upload

SDK Function Name: uploadFsFile

Parameters

Parameter	Description	Location	Data Type	Required
id		path	integer (int32)	optional
upload_request	UploadRequest	body	FileManagerUploadRequest	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.

Permissions:
Produces: application/json

get

/storefront/{id}/fs/upload_url/{extension}

SDK Function Name: getUploadFsFileUrl

Parameters

Parameter	Description	Location	Data Type	Required
id		path	integer (int32)	optional
extension		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Gets editor token

Permissions:

get

/storefront/{storefront_oid}/editor_token

Fetches a temporary authentication token for the editor

SDK Function Name: getEditorToken

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email communication base templates

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/baseTemplates

SDK Function Name: getEmailBaseTemplates

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email campaign folders

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/campaign_folders

SDK Function Name: getEmailCampaignFolders

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email campaign folder

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/campaign_folders

SDK Function Name: insertEmailCampaignFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_campaign_folder	Email campaign folder	body	EmailCampaignFolder	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete email campaignFolder

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}

SDK Function Name: deleteEmailCampaignFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_campaign_folder_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email campaign folder

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}

SDK Function Name: getEmailCampaignFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_campaign_folder_uuid		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email campaign folder

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}

SDK Function Name: updateEmailCampaignFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_campaign_folder_uuid		path	string	optional
email_campaign_folder	Email campaign folder	body	EmailCampaignFolder	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email campaigns

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/campaigns

SDK Function Name: getEmailCampaigns

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email campaign

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/campaigns

SDK Function Name: insertEmailCampaign

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email campaign

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}

SDK Function Name: getEmailCampaign

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_campaign_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email campaign

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}

SDK Function Name: updateEmailCampaign

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_campaign_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Clone email campaign

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone

SDK Function Name: cloneEmailCampaign

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_campaign_uuid	path	string	optional
target_storefront_oid	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email campaign screenshots

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/screenshots

SDK Function Name: getEmailCampaignScreenshots

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_campaign_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Start email campaign

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start

SDK Function Name: startEmailCampaign

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_campaign_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email campaigns with stats

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/campaignsWithStats/{stat_days}

SDK Function Name: getEmailCampaignsWithStats

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
stat_days		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email commseqs

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs

SDK Function Name: getEmailCommseqs

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email commseq

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/commseqs

SDK Function Name: insertEmailCommseq

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email commseq

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}

SDK Function Name: getEmailCommseq

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email commseq

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}

SDK Function Name: updateEmailCommseq

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email communication sequence emails stats

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats

SDK Function Name: getEmailCommseqEmailStats

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email communication sequence postcard stats

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats

SDK Function Name: getEmailCommseqPostcardStats

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Reset email commseq rate limiters (only callable by UltraCart Support)

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters

SDK Function Name: resetEmailCommseqRateLimiters

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Get email commseq rate limiters

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters

SDK Function Name: getEmailCommseqRateLimiters

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Get email communication sequence sms stats

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats

SDK Function Name: getEmailCommseqSmsStats

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		path	string	optional
statsRequest	StatsRequest	body	EmailStatSmsSummaryRequest	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Delete communication sequence stats

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat

SDK Function Name: deleteEmailCommseqStat

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get communication sequence stats overall

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat

SDK Function Name: getEmailCommseqStatOverall

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email communication sequence step stats

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats

SDK Function Name: getEmailCommseqStepStats

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email email clicks

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks

SDK Function Name: getEmailEmailClicks

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
commseq_uuid	path	string	optional
commseq_step_uuid	path	string	optional
commseq_email_uuid	path	string	optional
days	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email email orders

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/orders

SDK Function Name: getEmailEmailOrders

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
commseq_uuid	path	string	optional
commseq_step_uuid	path	string	optional
commseq_email_uuid	path	string	optional
days	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email dispatch logs

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs

SDK Function Name: getEmailDispatchLogs

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
commseq_uuid	path	string	optional
commseq_step_uuid	path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email sms orders

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders

SDK Function Name: getEmailSmsOrders

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
commseq_uuid	path	string	optional
commseq_step_uuid	path	string	optional
days	query	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Sequence test

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test

SDK Function Name: sequenceTest

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		path	string	optional
email_commseq_sequence_test_request	Commseq test request	body	EmailCommseqSequenceTestRequest	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Get email communication sequence customers waiting at each requested step

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting

SDK Function Name: getEmailCommseqStepWaiting

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Release email communication sequence customers waiting at the specified step

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid}

SDK Function Name: releaseEmailCommseqStepWaiting

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
commseq_uuid	path	string	optional
commseq_step_uuid	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email webhook editor values

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues

SDK Function Name: getEmailCommseqWebhookEditorValues

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get countries

Permissions:

get

/storefront/{storefront_oid}/email/countries

Obtain a list of all the countries

SDK Function Name: getCountries

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email customers

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/customers

SDK Function Name: getEmailCustomers

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
pageNumber	query	integer (int32)	optional
pageSize	query	integer (int32)	optional
searchEmailPrefix	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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.storefront
{
    public class GetEmailCustomers
    {

        [Test]
        public void ExecuteTest()
        {
            // Please see the README.md in this directory for an explanation about StoreFrontApi samples.
        }

        public static void GetEmailCustomersCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new StorefrontApi(simpleKey);
        }


    }
}

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email customer

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/customers/{email_customer_uuid}

SDK Function Name: updateEmailCustomer

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_customer_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get customers editor URL

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url

SDK Function Name: getEmailCustomerEditorUrl

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_customer_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email dashboard activity

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/dashboard_activity

SDK Function Name: getEmailDashboardActivity

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
last_records		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get dashboard stats

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/dashboard_stats

SDK Function Name: getEmailDashboardStats

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
days		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email emails

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/emails

SDK Function Name: getEmailEmails

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email email

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/emails

SDK Function Name: insertEmailEmail

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email emails multiple

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/emails/multiple

SDK Function Name: getEmailEmailsMultiple

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete email email

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}

SDK Function Name: deleteEmailEmail

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_email_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email email

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}

SDK Function Name: getEmailEmail

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_email_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email email

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}

SDK Function Name: updateEmailEmail

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_email_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email order customer editor url

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url

SDK Function Name: getEmailEmailCustomerEditorUrl

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
commseq_email_uuid	path	string	optional
order_id	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Request a review of an email

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review

SDK Function Name: review

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_email_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Send email test

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test

SDK Function Name: sendEmailTest

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_email_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email flow folders

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/flow_folders

SDK Function Name: getEmailFlowFolders

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email flow folder

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/flow_folders

SDK Function Name: insertEmailFlowFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_flow_folder	Email flow folder	body	EmailFlowFolder	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete email flowFolder

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}

SDK Function Name: deleteEmailFlowFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_flow_folder_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email flow folder

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}

SDK Function Name: getEmailFlowFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_flow_folder_uuid		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email flow folder

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}

SDK Function Name: updateEmailFlowFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_flow_folder_uuid		path	string	optional
email_flow_folder	Email flow folder	body	EmailFlowFolder	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email flows

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/flows

SDK Function Name: getEmailFlows

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.storefront
{
    public class GetEmailFlows
    {

        [Test]
        public void ExecuteTest()
        {
            // Please see the README.md in this directory for an explanation about StoreFrontApi samples.
        }

        public static void GetEmailFlowsCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new StorefrontApi(simpleKey);
        }


    }
}

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email flow

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/flows

SDK Function Name: insertEmailFlow

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email flow

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/flows/{email_flow_uuid}

SDK Function Name: getEmailFlow

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_flow_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email flow

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/flows/{email_flow_uuid}

SDK Function Name: updateEmailFlow

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_flow_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Back populate email flow

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/backfill

SDK Function Name: backPopulateEmailFlow

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_flow_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Clone email flow

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone

SDK Function Name: cloneEmailFlow

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_flow_uuid	path	string	optional
target_storefront_oid	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email flow screenshots

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/screenshots

SDK Function Name: getEmailFlowScreenshots

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_flow_uuid		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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.storefront
{
    public class GetEmailFlowScreenshots
    {

        [Test]
        public void ExecuteTest()
        {
            // Please see the README.md in this directory for an explanation about StoreFrontApi samples.
        }

        public static void GetEmailFlowScreenshotsCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new StorefrontApi(simpleKey);
        }


    }
}

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Obtain lat/long for an address

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/geocode

SDK Function Name: geocodeAddress

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Globally unsubscribe a customer

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/globalUnsubscribe

SDK Function Name: globalUnsubscribe

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get histogram property names

Permissions:

get

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

Obtain a list of property names for a given property type

SDK Function Name: getHistogramPropertyNames

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
property_type		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get histogram property values

Permissions:

get

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

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

SDK Function Name: getHistogramPropertyValues

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
property_name	query	string	optional
property_type	query	string	optional
limit	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email campaign folders

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/list_segment_folders

SDK Function Name: getEmailListSegmentFolders

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email campaign folder

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/list_segment_folders

SDK Function Name: insertEmailListSegmentFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_list_segment_folder	Email campaign folder	body	EmailListSegmentFolder	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete email ListSegmentFolder

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}

SDK Function Name: deleteEmailListSegmentFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_list_segment_folder_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email campaign folder

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}

SDK Function Name: getEmailListSegmentFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_list_segment_folder_uuid		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email campaign folder

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}

SDK Function Name: updateEmailListSegmentFolder

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_list_segment_folder_uuid		path	string	optional
email_list_segment_folder	Email campaign folder	body	EmailListSegmentFolder	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email lists

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/lists

SDK Function Name: getEmailLists

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email list

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/lists

SDK Function Name: insertEmailList

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email list

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/lists/{email_list_uuid}

SDK Function Name: getEmailList

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_list_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email list

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/lists/{email_list_uuid}

SDK Function Name: updateEmailList

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_list_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Archive email list

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive

SDK Function Name: archiveEmailList

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_list_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Internal API - no sample for this method.// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email list customers

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers

SDK Function Name: getEmailListCustomers

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_list_uuid	path	string	optional
pageNumber	query	integer (int32)	optional
pageSize	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete email list customer

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}

SDK Function Name: deleteEmailListCustomer

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_list_uuid	path	string	optional
email_customer_uuid	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email list customer editor url

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url

SDK Function Name: getEmailListCustomerEditorUrl

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_list_uuid	path	string	optional
email_customer_uuid	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Search email list customers

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/lists/{email_list_uuid}/search

SDK Function Name: searchEmailListCustomers

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_list_uuid	path	string	optional
startsWith	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Subscribe customers to email list

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe

SDK Function Name: subscribeToEmailList

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_list_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email performance

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/performance

SDK Function Name: getEmailPerformance

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email plan

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/plan

SDK Function Name: getEmailPlan

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email plan

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/plan

SDK Function Name: updateEmailPlan

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email postcards

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/postcards

SDK Function Name: getEmailPostcards

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email postcard

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/postcards

SDK Function Name: insertEmailPostcard

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email postcards multiple

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/postcards/multiple

SDK Function Name: getEmailPostcardsMultiple

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete email postcard

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}

SDK Function Name: deleteEmailPostcard

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_postcard_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email postcard

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}

SDK Function Name: getEmailPostcard

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_postcard_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email postcard

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}

SDK Function Name: updateEmailPostcard

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_postcard_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Send postcard test

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test

SDK Function Name: sendPostcardTest

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_postcard_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email communication postcard tracking

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking

SDK Function Name: getEmailCommseqPostcardTracking

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_postcard_uuid		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Get email segments

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/segments

SDK Function Name: getEmailSegments

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert email segment

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/segments

SDK Function Name: insertEmailSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email segment

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}

SDK Function Name: getEmailSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_segment_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email segment

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}

SDK Function Name: updateEmailSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_segment_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Archive email segment

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/archive

SDK Function Name: archiveEmailSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_segment_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email segment customers

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers

SDK Function Name: getEmailSegmentCustomers

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_segment_uuid	path	string	optional
pageNumber	query	integer (int32)	optional
pageSize	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email segment customers editor URL

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url

SDK Function Name: getEmailSegmentCustomerEditorUrl

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_segment_uuid	path	string	optional
email_customer_uuid	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Prepare download of email segment

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare

SDK Function Name: prepareDownloadEmailSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_segment_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Check download of email segment

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid}

SDK Function Name: checkDownloadEmailSegment

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_segment_uuid	path	string	optional
email_segment_rebuild_uuid	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API.  No samples are provided as merchants will never need this api method# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Search email segment customers

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/search

SDK Function Name: searchEmailSegmentCustomers

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
email_segment_uuid	path	string	optional
startsWith	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Sunset email segment

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset

SDK Function Name: sunsetEmailSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_segment_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Get email settings

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/settings

SDK Function Name: getEmailSettings

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update email settings

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/settings

SDK Function Name: updateEmailSettings

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Send SMS test

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/sms/{commseq_uuid}/{commseq_step_uuid}/test

SDK Function Name: sendSmsTest

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
commseq_uuid		path	string	optional
commseq_step_uuid		path	string	optional
email_commseq_sms_test_request	Email commseq sms test request	body	EmailCommseqSmsSendTestRequest	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Get email templates

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/templates

SDK Function Name: getEmailTemplates

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
trigger_type		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get email template

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/templates/{email_template_oid}

SDK Function Name: getEmailTemplate

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_template_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get a list of third party email providers

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/email/third_party_providers

SDK Function Name: getEmailThirdPartyProviders

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Import a third party provider list

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/third_party_providers/import

SDK Function Name: importEmailThirdPartyProviderList

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Send webhook test

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/email/webhooks/test

SDK Function Name: sendWebhookTest

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_commseq_webhook_test_request	Email commseq webhook test request	body	EmailCommseqWebhookSendTestRequest	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get experiments

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/experiments

SDK Function Name: getExperiments

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete experiment

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/experiments/{storefront_experiment_oid}

SDK Function Name: deleteExperiment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
storefront_experiment_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update experiment

Permissions:
Produces: application/json

put

/storefront/{storefront_oid}/experiments/{storefront_experiment_oid}

SDK Function Name: updateExperiment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
storefront_experiment_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Upsert a page content attribute

Permissions:
Consumes: application/json
Produces: application/json

post

/storefront/{storefront_oid}/pages/{page_oid}/content/attributes

Update a page content attribute, creating it new if it does not yet exist.

SDK Function Name: insertUpdatePageContentAttribute

Parameters

Parameter	Description	Location	Data Type	Required
page_attribute	Page content attribute to upsert	body	StoreFrontPageContentAttribute	required
storefront_oid		path	integer (int32)	optional
page_oid	The page oid to modify.	path	integer (int32)	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Internal API. No sample provided.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.

# Internal API.  No samples are provided as merchants will never need this api method

// Internal API - no sample for this method.

Delete screen recording heatmap

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/screen_recordings/heatmap

Delete screen recording heatmap

SDK Function Name: deleteHeatmap

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
query	Query	body	ScreenRecordingHeatmapReset	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get screen recording heatmap

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/heatmap

Get screen recording heatmap

SDK Function Name: getHeatmap

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
query	Query	body	ScreenRecordingHeatmapRequest	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get screen recording heatmap index

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/heatmap/index

Get screen recording heatmap index

SDK Function Name: getHeatmapIndex

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
query	Query	body	ScreenRecordingHeatmapIndexRequest	required
_limit	The maximum number of records to return on this one API call. (Default 100, Max 500) Default: 100	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 items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. Allowed Values session_count url	query	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Query screen recordings

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/query

Query screen recordings

SDK Function Name: getScreenRecordingsByQuery

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
query	Query	body	ScreenRecordingQueryRequest	required
_limit	The maximum number of records to return on this one API call. (Default 100, Max 500) Default: 100	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 items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. Allowed Values start_timestamp watched page_view_count time_on_site favorite	query	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get screen recording segments

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/screen_recordings/segments

SDK Function Name: getScreenRecordingSegments

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Insert screen recording segment

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/segments

SDK Function Name: insertScreenRecordingSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
segment	Segment	body	ScreenRecordingSegment	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Delete screen recording segment

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}

SDK Function Name: deleteScreenRecordingSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_segment_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get screen recording segment

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}

SDK Function Name: getScreenRecordingSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_segment_oid		path	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update screen recording segment

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}

SDK Function Name: updateScreenRecordingSegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_segment_oid		path	integer (int32)	optional
segment	Segment	body	ScreenRecordingSegment	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get screen recordings by segment

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query

Get screen recordings by segment

SDK Function Name: getScreenRecordingsBySegment

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_segment_oid		path	integer (int32)	optional
_limit	The maximum number of records to return on this one API call. (Default 100, Max 500) Default: 100	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 items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. Allowed Values start_timestamp watched page_view_count time_on_site	query	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get screen recording settings

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/screen_recordings/settings

SDK Function Name: getScreenRecordingSettings

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update screen recording settings

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/settings

SDK Function Name: updateScreenRecordingSettings

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
settings	Settings	body	ScreenRecordingSettings	required

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get tags used by screen recording

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/tags

Get tags used by screen recording

SDK Function Name: getScreenRecordingTags

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get screen recording

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}

Get screen recording

SDK Function Name: getScreenRecording

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_uuid		path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Remove favorite flag on screen recording

Permissions:
Produces: application/json

delete

/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite

Remove favorite flag on screen recording

SDK Function Name: unfavoriteScreenRecording

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update favorite flag on screen recording

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite

Update favorite flag on screen recording

SDK Function Name: favoriteScreenRecording

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_uuid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update merchant notes on a screen recording

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes

Update merchant notes on a screen recording

SDK Function Name: updateScreenRecordingMerchantNotes

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_uuid		path	string	optional
merchant_notes_request	Merchant Notes	body	ScreenRecordingMerchantNotesRequest	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get screen recording page view data

Permissions:
Produces: application/json

get

/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/page_view_data/{screen_recording_page_view_uuid}

Get screen recording page view data

SDK Function Name: getScreenRecordingPageViewData

Parameters

Parameter	Location	Data Type	Required
storefront_oid	path	integer (int32)	optional
screen_recording_uuid	path	string	optional
screen_recording_page_view_uuid	path	string	optional

Responses

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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Update tags on a screen recording

Permissions:
Produces: application/json

post

/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags

Update tags on a screen recording

SDK Function Name: updateScreenRecordingTags

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
screen_recording_uuid		path	string	optional
tags	Tags	body	ScreenRecordingTagsRequest	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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Gets a list of transaction email names

Permissions:

get

/storefront/{storefront_oid}/transaction_email/list

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

SDK Function Name: getTransactionEmailList

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Gets a transaction email object

Permissions:

get

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

Fetch a transactional email

SDK Function Name: getTransactionEmail

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_id		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Updates a transaction email object

Permissions:

put

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

Updates a transactional email

SDK Function Name: updateTransactionEmail

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_id		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

Get transactional email screenshots

Permissions:
Produces: application/json

get

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

SDK Function Name: getTransactionEmailScreenshots

Parameters

Parameter	Description	Location	Data Type	Required
storefront_oid		path	integer (int32)	optional
email_id		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

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// (Internal API).  No sample for this method as a merchant will never need call it.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

<?php // Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

# Please see the README.md in this directory for an explanation about StoreFrontApi samples.

// Please see the README.md in this directory for an explanation about StoreFrontApi samples.

AddLibraryItemRequest

Attributes

Name	Data Type	Description
attributes	array of LibraryItemAttribute	Attributes associated with the library item to contain additional configuration.
cjson	string	Cjson to be added to library
content_type	string	flow, campaign, cjson, email, transactional_email, postcard 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, campaign, email, postcard, or null if this item is something else. transactional_email do not have a uuid because they are singleton objects within a storefront and easily identifiable by name

ApplyLibraryItemRequest

Attributes

Name	Data Type	Description
email_uuid	string	Normal emails are applied to an existing email object, so when requesting a library item to be applied to an email, supply the email uuid. This is only for normal emails. Transactional emails do not have a uuid.
library_item_oid	integer (int32)	Library item oid that you wish to apply to the given StoreFront
postcard_uuid	string	The postcard uuid you wish to apply to a given StoreFront.
storefront_oid	integer (int32)	StoreFront oid where content originates necessary for tracking down relative assets

ApplyLibraryItemResponse

Attributes

Name	Data Type	Description
attributes	array of LibraryItemAttribute	Attributes from the library item
cjson	string	Cjson from library item, only populated if this library item was a cjson snippet or marketing email (not transactional)
content_type	string	flow, campaign, cjson, upsell, postcard, transactional_email or email
email_template_vm_path	string	If a marketing email was applied, this is the path to the template encapsulating the cjson. This is needed for the UltraCart UI.
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 marketing email or communication flow/campaign if this library item was an email, 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	boolean	True if the customer should end the flow once they purchase from this campaign
end_once_customer_purchases_anywhere	boolean	True if the customer should end the flow once they purchase from anywhere
esp_campaign_folder_uuid	(read only) string	Campaign folder UUID. Null for uncategorized
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
library_item_oid	integer (int32)	If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.
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
revenue_per_customer_formatted	(read only) string	Revenue per customer associated with campaign
scheduled_dts	string (dateTime)	Scheduled date
screenshot_large_full_url	string	URL to a large full length screenshot
sms_esp_twilio_uuid	string	Twilio Account UUID. Null for none
sms_phone_number	string	Twilio SMS Phone Number. Null for none
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

EmailCampaignFolder

Attributes

Name	Data Type	Description
esp_campaign_folder_uuid	(read only) string	Email campaign folder UUID
merchant_id	(read only) string	Merchant ID
name	string(250)	Name of email campaign folder
storefront_oid	(read only) integer (int32)	Storefront oid
system_generated	(read only) boolean	System generated folder

EmailCampaignFolderResponse

Attributes

Name	Data Type	Description
campaign_folder	EmailCampaignFolder
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

EmailCampaignFoldersResponse

Attributes

Name	Data Type	Description
campaign_folders	array of EmailCampaignFolder
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

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
external_generation	boolean
external_generation_authentication	string
external_generation_basic_password	string
external_generation_basic_username	string
external_generation_header_name	string
external_generation_header_value	string
external_generation_id	string
external_generation_url	string
filter_profile_equation_json	string	Filter profile equation json
individually_render	boolean	Individually render
library_item_oid	integer (int32)	If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.
magic_link	(read only) boolean	True if email links should contain magic link tokens to log the customer in automatically
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
suspended_for_spam	(read only) boolean	True if the email was suspended for too high of a spam rate.
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
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

EmailCommseqEmailsResponse

Attributes

Name	Data Type	Description
emails	array of 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

EmailCommseqPostcard

Attributes

Name	Data Type	Description
deleted	boolean	Deleted
edited_by_user	string	Edited by user
email_communication_sequence_postcard_uuid	string	communication sequence postcard uuid
filter_profile_equation_json	string	Filter profile equation json
merchant_id	(read only) string	Merchant ID
postcard_back_container_cjson	string	Postcard back container cjson
postcard_back_container_uuid	string	Postcard back container uuid
postcard_container_cjson_last_modified_dts	string (dateTime)	Timestamp the last time the container was modified.
postcard_front_container_cjson	string	Postcard front container cjson
postcard_front_container_uuid	string	Postcard front container uuid
screenshot_back_url	(read only) string	URL to screenshot of the back of the postcard
screenshot_front_url	(read only) string	URL to screenshot of the front of the postcard
storefront_oid	(read only) integer (int32)	Storefront oid

EmailCommseqPostcardResponse

Attributes

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

EmailCommseqPostcardSendTestRequest

Attributes

Name	Data Type	Description
address_1	string
address_2	string
cart_id	string
cart_item_ids	array of string
city	string
esp_commseq_postcard_uuid	string
esp_commseq_step_uuid	string
esp_commseq_uuid	string
mail_card	boolean
name	string
order_id	string
postal_code	string
state	string

EmailCommseqPostcardSendTestResponse

Attributes

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

EmailCommseqPostcardsRequest

Attributes

Name	Data Type	Description
esp_commseq_postcard_uuids	array of string

EmailCommseqPostcardsResponse

Attributes

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

EmailCommseqResponse

Attributes

Name	Data Type	Description
communication_sequence	EmailCommseq
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

EmailCommseqSequenceTestRequest

Attributes

Name	Data Type	Description
address_1	string
address_2	string
cart_id	string
cart_item_ids	array of string
city	string
esp_commseq_uuid	string
mail_card	boolean
name	string
order_id	string
please_review	boolean
postal_code	string
send_to_cellphone_e164	string
send_to_email	string
send_to_logged_in_user	boolean
state	string

EmailCommseqSequenceTestResponse

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

EmailCommseqSmsSendTestRequest

Attributes

Name	Data Type	Description
esp_commseq_step_uuid	string
esp_commseq_uuid	string
send_to_cellphone_e164	string

EmailCommseqSmsSendTestResponse

Attributes

Name	Data Type	Description
body	string
error	Error	Error object if unsuccessful
media_urls	array of string
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

EmailCommseqsResponse

Attributes

Name	Data Type	Description
communication_sequences	array of EmailCommseq
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

EmailCommseqStat

Attributes

Name	Data Type	Description
click_count	integer (int32)	Count of clicked emails
click_count_formatted	string	Count of clicked emails, formatted
conversion_count	integer (int32)	Count of conversion
conversion_count_formatted	string	Count of conversions, formatted
delivered_count	integer (int32)	Count of delivered emails
delivered_count_formatted	string	Count of delivered emails, formatted
email_communication_sequence_uuid	(read only) string	UUID associated with the communication sequence
finished_count	integer (int32)	Count of customers that finished the sequence
finished_count_formatted	string	Count of customers that finished the sequence, formatted
in_progress_count	integer (int32)	Count of customers in progress
in_progress_count_formatted	string	Count of customers in progress, formatted
kickbox_count	integer (int32)	Count of emails kicked
kickbox_count_formatted	string	Count of emails kicked, formatted
merchant_id	(read only) string	Merchant ID
open_count	integer (int32)	Count of opened emails
open_count_formatted	string	Count of opened emails, formatted
order_count	integer (int32)	Count of orders
order_count_formatted	string	Count of orders, formatted
permanent_bounce_count	integer (int32)	Count of emails permanently bounced
permanent_bounce_count_formatted	string	Count of emails permanently bounced, formatted
profit	number	Profit
profit_formatted	string	Profit, formatted
revenue	number	Revenue
revenue_formatted	string	Revenue, formatted
send_count	integer (int32)	Count of emails sent
send_count_formatted	string	Count of emails sent, formatted
skipped_count	integer (int32)	Count of skipped emails
skipped_count_formatted	string	Count of skipped emails, formatted
spam_count	integer (int32)	Count of emails classified as spam
spam_count_formatted	string	Count of emails classified as spam, formatted
started_count	integer (int32)	Count of customers that started the sequence
started_count_formatted	string	Count of customers that started the sequence, formatted
storefront_oid	(read only) integer (int32)	Storefront oid
unsubscribe_count	integer (int32)	Count of unsubscribes caused
unsubscribe_count_formatted	string	Count of unsubscribes caused, formatted
view_count	integer (int32)	Count of views
view_count_formatted	string	Count of views, formatted

EmailCommseqStatResponse

Attributes

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

EmailCommseqStep

Attributes

Name	Data Type	Description
alt_child_email_communication_sequence_steps	array of EmailCommseqStep	Array of child steps for the alternate path
child_email_communication_sequence_steps	array of EmailCommseqStep	Array of child steps
email_communication_sequence_step_uuid	(read only) string	Email commseq step UUID
email_pending_review	(read only) boolean	True if the content of the email associated with this step is pending review by UltraCart
email_rejected	(read only) boolean	True if the content of the email associated with this step was rejected during review by UltraCart
email_requires_review	(read only) boolean	True if the content of the email associated with this step requires review by UltraCart
filter_profile_equation_json	string	Filter profile equation JSON
merchant_notes	string	Internal merchant notes
step_config_json	string	Arbitrary Configuration for a step
type	string	Type of step Allowed Values begin wait email merge condition end

EmailCommseqStepLog

Attributes

Name	Data Type	Description
email	string	Email
log	string	Log text
log_dts	string (dateTime)	Log date/time

EmailCommseqStepLogsResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
logs	array of EmailCommseqStepLog
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

EmailCommseqWebhookSendTestRequest

Attributes

Name	Data Type	Description
cart_id	string
cart_item_ids	array of string
email	string
esp_commseq_step_uuid	string
esp_commseq_uuid	string
name	string
order_id	string

EmailCommseqWebhookSendTestResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
metadata	ResponseMetadata	Meta-data about the response such as payload or paging information
request	string	HTTP Request
response	string	HTTP Response
status_code	integer (int32)	HTTP Status Code
success	boolean	Indicates if API call was successful
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

EmailCustomer

Attributes

Name	Data Type	Description
active	boolean	True if the customer is flagged as active within StoreFront Communications
email	(read only) string	Email
email_customer_uuid	(read only) string	Email customer UUID
first_name	(read only) string	First name
global_unsubscribe	boolean	True if the customer has globally unsubscribed from all communication.
last_interaction_dts	(read only) string (dateTime)	Last interaction
last_name	(read only) string	Last name
list_uuids	array of string	UUIDs of the lists they are subscribed to

EmailCustomerEditorUrlResponse

Attributes

Name	Data Type	Description
editor_url	string
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

EmailCustomersResponse

Attributes

Name	Data Type	Description
customers	array of EmailCustomer	Customers on the page
page_number	integer (int32)	Page number (one based offset)
page_size	integer (int32)	Number of records per page
total_customers	integer (int32)	Total customers
total_pages	integer (int32)	Total number of pages

EmailDashboardActivity

Attributes

Name	Data Type	Description
action	(read only) string	Type of action such as add, remove, subscribe, unsubscribe
activity_dts	(read only) string (dateTime)	Date/time of the activity
destination_name	(read only) string	List or segment name
destination_uuid	(read only) string	List or segment uuid
email	(read only) string	Email address
is_list	(read only) boolean	true if activity is related to list
is_segment	(read only) boolean	true if activity is related to segment

EmailDashboardActivityResponse

Attributes

Name	Data Type	Description
activity	array of EmailDashboardActivity
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

EmailDashboardStatsResponse

Attributes

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

EmailDomain

Attributes

Name	Data Type	Description
comment	string
dkim	array of VerificationRecord
dkim_status	string
domain	string
esp_domain_uuid	string
identity_status	string
mailgun	Mailgun
merchant_id	string
provider	string
spf	VerificationRecord
start_dkim_dts	string
start_identity_dts	string
verification	VerificationRecord

EmailEditorTokenResponse

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
token	string
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

EmailFlow

Attributes

Name	Data Type	Description
allow_multiple_concurrent_enrollments	boolean	True if a customer may be enrolled in this flow multiple times
back_populating	(read only) boolean	True if the flow is currently performing a back population.
click_rate_formatted	string	Click rate of emails, formatted
created_dts	(read only) string (dateTime)	Created date
deleted	boolean	True if this campaign was deleted
email_communication_sequence_uuid	(read only) string	Email communication sequence UUID
email_flow_uuid	(read only) string	Email flow UUID
end_once_customer_purchases	boolean	True if the customer should end the flow once they purchase from an email on this flow
end_once_customer_purchases_anywhere	boolean	True if the customer should end the flow once they purchase from any source
enrolled_customers	(read only) integer (int32)	Number of enrolled customers.
esp_domain_user	string	Username of sending email
esp_domain_uuid	string	UUID of sending domain
esp_flow_folder_uuid	(read only) string	Flow folder UUID. Null for uncategorized
esp_friendly_name	string	Friendly name of the sending email
filter_profile_equation_json	string	File profile equation json
library_item_oid	integer (int32)	If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.
maximum_enrolled	(read only) boolean	The number of maximum customers for the plan are currently enrolled in this flow.
merchant_id	(read only) string	Merchant ID
name	string(250)	Name of email flow
open_rate_formatted	string	Open rate of emails, formatted
revenue_formatted	string	Revenue, formatted
revenue_per_customer_formatted	string	Revenue per customer, formatted
screenshot_large_full_url	string	URL to a large full length screenshot
sms_esp_twilio_uuid	string	Twilio Account UUID. Null for none
sms_phone_number	string	Twilio SMS Phone Number. Null for none
status	string	Status of the campaign of draft, archived, active, and inactive
status_dts	(read only) string (dateTime)	Timestamp when the last status change happened
storefront_oid	(read only) integer (int32)	Storefront oid
trigger_parameter	string	Trigger parameter
trigger_parameter_name	string	Trigger parameter name
trigger_type	string	Trigger type

EmailFlowBackPopulateRequest

Attributes

Name	Data Type	Description
order_days_old	integer (int32)	The age of the orders that should be considered for order triggers.
relative_to_event	boolean	True if the age of the event should be considered when reducing the initial flow wait step

EmailFlowBackPopulateResponse

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

EmailFlowFolder

Attributes

Name	Data Type	Description
esp_flow_folder_uuid	(read only) string	Email flow folder UUID
merchant_id	(read only) string	Merchant ID
name	string(250)	Name of email flow folder
storefront_oid	(read only) integer (int32)	Storefront oid
system_generated	(read only) boolean	System generated folder

EmailFlowFolderResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
flow_folder	EmailFlowFolder
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

EmailFlowFoldersResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
flow_folders	array of EmailFlowFolder
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

EmailFlowResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
flow	EmailFlow
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

EmailFlowsResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
flows	array of EmailFlow
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

EmailGlobalSettings

Attributes

Name	Data Type	Description
dedicated_ip	boolean

EmailGlobalSettingsResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
global_settings	EmailGlobalSettings
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

EmailGlobalUnsubscribeRequest

Attributes

Name	Data Type	Description
email	string

EmailGlobalUnsubscribeResponse

Attributes

Name	Data Type	Description
listsUnsubscribed	integer (int32)

EmailHistogramPropertyNamesResponse

Attributes

Name	Data Type	Description
property_names	array of string

EmailHistogramPropertyValuesResponse

Attributes

Name	Data Type	Description
property_values	array of string

EmailList

Attributes

Name	Data Type	Description
allow_csv_download	boolean	True if the current user has the rights to download this list.
created_dts	(read only) string (dateTime)	Created date
deleted	boolean	True if this campaign was deleted
email_list_uuid	(read only) string	Email list UUID
esp_list_segment_folder_uuid	string	List/Segment folder UUID
member_count	integer (int32)	Count of members in this list
merchant_id	(read only) string	Merchant ID
name	string(250)	Name of email list
public_description	string	Description of list shown to customer.
public_list	boolean	True if this list is public
storefront_oid	(read only) integer (int32)	Storefront oid
used_by	array of EmailListSegmentUsedBy	Details on the flows or campaigns that use this list.

EmailListArchiveResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
list_in_use	boolean
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

EmailListCustomer

Attributes

Name	Data Type	Description
add_dts	(read only) string (dateTime)	Added timestamp
email	(read only) string	Email
email_customer_uuid	(read only) string	Email customer UUID
email_list_member_uuid	(read only) string	Email list member UUID

EmailListCustomersResponse

Attributes

Name	Data Type	Description
customers	array of EmailListCustomer	Customers on the page
page_number	integer (int32)	Page number (one based offset)
page_size	integer (int32)	Number of records per page
total_customers	integer (int32)	Total customers
total_pages	integer (int32)	Total number of pages

EmailListResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
list	EmailList
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

EmailListSegmentFolder

Attributes

Name	Data Type	Description
esp_list_segment_folder_uuid	(read only) string	Email list segment folder UUID
merchant_id	(read only) string	Merchant ID
name	string(250)	Name of email campaign folder
storefront_oid	(read only) integer (int32)	Storefront oid
system_generated	(read only) boolean	System generated folder

EmailListSegmentFolderResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
list_segment_folder	EmailListSegmentFolder
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

EmailListSegmentFoldersResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
list_segment_folders	array of EmailListSegmentFolder
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

EmailListSegmentMembership

Attributes

Name	Data Type	Description
email_list_uuid	(read only) string	UUID identifying this email list or null if this is a segment
email_segment_uuid	(read only) string	UUID identifying this email segment or null if this is a list
exclude	boolean	true if customers from this list/segment is excluded from membership
name	string	Name of this email list or segment

EmailListSegmentUsedBy

Attributes

Name	Data Type	Description
email_campaign_uuid	(read only) string	Email campaign UUID
email_flow_uuid	(read only) string	Email flow UUID
name	string	Name of the list or segment.

EmailListsResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
lists	array of EmailList
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

EmailListSubscribeResponse

Attributes

Name	Data Type	Description
added	integer (int32)
memberCount	integer (int32)

EmailOrder

Attributes

Name	Data Type	Description
email	(read only) string	email
order_dts	(read only) string (dateTime)	order_dts
order_id	(read only) string	order_id
total	(read only) Currency	Total

EmailOrdersResponse

Attributes

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

EmailPerformance

Attributes

Name	Data Type	Description
active_customers	(read only) integer (int32)	Active customers. The value will be -1 if calculation is pending.
actual_customers	(read only) integer (int32)	Actual customers that they have regardless of active state. The value will be -1 if calculation is pending.
bounce_count	(read only) integer (int32)	Bounce count
bounce_percentage	(read only) number	bounce percentage rate based upon our look back window. This should be under five percent or the account will be paused for sending.
bounce_percentage_formatted	(read only) string	bounce percentage rate (formatted) based upon our look back window. This should be under five percent or the account will be paused for sending.
customer_histogram	(read only) EmailPerformanceCustomerHistogram	Customer histogram
daily_stats	(read only) array of EmailPerformanceDaily	Daily statistics used for charting
delivered_count	(read only) integer (int32)	Delivered count
loyalty_program_type	(read only) string	Loyalty Program Type Allowed Values disabled points cashback
max_active_customers	(read only) integer (int32)	Maximum active customers allowed under their billing plan
max_emails_per_day	(read only) integer (int32)	Max emails per day
max_emails_per_hour	(read only) integer (int32)	Max emails per hour
max_emails_per_month	(read only) integer (int32)	Max emails per month
paused_for_spam	(read only) boolean	True if campaign/flow emails are paused due to spam complaints.
revenue	(read only) number	Revenue
sent_emails_per_day	(read only) integer (int32)	Sent emails last 24 hours
sent_emails_per_hour	(read only) integer (int32)	Sent emails last hour
sent_emails_per_month	(read only) integer (int32)	Sent emails last 31 days
sequence_send_count	(read only) integer (int32)	Total sequence (campaign/flow) emails sent
spam_count	(read only) integer (int32)	Spam complaints
spam_percentage	(read only) number	Spam percentage rate based upon our look back window. This should be under one half a percent or the account will be paused for sending.
spam_percentage_formatted	(read only) string	Spam percentage rate (formatted) based upon our look back window. This should be under one half a percent or the account will be paused for sending.
transactional_send_count	(read only) integer (int32)	Total transactions emails sent

EmailPerformanceCustomerHistogram

Attributes

Name	Data Type	Description
periods	(read only) array of EmailPerformanceCustomerHistogramPeriod	Periods (newest to oldest)

EmailPerformanceCustomerHistogramPeriod

Attributes

Name	Data Type	Description
active	(read only) integer (int32)	Active customers last active in this period
inactive	(read only) integer (int32)	Inactive customers last active in this period
month	(read only) integer (int32)	Month (1 = January)
total	(read only) integer (int32)	Total customers last active in this period
year	(read only) integer (int32)	Year (four digits)

EmailPerformanceDaily

Attributes

Name	Data Type	Description
bounce_count	(read only) integer (int32)	Bounce count
delivered_count	(read only) integer (int32)	Delivered count
revenue	(read only) number	Revenue
sequence_send_count	(read only) integer (int32)	Total sequence (campaign/flow) emails sent
spam_count	(read only) integer (int32)	Spam complaints
stat_dts	(read only) string (dateTime)	The date that these statistcs are for
transactional_send_count	(read only) integer (int32)	Total transactions emails sent

EmailPerformanceResponse

Attributes

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

EmailPlan

Attributes

Name	Data Type	Description
additional_customers	integer (int32)
additional_emails	integer (int32)
additional_fee	number
allow_list_import	boolean
allow_tracking_emails	boolean
customer_tiers	array of EmailPlanAdditional
initial_sending_limits	integer (int32)
plan_customers	integer (int32)
plan_emails	integer (int32)
plan_name	string
plan_name_formatted	string
require_order_within_last_days	integer (int32)
revenue_percent	integer (int32)
spam_percent_limit	integer (int32)
total_customers	integer (int32)
total_emails	integer (int32)
upgrade_to	integer (int32)

EmailPlanAdditional

Attributes

Name	Data Type	Description
active	boolean
can_downgrade	boolean
can_upgrade	boolean
cost	number
cost_change	number
cost_change_formatted	string
cost_formatted	string
customers	integer (int32)
emails	integer (int32)

EmailPlanResponse

Attributes

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

EmailPostcardStat

Attributes

Name	Data Type	Description
click_count	integer (int32)	Count of clicked emails
click_count_formatted	string	Count of clicked emails, formatted
conversion_count	integer (int32)	Count of conversions
conversion_count_formatted	string	Count of conversions, formatted
delivered_count	integer (int32)	Count of delivered emails
delivered_count_formatted	string	Count of delivered emails, formatted
merchant_id	(read only) string	Merchant ID
name	(read only) string	List or segment name
order_count	integer (int32)	Count of orders
order_count_formatted	string	Count of orders, formatted
profit	number	Profit
profit_formatted	string	Profit, formatted
return_to_sender_count	integer (int32)	Count of return to sender
return_to_sender_count_formatted	string	Count of return to sender, formatted
revenue	number	Revenue
revenue_formatted	string	Revenue, formatted
send_count	integer (int32)	Count of emails sent
send_count_formatted	string	Count of emails sent, formatted
skipped_count	integer (int32)	Count of skipped emails
skipped_count_formatted	string	Count of skipped emails, formatted
spam_count	integer (int32)	Count of emails classified as spam
spam_count_formatted	string	Count of emails classified as spam, formatted
stat_type	(read only) string	Campaign, Flow or None (for anything else)
status	(read only) string	Status of campaign or flow
status_dts	(read only) string	Status dts of campaign or flow
steps	array of EmailPostcardStat
storefront_oid	(read only) integer (int32)	Storefront oid
unsubscribe_count	integer (int32)	Count of emails classified as unsubscribe
unsubscribe_count_formatted	string	Count of emails classified as unsubscribe, formatted
uuid	(read only) string	List or segment uuid
view_count	integer (int32)	Count of views
view_count_formatted	string	Count of views, formatted

EmailPostcardTracking

Attributes

Name	Data Type	Description
commseq_postcard_uuid	string
commseq_step_uuid	string
commseq_uuid	string
conversion_dts	string (dateTime)	Conversion date time.
cost	number
customer_uuid	string
delivered_dts	string (dateTime)	Delivered date time.
from_address_line1	string
from_address_line2	string
from_city	string
from_name	string
from_state	string
from_zip	string
mailed_dts	string (dateTime)	Mailed date time.
order_id	string
postcard_tracking_uuid	string
status	string
submit_dts	string (dateTime)	Submit date time.
to_address_line1	string
to_address_line2	string
to_city	string
to_name	string
to_state	string
to_zip	string
tracking_description	string

EmailPostcardTrackingResponse

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
tracking	EmailPostcardTracking
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

EmailRateLimiter

Attributes

Name	Data Type	Description
available	integer (int32)
limit	integer (int32)
name	string

EmailRateLimitersResponse

Attributes

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

EmailSegment

Attributes

Name	Data Type	Description
allow_csv_download	boolean	True if the current user has the rights to download this segment.
allow_facebook_audiences	boolean	True if this StoreFront has the Facebook Analytics app connected and supports them
created_dts	(read only) string (dateTime)	Created date
deleted	boolean	True if this campaign was deleted
email_segment_uuid	(read only) string	Email segment UUID
esp_list_segment_folder_uuid	string	List/Segment folder UUID
facebook_custom_audience	boolean	True if you want to sync to a facebook custom audience
filter_profile_equation_json	string	File profile equation json
member_count	integer (int32)	Count of members in this segment
merchant_id	(read only) string	Merchant ID
name	string(250)	Name of email segment
rank_json	string	Rank settings json
rebuild_percentage	(read only) number	Percentage of completion for a rebuild. The value range will be 0-1. Multiply by 100 to format for display.
rebuild_required	boolean	True if a rebuild is required because some part of the segment has changed
storefront_oid	(read only) integer (int32)	Storefront oid
thirdparty_join_add_tags	array of string	Third party provider tags to add when a customer joins the segment.
thirdparty_join_remove_tags	array of string	Third party provider tags to remove when a customer joins the segment.
thirdparty_leave_add_tags	array of string	Third party provider tags to add when a customer leaves the segment.
thirdparty_leave_remove_tags	array of string	Third party provider tags to remove when a customer leaves the segment.
thirdparty_list_id	string	List id of third party provider to sync with.
thirdparty_provider_name	string	Name of third party provider to sync segment to a list with.
used_by	array of EmailListSegmentUsedBy	Details on the flows or campaigns that use this list.

EmailSegmentArchiveResponse

Attributes

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

EmailSegmentCustomer

Attributes

Name	Data Type	Description
add_dts	(read only) string (dateTime)	Added timestamp
email	(read only) string	Email
email_customer_uuid	(read only) string	Email customer UUID
email_segment_member_uuid	(read only) string	Email segment member UUID

EmailSegmentCustomersResponse

Attributes

Name	Data Type	Description
customers	array of EmailSegmentCustomer	Customers on the page
page_number	integer (int32)	Page number (one based offset)
page_size	integer (int32)	Number of records per page
total_customers	integer (int32)	Total customers
total_pages	integer (int32)	Total number of pages

EmailSegmentDownloadPrepareResponse

Attributes

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

EmailSegmentResponse

Attributes

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

EmailSegmentsResponse

Attributes

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

EmailSendingDomainResponse

Attributes

Name	Data Type	Description
domain	EmailDomain
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

EmailSendingDomainsResponse

Attributes

Name	Data Type	Description
domains	array of EmailDomain
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

EmailSettings

Attributes

Name	Data Type	Description
emails_per_day	(read only) integer (int32)	Emails per day allowed
emails_per_hour	(read only) integer (int32)	Emails per hour allowed
emails_per_month	(read only) integer (int32)	Emails per month allowed
marketing_esp_domain_user	string
marketing_esp_domain_uuid	string
marketing_esp_friendly_name	string
postcard_from_address1	string
postcard_from_address2	string
postcard_from_city	string
postcard_from_name	string
postcard_from_postal_code	string
postcard_from_state	string
require_order_within_last	(read only) integer (int32)	Require order within last
reviews_io_configured	(read only) boolean	True if the Reviews.io integration is configured
sms_esp_twilio_uuid	string
sms_phone_number	string
transactional_esp_domain_user	string
transactional_esp_domain_uuid	string
transactional_esp_friendly_name	string

EmailSettingsResponse

Attributes

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

EmailSmsOrder

Attributes

Name	Data Type	Description
email	(read only) string	email
order_dts	(read only) string (dateTime)	order_dts
order_id	(read only) string	order_id
total	(read only) Currency	Total

EmailSmsOrdersResponse

Attributes

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

EmailSmsStat

Attributes

Name	Data Type	Description
click_count	integer (int32)	Count of clicked emails
click_count_formatted	string	Count of clicked emails, formatted
conversion_count	integer (int32)	Count of conversions
conversion_count_formatted	string	Count of conversions, formatted
deleted	boolean	True if campaign/flow has been archived
delivered_count	integer (int32)	Count of delivered emails
delivered_count_formatted	string	Count of delivered emails, formatted
merchant_id	(read only) string	Merchant ID
name	(read only) string	List or segment name
order_count	integer (int32)	Count of orders
order_count_formatted	string	Count of orders, formatted
profit	number	Profit
profit_formatted	string	Profit, formatted
revenue	number	Revenue
revenue_formatted	string	Revenue, formatted
send_count	integer (int32)	Count of emails sent
send_count_formatted	string	Count of emails sent, formatted
skipped_count	integer (int32)	Count of skipped emails
skipped_count_formatted	string	Count of skipped emails, formatted
stat_type	(read only) string	Campaign, Flow or None (for anything else)
status	(read only) string	Status of campaign or flow
status_dts	(read only) string	Status dts of campaign or flow
step_uuid	(read only) string	Step UUID if the statistics are at the step/email level
steps	array of EmailSmsStat
storefront_oid	(read only) integer (int32)	Storefront oid
unsubscribe_count	integer (int32)	Count of emails classified as unsubscribe
unsubscribe_count_formatted	string	Count of emails classified as unsubscribe, formatted
uuid	(read only) string	List/Segment uuid, or Flow/Campaign uuid depending on level of stat aggregation.
view_count	integer (int32)	Count of views
view_count_formatted	string	Count of views, formatted

EmailStat

Attributes

Name	Data Type	Description
click_count	integer (int32)	Count of clicked emails
click_count_formatted	string	Count of clicked emails, formatted
conversion_count	integer (int32)	Count of conversions
conversion_count_formatted	string	Count of conversions, formatted
deleted	boolean	True if campaign/flow has been archived
delivered_count	integer (int32)	Count of delivered emails
delivered_count_formatted	string	Count of delivered emails, formatted
kickbox_count	integer (int32)	Count of emails kicked
kickbox_count_formatted	string	Count of emails kicked, formatted
merchant_id	(read only) string	Merchant ID
name	(read only) string	List or segment name
open_count	integer (int32)	Count of opened emails
open_count_formatted	string	Count of opened emails, formatted
order_count	integer (int32)	Count of orders
order_count_formatted	string	Count of orders, formatted
permanent_bounce_count	integer (int32)	Count of emails permanently bounced
permanent_bounce_count_formatted	string	Count of emails permanently bounced, formatted
profit	number	Profit
profit_formatted	string	Profit, formatted
revenue	number	Revenue
revenue_formatted	string	Revenue, formatted
send_count	integer (int32)	Count of emails sent
send_count_formatted	string	Count of emails sent, formatted
skipped_count	integer (int32)	Count of skipped emails
skipped_count_formatted	string	Count of skipped emails, formatted
spam_count	integer (int32)	Count of emails classified as spam
spam_count_formatted	string	Count of emails classified as spam, formatted
stat_type	(read only) string	Campaign, Flow or None (for anything else)
status	(read only) string	Status of campaign or flow
status_dts	(read only) string	Status dts of campaign or flow
step_uuid	(read only) string	Step UUID if the statistics are at the step/email level
steps	array of EmailStat
storefront_oid	(read only) integer (int32)	Storefront oid
unsubscribe_count	integer (int32)	Count of emails classified as unsubscribe
unsubscribe_count_formatted	string	Count of emails classified as unsubscribe, formatted
uuid	(read only) string	List/Segment uuid, or Flow/Campaign uuid depending on level of stat aggregation.
view_count	integer (int32)	Count of views
view_count_formatted	string	Count of views, formatted

EmailStatPostcardSummaryRequest

Attributes

Name	Data Type	Description
commseq_postcard_uuids	array of string
days	integer (int32)

EmailStatPostcardSummaryResponse

Attributes

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

EmailStatSmsSummaryRequest

Attributes

Name	Data Type	Description
commseq_step_uuids	array of string
days	integer (int32)

EmailStatSmsSummaryResponse

Attributes

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

EmailStatSummaryRequest

Attributes

Name	Data Type	Description
commseq_email_uuids	array of string
commseq_step_uuids	array of string
days	integer (int32)

EmailStatSummaryResponse

Attributes

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

EmailStepStat

Attributes

Name	Data Type	Description
left_click_count	integer (int32)	click count (left side)
left_click_count_formatted	string	click count formatted (left side)
left_conversion_count	integer (int32)	conversion count (left/default side)
left_conversion_count_formatted	string	conversion count formatted (left/default side)
left_customer_count	integer (int32)	customer count (left/default side)
left_customer_count_formatted	string	customer count formatted (left/default side)
left_delivered_count	integer (int32)	delivered count (left side)
left_delivered_count_formatted	string	delivered count formatted (left side)
left_order_count	integer (int32)	order count (left/default side)
left_order_count_formatted	string	order count formatted (left/default side)
left_profit	number	profit (left/default side)
left_profit_formatted	string	profit formatted (left/default side)
left_revenue	number	revenue (left/default side)
left_revenue_formatted	string	revenue formatted (left/default side)
left_send_count	integer (int32)	send count (left side)
left_send_count_formatted	string	send count formatted (left side)
left_skipped_count	integer (int32)	conversion count (left side)
left_skipped_count_formatted	string	skipped count formatted (left side)
left_unsubscribe_count	integer (int32)	unsubscribe count (left side)
left_unsubscribe_count_formatted	string	unsubscribe count formatted (left side)
right_conversion_count	integer (int32)	conversion count (right side)
right_conversion_count_formatted	string	conversion count formatted (right side)
right_customer_count	integer (int32)	customer count (right side)
right_customer_count_formatted	string	customer count formatted (right side)
right_order_count	integer (int32)	order count (right side)
right_order_count_formatted	string	order count formatted (right side)
right_profit	number	profit (right side)
right_profit_formatted	string	profit formatted (right side)
right_revenue	number	revenue (right side)
right_revenue_formatted	string	revenue formatted (right side)

EmailStepStatRequest

Attributes

Name	Data Type	Description
commseq_step_uuids	array of string
days	integer (int32)

EmailStepStatResponse

Attributes

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

EmailStepWaitingRequest

Attributes

Name	Data Type	Description
commseq_step_uuids	array of string

EmailStepWaitingResponse

Attributes

Name	Data Type	Description
step_waitings	array of StepWaiting

EmailTemplate

Attributes

Name	Data Type	Description
container_cjson	string	Container cjson
description	string	Description of email template
email_template_oid	integer (int32)	Email template oid
email_template_vm_path	string	Email Template VM Path
merchant_id	string	Merchant ID
name	string(250)	Name of email template
preview_amazon_listing_key	string(250)	Amazon key for preview png image
sort_order	integer (int32)	Sort order (optional)
storefront_oid	integer (int32)	StoreFront oid
system	boolean	True if this email template is system-wide,false if merchant specific
trigger_type	string(100)	Trigger type

EmailTemplatesResponse

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
templates	array of EmailTemplate
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

EmailThirdPartyList

Attributes

Name	Data Type	Description
id	(read only) string	id
name	(read only) string	name

EmailThirdPartyListImportRequest

Attributes

Name	Data Type	Description
providers	array of EmailThirdPartyProvider	providers

EmailThirdPartyProvider

Attributes

Name	Data Type	Description
connect_url	(read only) string	URL to the settings screen to connect. Null if the provider is already connected.
list_count	(read only) integer (int32)	list_count
lists	array of EmailThirdPartyList	lists
logo_url	(read only) string	logo_url
name	(read only) string	name
supports_add_tags	(read only) boolean	True if this provider can support adding tags
supports_list_subscribe	(read only) boolean	True if this provider can support list subscribe
supports_list_unsubscribe	(read only) boolean	True if this provider can support list unsubscribe
supports_remove_tags	(read only) boolean	True if this provider can support remove tags
tag_count	(read only) integer (int32)	tag_count
tags	array of EmailThirdPartyTag	tags

EmailThirdPartyProvidersResponse

Attributes

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

EmailThirdPartyTag

Attributes

Name	Data Type	Description
id	(read only) string	id
name	(read only) string	name

EmailWebhookEditorValuesResponse

Attributes

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

Error

Attributes

Name	Data Type	Description
developer_message	string	A technical message meant to be read by a developer
error_code	string	HTTP status code
more_info	string	Additional information often a link to additional documentation
object_id	string	Object id that the error is associated with
user_message	string	An end-user friendly message suitable for display to the customer

ErrorResponse

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

Experiment

Attributes

Name	Data Type	Description
container_id	(read only) string	Contained ID where the experiment element was located
duration_days	(read only) integer (int32)	Duration in days
end_dts	(read only) string (dateTime)	End date/time
equal_weighting	(read only) boolean	Whether or not traffic is equally weighted or shifts over time during the experiment
experiment_type	(read only) string	The type of experiment
id	(read only) string	Experiment id
name	(read only) string	Experiment name
notes	(read only) string	Notes about the experiment
objective	(read only) string	Objective that is being optimized
objective_parameter	(read only) string	Objective parameter (such as event name) that is being optimized
openai_current_iteration	(read only) integer (int32)	The current iteration of the OpenAI related experiment
openai_element_type	(read only) string	The type of OpenAI element being experimented on Allowed Values headline text textblock
openai_model	(read only) string	The type of OpenAI model used
openai_total_iterations	(read only) integer (int32)	The total number of iterations to perform on the experiment
optimization_type	(read only) string	Type of optimization
p95_sessions_needed	integer (int32)	Estimated sessions needed to achieve P95
p_value	(read only) number	Statistics p-value for the experiment
session_count	(read only) integer (int32)	Total number of sessions in the experiment
start_dts	(read only) string (dateTime)	Start date/time
status	string	Status of the experiment Allowed Values Running Ended Deleted
storefront_experiment_oid	(read only) integer (int32)	Storefront Experiment Oid
storefront_oid	(read only) integer (int32)	Storefront oid
uri	(read only) string	URI the experiment was started on
variations	(read only) array of ExperimentVariation	Variations being tested in the experiment

ExperimentResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
experiment	Experiment
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

ExperimentsResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
experiments	array of Experiment
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

ExperimentVariation

Attributes

Name	Data Type	Description
add_to_cart_count	(read only) integer (int32)	Total add to cart count for this variation
average_duration_seconds	(read only) integer (int32)	Average duration seconds per session for this variation
average_objective_per_session	(read only) number	Average objective value per session for this variation
average_order_value	(read only) number	Average order value for this variation
bounce_count	(read only) integer (int32)	Total bounce count for this variation
conversion_rate	(read only) number	Conversion rate for this variation
daily_statistics	(read only) array of ExperimentVariationStat	Array of daily statistics for this variation
duration_seconds_sum	(read only) integer (int64)	Total number of seconds spent on the site for this variation
event_count	(read only) integer (int32)	Total event ocunt for this variation
initiate_checkout_count	(read only) integer (int32)	Total initiate checkout count for this variation
order_count	(read only) integer (int32)	Total order count for this variation
order_item_count	(read only) integer (int32)	Total order item count for this variation
original_traffic_percentage	(read only) number	Percentage of the traffic the variation originally started out with
page_view_count	(read only) integer (int32)	Total page view count for this variation
paused	boolean	True if traffic should be paused to this variation
revenue	(read only) number	Total revenue for this variation
session_count	(read only) integer (int32)	Total sessions for this variation
sms_opt_ins	(read only) integer (int32)	SMS Opt Ins for this variation
traffic_percentage	(read only) number	Percentage of the traffic this variation is currently receiving
url	string	Url of the variation if this experiment is a url experiment.
variation_name	(read only) string	Name of the variation
variation_number	(read only) integer (int32)	Variation number
winner	(read only) boolean	True if this variation has been declared the winner

ExperimentVariationStat

Attributes

Name	Data Type	Description
add_to_cart_count	(read only) integer (int32)	Total add to cart count for this variation
bounce_count	(read only) integer (int32)	Total bounce count for this variation
duration_seconds_sum	(read only) integer (int64)	Total number of seconds spent on the site for this variation
event_count	(read only) integer (int32)	Total event count for this variation
initiate_checkout_count	(read only) integer (int32)	Total initiate checkout count for this variation
order_count	(read only) integer (int32)	Total order count for this variation
order_ids	(read only) array of string	Order ID thats converted on this variation
order_item_count	(read only) integer (int32)	Total order item count for this variation
page_view_count	(read only) integer (int32)	Total page view count for this variation
revenue	(read only) number	Total revenue for this variation
session_count	(read only) integer (int32)	Total sessions for this variation
sms_opt_in_count	(read only) integer (int32)	Total SMS opt in count for this variation
stat_dts	(read only) string (dateTime)	Date/time that the statistic was created

FileManagerDirectory

Attributes

Name	Data Type	Description
active_theme_directory	boolean
favorite	boolean
hostname	string
icon	string
last_modified	string
name	string
parent_storefront_fs_directory_oid	integer (int32)
part_of_active_theme	boolean
selected	boolean
storefront_fs_directory_oid	integer (int32)
storefront_fs_file_oid	integer (int32)
storefront_oid	integer (int32)
type	string

FileManagerFile

Attributes

Name	Data Type	Description
favorite	boolean
hostname	string
i18n_violation	boolean
icon	string
internal_version	integer (int32)
last_modified	string
merge_conflict	boolean
name	string
parent_storefront_fs_directory_oid	integer (int32)
part_of_active_theme	boolean
path	string
raw_size	integer (int32)
selected	boolean
size	string
storefront_fs_directory_oid	integer (int32)
storefront_fs_file_oid	integer (int32)
storefront_oid	integer (int32)
thumbnail_16_url	string	CDN thumbnail 16x16 size
thumbnail_32_url	string	CDN thumbnail 32x32 size
thumbnail_64_url	string	CDN thumbnail 64x64 size
type	string
valid_velocity	string

FileManagerPage

Attributes

Name	Data Type	Description
current_storefront_fs_directory_oid	integer (int32)
directories	array of FileManagerDirectory
files	array of FileManagerFile
hostname	string
parent_storefront_fs_directory_oid	integer (int32)
path	string
path_list	array of FileManagerDirectory
storefront_oid	integer (int32)

FileManagerPageResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
file_manager_page	FileManagerPage
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

FileManagerUploadRequest

Attributes

Name	Data Type	Description
filename	string
key	string
parent_storefront_fs_directory_oid	integer (int32)

FileManagerUploadUrlResponse

Attributes

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

GeocodeRequest

Attributes

Name	Data Type	Description
address	string	address
city	string	city
country_code	string	country_code
postal_code	string	postal_code
state	string	state

GeocodeResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
latitude	number
longitude	number
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

GeoPoint

Attributes

Name	Data Type	Description
lat	number
lon	number

KeyValue

Attributes

Name	Data Type	Description
description	(read only) string	Optional description of the lookup value
key	(read only) string	The key or id of this lookup value
value	(read only) string	The value of this lookup value

LibraryFilterValues

Attributes

Name	Data Type	Description
categories	array of string
industries	array of string
styles	array of string
types	array of string

LibraryFilterValuesResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
filter_values	LibraryFilterValues	Filter values
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

LibraryItem

Attributes

Name	Data Type	Description
assets	array of LibraryItemAsset
attributes	array of LibraryItemAttribute
categories	array of string
content	string
content_type	string
description	string
industries	array of string
library_item_oid	integer (int32)
merchant_id	string
my_purchased_version	(read only) integer (int32)	If this is a public item and the merchant has already purchased it, this is their version. If not yet purchased, this will be zero. This value will only be populated during a searchPublicItems() call.
original_object_id	(read only) string	This id points to the original object that was added to the library. For flows and campaigns, this is a uuid string. For upsells, it is an oid integer. For transactional_emails, it is an email name.
price	number	The price of the published item. Null for any private library items.
price_formatted	string	The formatted price of the published item. Null for any private library items.
published	(read only) boolean	True if this library item is a published item (not source)
published_dts	(read only)	The timestamp of the last published version
published_from_library_item_oid	(read only) integer (int32)	The source item used to publish this item. This allows for comparisons between source and published
published_meta	(read only) LibraryItemPublishedMeta	Meta information for a published source item.
published_version	(read only) integer (int32)	The source version when this item was published. This allows for out-of-date alerts to be shown when there is a difference between source and published
purchased	(read only) boolean	True if this library item has been purchased
purchased_from_library_item_oid	(read only) integer (int32)	The published item that was purchased to make this item. This allows for comparisons between published and purchased
purchased_meta	(read only) LibraryItemPurchasedMeta	Meta information for a purchased item.
purchased_version	(read only) integer (int32)	The published version when this item was purchased. This allows for out-of-date alerts to be shown when there is a difference between published and purchased
rejected	(read only) boolean	Any published library reviewed by UltraCart staff for malicious or inappropriate content will have this flag set to true. This is always false for non-published items
rejected_reason	(read only) string	Any rejected published item will have this field populated with the reason.
release_notes	(read only) string	Release notes specific to each published version and only appearing on public items.
release_version	(read only) integer (int32)	This counter records how many times a library item has been published. This is used to show version history.
reviewed	(read only) boolean	Any published library items must be reviewed by UltraCart staff for malicious content. This flag shows the status of that review. This is always false for non-published items
reviewed_dts	(read only)	This is the timestamp for a published items formal review by UltraCart staff for malicious content.
screenshots	array of LibraryItemScreenshot
share_with_accounts	array of LibraryItemAccount
share_with_other_emails	array of LibraryItemEmail
shared	(read only) boolean	True if this item is shared from another merchant account
source	(read only) boolean	True if this library item has been published
source_to_library_item_oid	(read only) integer (int32)	This oid points to the published library item, if there is one.
source_version	(read only) integer (int32)	The version of this item. Increment every time the item is saved.
style	string
times_purchased	integer (int32)
title	string
type	string
under_review	(read only) boolean	True if this library item was published but is awaiting review from UltraCart staff.

LibraryItemAccount

Attributes

Name	Data Type	Description
library_item_account_oid	integer (int32)
library_item_oid	integer (int32)
other_merchant_id	string

LibraryItemAsset

Attributes

Name	Data Type	Description
mime_type	string
url	string

LibraryItemAttribute

Attributes

Name	Data Type	Description
name	string
value	string

LibraryItemEmail

Attributes

Name	Data Type	Description
email	string
library_item_email_oid	integer (int32)
library_item_oid	integer (int32)

LibraryItemPublishedMeta

Attributes

Name	Data Type	Description
count_of_versions	(read only) integer (int32)	The number of published versions a source item has, or zero if this item is not a source or is private
library_item_published_oid	(read only) integer (int32)	The oid pointing to the most recent published version, or zero if this is not a published source item.
library_item_review_oid	(read only) integer (int32)	The oid pointing to the review data if this is a source library item and currently under review
rejected	(read only) boolean	True if this is a source item and is under review and was rejected.
rejected_reason	(read only) string	The reason for rejection if this item is a source item, is under review, and was rejected. For all other cases, this value will be null or missing.
release_version	(read only) integer (int32)	If this library item is a source item and it is published, this is the most recent release version number
review_version	(read only) integer (int32)	If this library item is a source item and has a published item currently under review, this is that version number
under_review	(read only) boolean	True if this library item is a source item and is currently under review

LibraryItemPurchasedMeta

Attributes

Name	Data Type	Description
most_recent_version	(read only) integer (int32)	The most recent version of the item purchased
my_purchased_version	(read only) integer (int32)	If this is a public item and the merchant has already purchased it, this is their version. If not yet purchased, this will be zero. This value will only be populated during a searchPublicItems() call.
upgrade_available	(read only) boolean	True if the most recent version of this purchase it greater than what was purchased

LibraryItemQuery

Attributes

Name	Data Type	Description
category	string	Category
content_type	string	Library item content type such as flow, campaign, cjson, email, or transactional_email
description	string	Description of library item
industry	string	Industry
price_high	number	Maximum price
price_low	number	Minimum price
published_dts_begin	string	Minimum published date/time
published_dts_end	string	Maximum published date/time
source_of_published	boolean	Boolean, true if this library item has been published and is the master copy of that published work
style	string	Library item style
title	string	Title of the library item
type	string	Library item type such as header, footer, shipping block, etc

LibraryItemResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
library_item	LibraryItem	Library item
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

LibraryItemScreenshot

Attributes

Name	Data Type	Description
default_url	boolean
screenshot_url	string

LibraryItemsResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
items	array of LibraryItem	Library items
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

LookupRequest

Attributes

Name	Data Type	Description
category	string
matches	string
max_hits	integer (int32)
storefront_host_name	string
storefront_oid	integer (int32)
subcategory	string

LookupResponse

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
values	array of KeyValue
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

Mailgun

Attributes

Name	Data Type	Description
api_key	string

PricingTier

Attributes

Name	Data Type	Description
allow_3rd_party_billing	boolean	Allow 3rd party billing
allow_cod	boolean	Allow COD
allow_purchase_order	boolean	Allow purchase order
allow_quote_request	boolean	Allow quote request
approval_notification	PricingTierNotification	Approval notification
auto_approve_cod	boolean	Auto approve COD
auto_approve_purchase_order	boolean	Auto approve purchase order
currency_code	string	Any currency code specified on this pricing tier will force a shopping cart into that currency
default_on_wholesale_signup	boolean	Default on wholesale signup
default_percentage_discount	number	Default percentage discount
default_shipping_method_oid	integer (int32)	Default shipping method oid
default_tier	boolean	Default tier
display_on_wholesale_signup	boolean	Display on wholesale signup
exclude_from_free_promotion	boolean	Exclude from free promotion
exempt_loyalty_rewards	boolean	Exempt from Loyalty Rewards
exempt_shipping_handling_charge	boolean	Exempt shipping handling charge
free_shipping	boolean	Free shipping
free_shipping_minimum	number	Free shipping minimum
maximum_item_count	integer (int32)	Maximum item count
minimum_item_count	integer (int32)	Minimum item count
minimum_subtotal	number	Minimum subtotal
name	string(50)	Name
no_coupons	boolean	No coupons
no_free_shipping	boolean	No free shipping
no_realtime_charge	boolean	No realtime charge
not_valid_when_coupon_present	boolean	Not valid when coupon present
pricing_tier_oid	integer (int32)	Pricing Tier Oid
realtime_percentage_discount	number	Realtime percentage discount
restrict_to_distribution_center_oid	integer (int32)	Restrict inventory to this distribution center oid
signup_notification	PricingTierNotification	Signup notification
suppress_buysafe	boolean	Suppress buySAFE (deprecated)
suppress_mailing_list	boolean	Suppress mailing list
tax_exempt	boolean	Tax Exempt
track_separately	boolean	Track separately

PricingTierNotification

Attributes

Name	Data Type	Description
format	string(16)	Notification format
subject	string(100)	Notification subject
text	string	Notification text

PricingTiersResponse

Attributes

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

PublishLibraryItemRequest

Attributes

Name	Data Type	Description
release_notes	string	Release notes for this release version.

ResponseMetadata

Attributes

Name	Data Type	Description
payload_name	string	Payload name
result_set	ResultSet	Result set

ResultSet

Attributes

Name	Data Type	Description
count	integer (int32)	Number of results in this set
limit	integer (int32)	Maximum number of results that can be returned in a set
more	boolean	True if there are more results to query
next_offset	integer (int32)	The next offset that you should query to retrieve more results
offset	integer (int32)	Offset of this result set (zero based)
total_records	integer (int32)	The total number of records in the result set. May be null if the number is not known and the client should continue iterating as long as more is true.

RulerValidationRequest

Attributes

Name	Data Type	Description
ruler	string

RulerValidationResponse

Attributes

Name	Data Type	Description
error_message	string
valid	boolean

ScreenRecording

Attributes

Name	Data Type	Description
ad_platform	ScreenRecordingAdPlatform	Ad Platform Identifiers
analytics_client_oid	integer (int64)
analytics_session_dts	integer (int64)
analytics_session_oid	integer (int64)
communications_campaign_name	string	Campaign Name
communications_campaign_uuid	string	Campaign UUID
communications_email_subject	string	Email subject
communications_email_uuid	string	Email UUID
communications_flow_name	string	Flow Name
communications_flow_uuid	string	Flow UUID
email	string
email_domain	string
end_timestamp	string (dateTime)	Ending timestamp
esp_customer_uuid	string
events_gz_size	integer (int32)
events_json_key	string
favorite	(read only) boolean	True if the user calling the API has favorited this particular screen recording.
favorites	array of integer (int32)	Array of user ids that favorited this particular screen recording.
geolocation	GeoPoint
geolocation_country	string
geolocation_state	string
language_iso_code	string	Language ISO code
merchant_id	string
merchant_notes	string
missing_external_tracking	boolean	True if external page view was not tracked
order_id	string
page_view_count	integer (int32)
page_views	array of ScreenRecordingPageView
preferred_language	string	ISO 3 Letter language code that the customer would prefer
referrer_domain	string
rrweb_version	string
screen_recording_uuid	string
signed_download_url	string
start_timestamp	string (dateTime)	Starting timestamp
storefront_oids	array of integer (int32)
storefronts	array of ScreenRecordingStoreFront
tags	array of string
time_on_site	integer (int32)
ucacid	string
user_agent	ScreenRecordingUserAgent
user_agent_raw	string
user_ip	string
user_properties	array of ScreenRecordingUserProperty
utm_campaign	string	UTM Campaign
utm_source	string	UTM Source
visitor_first_seen	string (dateTime)	Timestamp this visitor was first seen
visitor_number	integer (int32)
watched	boolean
window_height	integer (int32)
window_width	integer (int32)

ScreenRecordingAdPlatform

Attributes

Name	Data Type	Description
fbc	string	Facebook Click Id (Cookie)
fbclid	string	Facebook Click Id Parameter (Parameter)
fbp	string	Facebook Browser Id (Cookie)
gacid	string	Google Analytics CID (Cookie)
glcid	string	Google Adwords Click Id (Parameter)
msclkid	string	Bing Click Id (Parameter
ttclid	string	TikTok Click Id (Parameter

ScreenRecordingFilter

Attributes

Name	Data Type	Description
affiliate_email	string
affiliate_id	integer (int32)
communications_campaign_name	string
communications_campaign_name_filter	boolean
communications_email_subject	string
communications_email_subject_filter	boolean
communications_flow_name	string
communications_flow_name_filter	boolean
email	ScreenRecordingFilterStringSearch
email_domain	string
email_domain_filter	boolean
email_identified	boolean
end_timestamp	ScreenRecordingFilterRangeDate
esp_customer_uuid	string
favorite	boolean
geolocation	ScreenRecordingFilterGeoDistance
geolocation_country	ScreenRecordingFilterStringSearch
geolocation_country_filter	boolean
geolocation_state	ScreenRecordingFilterStringSearch
geolocation_state_filter	boolean
language_iso_code	ScreenRecordingFilterStringSearch
language_iso_code_filter	boolean
last_x_days	integer (int32)
max_filter_values	integer (int32)
order_id	ScreenRecordingFilterStringSearch
page_view_count	ScreenRecordingFilterRangeInteger
page_views	array of ScreenRecordingFilterPageView
placed_order	boolean
preferred_language	ScreenRecordingFilterStringSearch
preferred_language_filter	boolean
referrer_domain	string
referrer_domain_filter	boolean
screen_recording_uuids	array of string
screen_sizes	array of string
skip_filter_values	boolean
skip_histogram	boolean
skip_hits	boolean
start_timestamp	ScreenRecordingFilterRangeDate
tags	array of string
time_on_site	ScreenRecordingFilterRangeInteger
time_on_site_max_filter	boolean
time_on_site_min_filter	boolean
url_filter	boolean
user_agent_device_name	string
user_agent_device_name_filter	boolean
user_agent_device_os_name_filter	boolean
user_agent_device_os_version_filter	boolean
user_agent_name	string
user_agent_name_filter	boolean
user_agent_original	ScreenRecordingFilterStringSearch
user_agent_original_filter	boolean
user_agent_os_name	string
user_agent_os_version	string
user_ip	ScreenRecordingFilterIpSearch
utm_campaign	string
utm_campaign_filter	boolean
utm_source	string
utm_source_filter	boolean
visitor_number	integer (int32)
watched	boolean

ScreenRecordingFilterGeoDistance

Attributes

Name	Data Type	Description
distance	integer (int32)
distance_uom	string
from_address	string
lat	number
lon	number

ScreenRecordingFilterIpSearch

Attributes

Name	Data Type	Description
does_not_exist	boolean
exists	boolean
is	string
is_not	string

ScreenRecordingFilterPageView

Attributes

Name	Data Type	Description
domain	ScreenRecordingFilterStringSearch
domain_filter	boolean
event_name_filter	boolean
event_param_name_filter	boolean
event_param_value_filter	boolean
events	array of ScreenRecordingFilterPageViewEvent
param_name_filter	boolean
param_value_filter	boolean
params	array of ScreenRecordingFilterPageViewParam
referrer	ScreenRecordingFilterStringSearch
referrer_params	array of ScreenRecordingFilterPageViewReferrerParam
referrer_raw	ScreenRecordingFilterStringSearch
time_on_page	ScreenRecordingFilterRangeInteger
time_on_page_max_filter	boolean
time_on_page_min_filter	boolean
url	ScreenRecordingFilterStringSearch
url_filter	boolean

ScreenRecordingFilterPageViewEvent

Attributes

Name	Data Type	Description
event_name	string
event_params	array of ScreenRecordingFilterPageViewEventParam

ScreenRecordingFilterPageViewEventParam

Attributes

Name	Data Type	Description
name	string
value_bd	ScreenRecordingFilterRangeBigDecimal
value_bool	boolean
value_num	ScreenRecordingFilterRangeInteger
value_text	ScreenRecordingFilterStringSearch

ScreenRecordingFilterPageViewParam

Attributes

Name	Data Type	Description
name	string
value	ScreenRecordingFilterStringSearch

ScreenRecordingFilterPageViewReferrerParam

Attributes

Name	Data Type	Description
name	string
value	ScreenRecordingFilterStringSearch

ScreenRecordingFilterRangeBigDecimal

Attributes

Name	Data Type	Description
eq	number
gt	number
gte	number
lt	number
lte	number

ScreenRecordingFilterRangeDate

Attributes

Name	Data Type	Description
end	string (dateTime)	End of the range
start	string (dateTime)	Start of the range

ScreenRecordingFilterRangeInteger

Attributes

Name	Data Type	Description
eq	integer (int32)
gt	integer (int32)
gte	integer (int32)
lt	integer (int32)
lte	integer (int32)

ScreenRecordingFilterStringSearch

Attributes

Name	Data Type	Description
does_not_exist	boolean
exists	boolean
is	string
is_not	string
starts_with	string

ScreenRecordingFilterValues

Attributes

Name	Data Type	Description
communications_campaign_names	array of string
communications_email_subjects	array of string
communications_flow_names	array of string
email_domains	array of string
geolocation_countries	array of string
geolocation_states	array of string
language_iso_codes	array of string
max_values	integer (int32)
page_views	array of ScreenRecordingFilterValuesPageView
preferred_languages	array of string
referrer_domains	array of string
time_on_site_max	integer (int32)
time_on_site_min	integer (int32)
urls	array of string
user_agent_device_names	array of string
user_agent_device_os_names	array of string
user_agent_device_os_versions	array of string
user_agent_names	array of string
user_agent_originals	array of string
utm_campaigns	array of string
utm_sources	array of string

ScreenRecordingFilterValuesEvent

Attributes

Name	Data Type	Description
name	string
params	array of ScreenRecordingFilterValuesEventParams

ScreenRecordingFilterValuesEventParams

Attributes

Name	Data Type	Description
name	string
values_bd	array of number
values_bool	array of boolean
values_num	array of integer
values_text	array of string

ScreenRecordingFilterValuesPageParam

Attributes

Name	Data Type	Description
name	string
values	array of string

ScreenRecordingFilterValuesPageView

Attributes

Name	Data Type	Description
domains	array of string
events	array of ScreenRecordingFilterValuesEvent
page_params	array of ScreenRecordingFilterValuesPageParam
time_on_page_max	integer (int32)
time_on_page_min	integer (int32)
urls	array of string

ScreenRecordingHeatmap

Attributes

Name	Data Type	Description
large_click_thumbnail_url	string
large_click_url	string
large_movement_thumbnail_url	string
large_movement_url	string
large_regular_thumbnail_url	string
large_regular_url	string
large_scroll_thumbnail_url	string
large_scroll_url	string
medium_click_thumbnail_url	string
medium_click_url	string
medium_movement_thumbnail_url	string
medium_movement_url	string
medium_regular_thumbnail_url	string
medium_regular_url	string
medium_scroll_thumbnail_url	string
medium_scroll_url	string
small_click_thumbnail_url	string
small_click_url	string
small_movement_thumbnail_url	string
small_movement_url	string
small_regular_thumbnail_url	string
small_regular_url	string
small_scroll_thumbnail_url	string
small_scroll_url	string

ScreenRecordingHeatmapIndexRequest

Attributes

Name	Data Type	Description
url_contains	string

ScreenRecordingHeatmapIndexResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
heatmap_urls	array of ScreenRecordingHeatmapUrl
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

ScreenRecordingHeatmapRequest

Attributes

Name	Data Type	Description
range	ScreenRecordingFilterRangeDate
screen_sizes	array of string
url	string

ScreenRecordingHeatmapReset

Attributes

Name	Data Type	Description
url	string

ScreenRecordingHeatmapResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
heatmap	ScreenRecordingHeatmap
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

ScreenRecordingHeatmapUrl

Attributes

Name	Data Type	Description
histogram_data	array of integer (int32)
histogram_interval	string
histogram_start_dts	string
page_rank	integer (int32)
session_count	integer (int32)
url	string

ScreenRecordingMerchantNotesRequest

Attributes

Name	Data Type	Description
merchant_notes	string

ScreenRecordingMultifield

Attributes

Name	Data Type	Description
bd	number
bool	boolean
json	string
num	integer (int64)
text	string

ScreenRecordingPageView

Attributes

Name	Data Type	Description
domain	string
events	array of ScreenRecordingPageViewEvent
first_event_timestamp	string (dateTime)	First event timestamp
http_post	boolean
last_event_timestamp	string (dateTime)	Last event timestamp
missing_events	boolean
params	array of ScreenRecordingPageViewParameter
range_end	integer (int32)
range_start	integer (int32)
referrer	string
referrer_params	array of ScreenRecordingPageViewParameter
referrer_raw	string
screen_recording_page_view_uuid	string
time_on_page	integer (int32)
timing_dom_content_loaded	integer (int32)	Amount of time for DOMContentLoaded event to fire (milliseconds)
timing_loaded	integer (int32)	Amount of time for loaded event to fire (milliseconds)
truncated_events	boolean
ucapv	string
url	string

ScreenRecordingPageViewDataResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
events_json	string
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

ScreenRecordingPageViewEvent

Attributes

Name	Data Type	Description
name	string
params	array of ScreenRecordingPageViewEventParameter
prior_page_view	boolean
sub_text	string
timestamp	string (dateTime)	Timestamp of the event
ts	integer (int64)

ScreenRecordingPageViewEventParameter

Attributes

Name	Data Type	Description
name	string
value	ScreenRecordingMultifield

ScreenRecordingPageViewParameter

Attributes

Name	Data Type	Description
name	string
value	string

ScreenRecordingQueryRequest

Attributes

Name	Data Type	Description
filter	ScreenRecordingFilter

ScreenRecordingQueryResponse

Attributes

Name	Data Type	Description
checkout_only	boolean
error	Error	Error object if unsuccessful
filter	ScreenRecordingFilter
filter_values	ScreenRecordingFilterValues
histogram_data	array of integer (int32)
histogram_interval	string
histogram_start_dts	string
metadata	ResponseMetadata	Meta-data about the response such as payload or paging information
screen_recordings	array of ScreenRecording
success	boolean	Indicates if API call was successful
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

ScreenRecordingResponse

Attributes

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

ScreenRecordingSegment

Attributes

Name	Data Type	Description
create_dts	string
description	string
filter	ScreenRecordingFilter
histogram_data	array of integer (int32)
histogram_interval	string
histogram_start_dts	string
name	string
screen_recording_segment_oid	integer (int32)
session_count	integer (int32)
session_count_last_update_dts	string

ScreenRecordingSegmentResponse

Attributes

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

ScreenRecordingSegmentsResponse

Attributes

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

ScreenRecordingSettings

Attributes

Name	Data Type	Description
cost_per_thousand	(read only) number	Cost per one thousand sessions
enabled	boolean
retention_interval	(read only) string	How long screen recording data is retained
sessions_current_billing_period	integer (int32)
sessions_last_billing_period	integer (int32)
sessions_trial_billing_period	integer (int32)
trial_expiration	string
trial_expired	boolean

ScreenRecordingSettingsResponse

Attributes

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

ScreenRecordingStoreFront

Attributes

Name	Data Type	Description
storefront_host_name	string
storefront_oid	integer (int32)

ScreenRecordingTagsRequest

Attributes

Name	Data Type	Description
tags	array of string

ScreenRecordingTagsResponse

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
tags	array of string
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

ScreenRecordingUserAgent

Attributes

Name	Data Type	Description
device	ScreenRecordingUserAgentDevice
name	string
original	string
os	ScreenRecordingUserAgentOS
version	string

ScreenRecordingUserAgentDevice

Attributes

Name	Data Type	Description
name	string

ScreenRecordingUserAgentOS

Attributes

Name	Data Type	Description
full	string
name	string
version	string

ScreenRecordingUserProperty

Attributes

Name	Data Type	Description
name	string
value	ScreenRecordingMultifield

ScreenshotsResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
metadata	ResponseMetadata	Meta-data about the response such as payload or paging information
screenshots	array of string	List of screenshot urls related to the object (depends on which method was called).
success	boolean	Indicates if API call was successful
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

StepWaiting

Attributes

Name	Data Type	Description
commseq_step_uuid	string
number_waiting	integer (int32)

StoreFront

Attributes

Name	Data Type	Description
host_alias1	string
host_alias2	string
host_alias3	string
host_alias4	string
host_alias5	string
host_name	string
locked	boolean
merchant_id	string
redirect_aliases	boolean
storefront_oid	integer (int32)
unlock_password	string

StoreFrontPageContentAttribute

Attributes

Name	Data Type	Description
name	string(100000)	Attribute name
translated_text_instance_oid	(read only) integer (int32)	Attribute translated text instance identifier
type	string	Attribute type
value	string(100000)	Attribute value

StoreFrontsResponse

Attributes

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

ThumbnailParametersRequest

Attributes

Name	Data Type	Description
height	integer (int32)
pngFormat	boolean
squareThumbnail	boolean
webp	boolean
width	integer (int32)

ThumbnailParametersResponse

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
thumbnail_url_suffix	string	Suffix to append to the larger image URL to obtain the thumbnail
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

TransactionEmail

Attributes

Name	Data Type	Description
content	string	Actual template contents
esp_domain_uuid	string	The uuid of the sending domain
esp_friendly_name	string	Friendly from that will appear in customer email clients.
esp_user	string	The username of the sending email. This is not the full email. Only the username which is everything before the @ sign.
file_exists	(read only) boolean	An internal identifier used to aid in retrieving templates from the filesystem.
file_name	string	File name
group	(read only) string	Group
handlebar_variables	(read only) array of string	Handlebar Variables available for email template
invalid	(read only) boolean	Invalid will be true if the template cannot compile
last_modified	(read only) string (dateTime)	Last modified timestamp
library_item_oid	integer (int32)	If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.
options	array of TransactionEmailOption	Options that help govern how and when this template is used
path	string	directory path where template is stored in file system
size	(read only) string	Size of file in friendly description
store_front_fs_directory_oid	(read only) integer (int32)	Internal identifier used to store and retrieve template from filesystem
store_front_fs_file_oid	(read only) integer (int32)	Internal identifier used to store and retrieve template from filesystem
subject	string	Subject
syntax_errors	(read only) string	Any syntax errors contained within the tempalate
template_path_relative_path	(read only) string	Internal value used to locate the template in the filesystem
theme_relative_path	(read only) string	Theme relative path in the filesystem.

TransactionEmailListResponse

Attributes

Name	Data Type	Description
email_names	array of string
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

TransactionEmailOption

Attributes

Name	Data Type	Description
description	string
merchantEmailDeliveryOptionOid	integer (int32)
merchantId	string
name	string
selected	boolean
storeFrontOid	integer (int32)
templateDisplay	string
templateType	string

TransactionEmailResponse

Attributes

Name	Data Type	Description
email	TransactionEmail
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

Twilio

Attributes

Name	Data Type	Description
account_sid	string
api_key_id	string
api_key_name	string
auth_token	string
esp_twilio_uuid	string
inbound_twiml_app_sid	string
outbound_twiml_app_sid	string
phone_numbers	array of string
twilio_workspace_sid	string

TwilioResponse

Attributes

Name	Data Type	Description
diagnostics	string
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
twilio	Twilio
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

TwiliosResponse

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
twilios	array of Twilio
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

VerificationRecord

Attributes

Name	Data Type	Description
name	string
type	string
value	string

Warning

Attributes

Name	Data Type	Description
more_info	string	Additional information often a link to additional documentation
warning_message	string	A technical message meant to be read by a developer

400
Status Code 400: bad request input such as invalid json

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse

401
Status Code 401: invalid credentials supplied

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse

410
Status Code 410: Your authorized application has been disabled by UltraCart

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse

429
Status Code 429: you have exceeded the allowed API call rate limit for your application.

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse

500
Status Code 500: any server side error. the body will contain a generic server error message

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse