Search code, repositories, users, issues, pull requests...

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applyToStoreFront

\ultracart\v2\models\ApplyLibraryItemResponse applyToStoreFront($apply_library_request)

Apply library item to storefront.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$apply_library_request = new \ultracart\v2\models\ApplyLibraryItemRequest(); // \ultracart\v2\models\ApplyLibraryItemRequest | New library item

try {
    $result = $apiInstance->applyToStoreFront($apply_library_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->applyToStoreFront: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
apply_library_request	\ultracart\v2\models\ApplyLibraryItemRequest	New library item

Return type

\ultracart\v2\models\ApplyLibraryItemResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

archiveEmailList

\ultracart\v2\models\EmailListArchiveResponse archiveEmailList($storefront_oid, $email_list_uuid)

Archive email list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_uuid = "email_list_uuid_example"; // string | 

try {
    $result = $apiInstance->archiveEmailList($storefront_oid, $email_list_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->archiveEmailList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_list_uuid	string

Return type

\ultracart\v2\models\EmailListArchiveResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

archiveEmailSegment

\ultracart\v2\models\EmailSegmentArchiveResponse archiveEmailSegment($storefront_oid, $email_segment_uuid)

Archive email segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 

try {
    $result = $apiInstance->archiveEmailSegment($storefront_oid, $email_segment_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->archiveEmailSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_segment_uuid	string

Return type

\ultracart\v2\models\EmailSegmentArchiveResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

backPopulateEmailFlow

\ultracart\v2\models\EmailFlowBackPopulateResponse backPopulateEmailFlow($storefront_oid, $email_flow_uuid, $back_populate_request)

Back populate email flow

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_uuid = "email_flow_uuid_example"; // string | 
$back_populate_request = new \ultracart\v2\models\EmailFlowBackPopulateRequest(); // \ultracart\v2\models\EmailFlowBackPopulateRequest | The request to back populate

try {
    $result = $apiInstance->backPopulateEmailFlow($storefront_oid, $email_flow_uuid, $back_populate_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->backPopulateEmailFlow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_flow_uuid	string
back_populate_request	\ultracart\v2\models\EmailFlowBackPopulateRequest	The request to back populate

Return type

\ultracart\v2\models\EmailFlowBackPopulateResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkDownloadEmailSegment

\ultracart\v2\models\EmailSegmentDownloadPrepareResponse checkDownloadEmailSegment($storefront_oid, $email_segment_uuid, $email_segment_rebuild_uuid)

Check download of email segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 
$email_segment_rebuild_uuid = "email_segment_rebuild_uuid_example"; // string | 

try {
    $result = $apiInstance->checkDownloadEmailSegment($storefront_oid, $email_segment_uuid, $email_segment_rebuild_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->checkDownloadEmailSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_segment_uuid	string
email_segment_rebuild_uuid	string

Return type

\ultracart\v2\models\EmailSegmentDownloadPrepareResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cloneEmailCampaign

\ultracart\v2\models\EmailCampaignResponse cloneEmailCampaign($storefront_oid, $email_campaign_uuid, $target_storefront_oid)

Clone email campaign

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_uuid = "email_campaign_uuid_example"; // string | 
$target_storefront_oid = 56; // int | 

try {
    $result = $apiInstance->cloneEmailCampaign($storefront_oid, $email_campaign_uuid, $target_storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->cloneEmailCampaign: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
email_campaign_uuid	string
target_storefront_oid	int	[optional]

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cloneEmailFlow

\ultracart\v2\models\EmailFlowResponse cloneEmailFlow($storefront_oid, $email_flow_uuid, $target_storefront_oid)

Clone email flow

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_uuid = "email_flow_uuid_example"; // string | 
$target_storefront_oid = 56; // int | 

try {
    $result = $apiInstance->cloneEmailFlow($storefront_oid, $email_flow_uuid, $target_storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->cloneEmailFlow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
email_flow_uuid	string
target_storefront_oid	int	[optional]

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createEmailSendingDomain

\ultracart\v2\models\EmailSendingDomainResponse createEmailSendingDomain($domain)

Create email campaign

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$domain = "domain_example"; // string | 

try {
    $result = $apiInstance->createEmailSendingDomain($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->createEmailSendingDomain: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
domain	string

Return type

\ultracart\v2\models\EmailSendingDomainResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createEmailSendingDomain2

\ultracart\v2\models\EmailSendingDomainResponse createEmailSendingDomain2($email_domain)

Create email sending domain for various providers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$email_domain = new \ultracart\v2\models\EmailDomain(); // \ultracart\v2\models\EmailDomain | EmailDomain

try {
    $result = $apiInstance->createEmailSendingDomain2($email_domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->createEmailSendingDomain2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
email_domain	\ultracart\v2\models\EmailDomain	EmailDomain

Return type

\ultracart\v2\models\EmailSendingDomainResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createFsDirectory

\ultracart\v2\models\FileManagerPageResponse createFsDirectory($id, $name, $parent_storefront_fs_directory_oid)

Create file manager directory

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$id = 56; // int | 
$name = "name_example"; // string | 
$parent_storefront_fs_directory_oid = 56; // int | 

try {
    $result = $apiInstance->createFsDirectory($id, $name, $parent_storefront_fs_directory_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->createFsDirectory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
id	int
name	string	[optional]
parent_storefront_fs_directory_oid	int	[optional]

Return type

\ultracart\v2\models\FileManagerPageResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createTwilioAccount

\ultracart\v2\models\TwilioResponse createTwilioAccount($twilio)

Create Twilio account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$twilio = new \ultracart\v2\models\Twilio(); // \ultracart\v2\models\Twilio | Twilio

try {
    $result = $apiInstance->createTwilioAccount($twilio);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->createTwilioAccount: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
twilio	\ultracart\v2\models\Twilio	Twilio

Return type

\ultracart\v2\models\TwilioResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEmailCampaignFolder

\ultracart\v2\models\BaseResponse deleteEmailCampaignFolder($storefront_oid, $email_campaign_folder_uuid)

Delete email campaignFolder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_folder_uuid = "email_campaign_folder_uuid_example"; // string | 

try {
    $result = $apiInstance->deleteEmailCampaignFolder($storefront_oid, $email_campaign_folder_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteEmailCampaignFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_campaign_folder_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEmailCommseqStat

deleteEmailCommseqStat($storefront_oid, $commseq_uuid)

Delete communication sequence stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 

try {
    $apiInstance->deleteEmailCommseqStat($storefront_oid, $commseq_uuid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteEmailCommseqStat: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_uuid	string

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEmailEmail

\ultracart\v2\models\BaseResponse deleteEmailEmail($storefront_oid, $commseq_email_uuid)

Delete email email

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_email_uuid = "commseq_email_uuid_example"; // string | 

try {
    $result = $apiInstance->deleteEmailEmail($storefront_oid, $commseq_email_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteEmailEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_email_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEmailFlowFolder

\ultracart\v2\models\BaseResponse deleteEmailFlowFolder($storefront_oid, $email_flow_folder_uuid)

Delete email flowFolder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_folder_uuid = "email_flow_folder_uuid_example"; // string | 

try {
    $result = $apiInstance->deleteEmailFlowFolder($storefront_oid, $email_flow_folder_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteEmailFlowFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_flow_folder_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEmailListCustomer

\ultracart\v2\models\BaseResponse deleteEmailListCustomer($storefront_oid, $email_list_uuid, $email_customer_uuid)

Delete email list customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_uuid = "email_list_uuid_example"; // string | 
$email_customer_uuid = "email_customer_uuid_example"; // string | 

try {
    $result = $apiInstance->deleteEmailListCustomer($storefront_oid, $email_list_uuid, $email_customer_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteEmailListCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_list_uuid	string
email_customer_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEmailListSegmentFolder

\ultracart\v2\models\BaseResponse deleteEmailListSegmentFolder($storefront_oid, $email_list_segment_folder_uuid)

Delete email ListSegmentFolder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_segment_folder_uuid = "email_list_segment_folder_uuid_example"; // string | 

try {
    $result = $apiInstance->deleteEmailListSegmentFolder($storefront_oid, $email_list_segment_folder_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteEmailListSegmentFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_list_segment_folder_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEmailPostcard

\ultracart\v2\models\BaseResponse deleteEmailPostcard($storefront_oid, $commseq_postcard_uuid)

Delete email postcard

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_postcard_uuid = "commseq_postcard_uuid_example"; // string | 

try {
    $result = $apiInstance->deleteEmailPostcard($storefront_oid, $commseq_postcard_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteEmailPostcard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_postcard_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEmailSendingDomain

\ultracart\v2\models\BaseResponse deleteEmailSendingDomain($domain)

delete email campaign

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$domain = "domain_example"; // string | 

try {
    $result = $apiInstance->deleteEmailSendingDomain($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteEmailSendingDomain: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
domain	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteExperiment

deleteExperiment($storefront_oid, $storefront_experiment_oid)

Delete experiment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$storefront_experiment_oid = 56; // int | 

try {
    $apiInstance->deleteExperiment($storefront_oid, $storefront_experiment_oid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteExperiment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
storefront_experiment_oid	int

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFsFile

\ultracart\v2\models\FileManagerPageResponse deleteFsFile($id, $parent_storefront_fs_directory_oid, $storefront_fs_file_oid)

Delete file manager directory

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$id = 56; // int | 
$parent_storefront_fs_directory_oid = 56; // int | 
$storefront_fs_file_oid = 56; // int | 

try {
    $result = $apiInstance->deleteFsFile($id, $parent_storefront_fs_directory_oid, $storefront_fs_file_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteFsFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
id	int
parent_storefront_fs_directory_oid	int	[optional]
storefront_fs_file_oid	int	[optional]

Return type

\ultracart\v2\models\FileManagerPageResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteHeatmap

deleteHeatmap($storefront_oid, $query)

Delete screen recording heatmap

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$query = new \ultracart\v2\models\ScreenRecordingHeatmapReset(); // \ultracart\v2\models\ScreenRecordingHeatmapReset | Query

try {
    $apiInstance->deleteHeatmap($storefront_oid, $query);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteHeatmap: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
query	\ultracart\v2\models\ScreenRecordingHeatmapReset	Query

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

deleteLibraryItem

deleteLibraryItem($library_item_oid)

Delete library item

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$library_item_oid = 56; // int | 

try {
    $apiInstance->deleteLibraryItem($library_item_oid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteLibraryItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
library_item_oid	int

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteLibraryItemPublishedVersions

deleteLibraryItemPublishedVersions($library_item_oid)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$library_item_oid = 56; // int | 

try {
    $apiInstance->deleteLibraryItemPublishedVersions($library_item_oid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteLibraryItemPublishedVersions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
library_item_oid	int

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteScreenRecordingSegment

deleteScreenRecordingSegment($storefront_oid, $screen_recording_segment_oid)

Delete screen recording segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_segment_oid = 56; // int | 

try {
    $apiInstance->deleteScreenRecordingSegment($storefront_oid, $screen_recording_segment_oid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteScreenRecordingSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
screen_recording_segment_oid	int

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteTwilioAccount

\ultracart\v2\models\BaseResponse deleteTwilioAccount($esp_twilio_uuid)

delete Twilio account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$esp_twilio_uuid = "esp_twilio_uuid_example"; // string | 

try {
    $result = $apiInstance->deleteTwilioAccount($esp_twilio_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->deleteTwilioAccount: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
esp_twilio_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

duplicateLibraryItem

\ultracart\v2\models\LibraryItemResponse duplicateLibraryItem($library_item_oid)

Duplicate library item.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$library_item_oid = 56; // int | 

try {
    $result = $apiInstance->duplicateLibraryItem($library_item_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->duplicateLibraryItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
library_item_oid	int

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

favoriteScreenRecording

favoriteScreenRecording($storefront_oid, $screen_recording_uuid)

Update favorite flag on screen recording

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_uuid = "screen_recording_uuid_example"; // string | 

try {
    $apiInstance->favoriteScreenRecording($storefront_oid, $screen_recording_uuid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->favoriteScreenRecording: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
screen_recording_uuid	string

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

geocodeAddress

\ultracart\v2\models\GeocodeResponse geocodeAddress($storefront_oid, $geocode_request)

Obtain lat/long for an address

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$geocode_request = new \ultracart\v2\models\GeocodeRequest(); // \ultracart\v2\models\GeocodeRequest | geocode request

try {
    $result = $apiInstance->geocodeAddress($storefront_oid, $geocode_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->geocodeAddress: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
geocode_request	\ultracart\v2\models\GeocodeRequest	geocode request

Return type

\ultracart\v2\models\GeocodeResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCountries

\ultracart\v2\models\CountriesResponse getCountries($storefront_oid)

Get countries

Obtain a list of all the countries

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getCountries($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getCountries: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\CountriesResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEditorToken

\ultracart\v2\models\EmailEditorTokenResponse getEditorToken($storefront_oid)

Gets editor token

Fetches a temporary authentication token for the editor

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEditorToken($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEditorToken: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailEditorTokenResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailBaseTemplates

\ultracart\v2\models\EmailBaseTemplateListResponse getEmailBaseTemplates($storefront_oid)

Get email communication base templates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailBaseTemplates($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailBaseTemplates: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailBaseTemplateListResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCampaign

\ultracart\v2\models\EmailCampaignResponse getEmailCampaign($storefront_oid, $email_campaign_uuid)

Get email campaign

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_uuid = "email_campaign_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCampaign($storefront_oid, $email_campaign_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCampaign: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_campaign_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCampaignFolder

\ultracart\v2\models\EmailCampaignFolderResponse getEmailCampaignFolder($storefront_oid, $email_campaign_folder_uuid)

Get email campaign folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_folder_uuid = "email_campaign_folder_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCampaignFolder($storefront_oid, $email_campaign_folder_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCampaignFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_campaign_folder_uuid	string

Return type

\ultracart\v2\models\EmailCampaignFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCampaignFolders

\ultracart\v2\models\EmailCampaignFoldersResponse getEmailCampaignFolders($storefront_oid)

Get email campaign folders

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailCampaignFolders($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCampaignFolders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailCampaignFoldersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCampaignScreenshots

\ultracart\v2\models\ScreenshotsResponse getEmailCampaignScreenshots($storefront_oid, $email_campaign_uuid)

Get email campaign screenshots

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_uuid = "email_campaign_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCampaignScreenshots($storefront_oid, $email_campaign_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCampaignScreenshots: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_campaign_uuid	string

Return type

\ultracart\v2\models\ScreenshotsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCampaigns

\ultracart\v2\models\EmailCampaignsResponse getEmailCampaigns($storefront_oid)

Get email campaigns

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailCampaigns($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailCampaignsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCampaignsWithStats

\ultracart\v2\models\EmailCampaignsResponse getEmailCampaignsWithStats($storefront_oid, $stat_days)

Get email campaigns with stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$stat_days = "stat_days_example"; // string | 

try {
    $result = $apiInstance->getEmailCampaignsWithStats($storefront_oid, $stat_days);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCampaignsWithStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
stat_days	string

Return type

\ultracart\v2\models\EmailCampaignsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseq

\ultracart\v2\models\EmailCommseqResponse getEmailCommseq($storefront_oid, $commseq_uuid)

Get email commseq

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCommseq($storefront_oid, $commseq_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseq: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_uuid	string

Return type

\ultracart\v2\models\EmailCommseqResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqEmailStats

\ultracart\v2\models\EmailStatSummaryResponse getEmailCommseqEmailStats($storefront_oid, $commseq_uuid, $stats_request)

Get email communication sequence emails stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$stats_request = new \ultracart\v2\models\EmailStatSummaryRequest(); // \ultracart\v2\models\EmailStatSummaryRequest | StatsRequest

try {
    $result = $apiInstance->getEmailCommseqEmailStats($storefront_oid, $commseq_uuid, $stats_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqEmailStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_uuid	string
stats_request	\ultracart\v2\models\EmailStatSummaryRequest	StatsRequest

Return type

\ultracart\v2\models\EmailStatSummaryResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqPostcardStats

\ultracart\v2\models\EmailStatPostcardSummaryResponse getEmailCommseqPostcardStats($storefront_oid, $commseq_uuid, $stats_request)

Get email communication sequence postcard stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$stats_request = new \ultracart\v2\models\EmailStatPostcardSummaryRequest(); // \ultracart\v2\models\EmailStatPostcardSummaryRequest | StatsRequest

try {
    $result = $apiInstance->getEmailCommseqPostcardStats($storefront_oid, $commseq_uuid, $stats_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqPostcardStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_uuid	string
stats_request	\ultracart\v2\models\EmailStatPostcardSummaryRequest	StatsRequest

Return type

\ultracart\v2\models\EmailStatPostcardSummaryResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqPostcardTracking

\ultracart\v2\models\EmailPostcardTrackingResponse getEmailCommseqPostcardTracking($storefront_oid, $commseq_postcard_uuid)

Get email communication postcard tracking

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_postcard_uuid = "commseq_postcard_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCommseqPostcardTracking($storefront_oid, $commseq_postcard_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqPostcardTracking: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_postcard_uuid	string

Return type

\ultracart\v2\models\EmailPostcardTrackingResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqRateLimiters

\ultracart\v2\models\EmailRateLimitersResponse getEmailCommseqRateLimiters($storefront_oid, $commseq_uuid)

Get email commseq rate limiters

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCommseqRateLimiters($storefront_oid, $commseq_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqRateLimiters: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_uuid	string

Return type

\ultracart\v2\models\EmailRateLimitersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqSmsStats

\ultracart\v2\models\EmailStatSmsSummaryResponse getEmailCommseqSmsStats($storefront_oid, $commseq_uuid, $stats_request)

Get email communication sequence sms stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$stats_request = new \ultracart\v2\models\EmailStatSmsSummaryRequest(); // \ultracart\v2\models\EmailStatSmsSummaryRequest | StatsRequest

try {
    $result = $apiInstance->getEmailCommseqSmsStats($storefront_oid, $commseq_uuid, $stats_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqSmsStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_uuid	string
stats_request	\ultracart\v2\models\EmailStatSmsSummaryRequest	StatsRequest

Return type

\ultracart\v2\models\EmailStatSmsSummaryResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqStatOverall

\ultracart\v2\models\EmailCommseqStatResponse getEmailCommseqStatOverall($storefront_oid, $commseq_uuid)

Get communication sequence stats overall

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCommseqStatOverall($storefront_oid, $commseq_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqStatOverall: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_uuid	string

Return type

\ultracart\v2\models\EmailCommseqStatResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqStepStats

\ultracart\v2\models\EmailStepStatResponse getEmailCommseqStepStats($storefront_oid, $commseq_uuid, $stats_request)

Get email communication sequence step stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$stats_request = new \ultracart\v2\models\EmailStepStatRequest(); // \ultracart\v2\models\EmailStepStatRequest | StatsRequest

try {
    $result = $apiInstance->getEmailCommseqStepStats($storefront_oid, $commseq_uuid, $stats_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqStepStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_uuid	string
stats_request	\ultracart\v2\models\EmailStepStatRequest	StatsRequest

Return type

\ultracart\v2\models\EmailStepStatResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqStepWaiting

\ultracart\v2\models\EmailStepWaitingResponse getEmailCommseqStepWaiting($storefront_oid, $commseq_uuid, $waiting_request)

Get email communication sequence customers waiting at each requested step

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$waiting_request = new \ultracart\v2\models\EmailStepWaitingRequest(); // \ultracart\v2\models\EmailStepWaitingRequest | WaitingRequest

try {
    $result = $apiInstance->getEmailCommseqStepWaiting($storefront_oid, $commseq_uuid, $waiting_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqStepWaiting: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_uuid	string
waiting_request	\ultracart\v2\models\EmailStepWaitingRequest	WaitingRequest

Return type

\ultracart\v2\models\EmailStepWaitingResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqWebhookEditorValues

\ultracart\v2\models\EmailWebhookEditorValuesResponse getEmailCommseqWebhookEditorValues($storefront_oid, $commseq_uuid)

Get email webhook editor values

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCommseqWebhookEditorValues($storefront_oid, $commseq_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqWebhookEditorValues: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_uuid	string

Return type

\ultracart\v2\models\EmailWebhookEditorValuesResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCommseqs

\ultracart\v2\models\EmailCommseqsResponse getEmailCommseqs($storefront_oid)

Get email commseqs

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailCommseqs($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCommseqs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailCommseqsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCustomerEditorUrl

\ultracart\v2\models\EmailCustomerEditorUrlResponse getEmailCustomerEditorUrl($storefront_oid, $email_customer_uuid)

Get customers editor URL

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_customer_uuid = "email_customer_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailCustomerEditorUrl($storefront_oid, $email_customer_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCustomerEditorUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_customer_uuid	string

Return type

\ultracart\v2\models\EmailCustomerEditorUrlResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailCustomers

\ultracart\v2\models\EmailCustomersResponse getEmailCustomers($storefront_oid, $page_number, $page_size, $search_email_prefix)

Get email customers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$page_number = 56; // int | 
$page_size = 56; // int | 
$search_email_prefix = "search_email_prefix_example"; // string | 

try {
    $result = $apiInstance->getEmailCustomers($storefront_oid, $page_number, $page_size, $search_email_prefix);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailCustomers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
page_number	int	[optional]
page_size	int	[optional]
search_email_prefix	string	[optional]

Return type

\ultracart\v2\models\EmailCustomersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailDashboardActivity

\ultracart\v2\models\EmailDashboardActivityResponse getEmailDashboardActivity($storefront_oid, $last_records)

Get email dashboard activity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$last_records = 56; // int | 

try {
    $result = $apiInstance->getEmailDashboardActivity($storefront_oid, $last_records);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailDashboardActivity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
last_records	int		[optional]

Return type

\ultracart\v2\models\EmailDashboardActivityResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailDashboardStats

\ultracart\v2\models\EmailDashboardStatsResponse getEmailDashboardStats($storefront_oid, $days)

Get dashboard stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$days = 56; // int | 

try {
    $result = $apiInstance->getEmailDashboardStats($storefront_oid, $days);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailDashboardStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
days	int		[optional]

Return type

\ultracart\v2\models\EmailDashboardStatsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailDispatchLogs

\ultracart\v2\models\EmailCommseqStepLogsResponse getEmailDispatchLogs($storefront_oid, $commseq_uuid, $commseq_step_uuid)

Get email dispatch logs

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$commseq_step_uuid = "commseq_step_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailDispatchLogs($storefront_oid, $commseq_uuid, $commseq_step_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailDispatchLogs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_uuid	string
commseq_step_uuid	string

Return type

\ultracart\v2\models\EmailCommseqStepLogsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailEmail

\ultracart\v2\models\EmailCommseqEmailResponse getEmailEmail($storefront_oid, $commseq_email_uuid)

Get email email

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_email_uuid = "commseq_email_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailEmail($storefront_oid, $commseq_email_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_email_uuid	string

Return type

\ultracart\v2\models\EmailCommseqEmailResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailEmailClicks

\ultracart\v2\models\EmailClicksResponse getEmailEmailClicks($storefront_oid, $commseq_uuid, $commseq_step_uuid, $commseq_email_uuid, $days)

Get email email clicks

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$commseq_step_uuid = "commseq_step_uuid_example"; // string | 
$commseq_email_uuid = "commseq_email_uuid_example"; // string | 
$days = 56; // int | 

try {
    $result = $apiInstance->getEmailEmailClicks($storefront_oid, $commseq_uuid, $commseq_step_uuid, $commseq_email_uuid, $days);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailEmailClicks: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
commseq_uuid	string
commseq_step_uuid	string
commseq_email_uuid	string
days	int	[optional]

Return type

\ultracart\v2\models\EmailClicksResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailEmailCustomerEditorUrl

\ultracart\v2\models\EmailCustomerEditorUrlResponse getEmailEmailCustomerEditorUrl($storefront_oid, $commseq_email_uuid, $order_id)

Get email order customer editor url

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_email_uuid = "commseq_email_uuid_example"; // string | 
$order_id = "order_id_example"; // string | 

try {
    $result = $apiInstance->getEmailEmailCustomerEditorUrl($storefront_oid, $commseq_email_uuid, $order_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailEmailCustomerEditorUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_email_uuid	string
order_id	string

Return type

\ultracart\v2\models\EmailCustomerEditorUrlResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailEmailOrders

\ultracart\v2\models\EmailOrdersResponse getEmailEmailOrders($storefront_oid, $commseq_uuid, $commseq_step_uuid, $commseq_email_uuid, $days)

Get email email orders

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$commseq_step_uuid = "commseq_step_uuid_example"; // string | 
$commseq_email_uuid = "commseq_email_uuid_example"; // string | 
$days = 56; // int | 

try {
    $result = $apiInstance->getEmailEmailOrders($storefront_oid, $commseq_uuid, $commseq_step_uuid, $commseq_email_uuid, $days);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailEmailOrders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
commseq_uuid	string
commseq_step_uuid	string
commseq_email_uuid	string
days	int	[optional]

Return type

\ultracart\v2\models\EmailOrdersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailEmails

\ultracart\v2\models\EmailCommseqEmailsResponse getEmailEmails($storefront_oid)

Get email emails

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailEmails($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailEmails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailCommseqEmailsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailEmailsMultiple

\ultracart\v2\models\EmailCommseqEmailsResponse getEmailEmailsMultiple($storefront_oid, $email_commseq_emails_request)

Get email emails multiple

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_commseq_emails_request = new \ultracart\v2\models\EmailCommseqEmailsRequest(); // \ultracart\v2\models\EmailCommseqEmailsRequest | Request of email uuids

try {
    $result = $apiInstance->getEmailEmailsMultiple($storefront_oid, $email_commseq_emails_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailEmailsMultiple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_commseq_emails_request	\ultracart\v2\models\EmailCommseqEmailsRequest	Request of email uuids

Return type

\ultracart\v2\models\EmailCommseqEmailsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailFlow

\ultracart\v2\models\EmailFlowResponse getEmailFlow($storefront_oid, $email_flow_uuid)

Get email flow

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_uuid = "email_flow_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailFlow($storefront_oid, $email_flow_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailFlow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_flow_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailFlowFolder

\ultracart\v2\models\EmailFlowFolderResponse getEmailFlowFolder($storefront_oid, $email_flow_folder_uuid)

Get email flow folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_folder_uuid = "email_flow_folder_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailFlowFolder($storefront_oid, $email_flow_folder_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailFlowFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_flow_folder_uuid	string

Return type

\ultracart\v2\models\EmailFlowFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailFlowFolders

\ultracart\v2\models\EmailFlowFoldersResponse getEmailFlowFolders($storefront_oid)

Get email flow folders

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailFlowFolders($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailFlowFolders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailFlowFoldersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailFlowScreenshots

\ultracart\v2\models\ScreenshotsResponse getEmailFlowScreenshots($storefront_oid, $email_flow_uuid)

Get email flow screenshots

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_uuid = "email_flow_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailFlowScreenshots($storefront_oid, $email_flow_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailFlowScreenshots: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_flow_uuid	string

Return type

\ultracart\v2\models\ScreenshotsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailFlows

\ultracart\v2\models\EmailFlowsResponse getEmailFlows($storefront_oid)

Get email flows

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailFlows($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailFlows: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailFlowsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailGlobalSettings

\ultracart\v2\models\EmailGlobalSettingsResponse getEmailGlobalSettings()

Get email globalsettings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getEmailGlobalSettings();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailGlobalSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\EmailGlobalSettingsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailList

\ultracart\v2\models\EmailListResponse getEmailList($storefront_oid, $email_list_uuid)

Get email list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_uuid = "email_list_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailList($storefront_oid, $email_list_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_list_uuid	string

Return type

\ultracart\v2\models\EmailListResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailListCustomerEditorUrl

\ultracart\v2\models\EmailCustomerEditorUrlResponse getEmailListCustomerEditorUrl($storefront_oid, $email_list_uuid, $email_customer_uuid)

Get email list customer editor url

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_uuid = "email_list_uuid_example"; // string | 
$email_customer_uuid = "email_customer_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailListCustomerEditorUrl($storefront_oid, $email_list_uuid, $email_customer_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailListCustomerEditorUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_list_uuid	string
email_customer_uuid	string

Return type

\ultracart\v2\models\EmailCustomerEditorUrlResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailListCustomers

\ultracart\v2\models\EmailListCustomersResponse getEmailListCustomers($storefront_oid, $email_list_uuid, $page_number, $page_size)

Get email list customers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_uuid = "email_list_uuid_example"; // string | 
$page_number = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $apiInstance->getEmailListCustomers($storefront_oid, $email_list_uuid, $page_number, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailListCustomers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
email_list_uuid	string
page_number	int	[optional]
page_size	int	[optional]

Return type

\ultracart\v2\models\EmailListCustomersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailListSegmentFolder

\ultracart\v2\models\EmailListSegmentFolderResponse getEmailListSegmentFolder($storefront_oid, $email_list_segment_folder_uuid)

Get email campaign folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_segment_folder_uuid = "email_list_segment_folder_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailListSegmentFolder($storefront_oid, $email_list_segment_folder_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailListSegmentFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_list_segment_folder_uuid	string

Return type

\ultracart\v2\models\EmailListSegmentFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailListSegmentFolders

\ultracart\v2\models\EmailListSegmentFoldersResponse getEmailListSegmentFolders($storefront_oid)

Get email campaign folders

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailListSegmentFolders($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailListSegmentFolders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailListSegmentFoldersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailLists

\ultracart\v2\models\EmailListsResponse getEmailLists($storefront_oid)

Get email lists

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailLists($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailLists: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailListsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailPerformance

\ultracart\v2\models\EmailPerformanceResponse getEmailPerformance($storefront_oid)

Get email performance

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailPerformance($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailPerformance: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailPerformanceResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailPlan

\ultracart\v2\models\EmailPlanResponse getEmailPlan($storefront_oid)

Get email plan

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailPlan($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailPlan: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailPlanResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailPostcard

\ultracart\v2\models\EmailCommseqPostcardResponse getEmailPostcard($storefront_oid, $commseq_postcard_uuid)

Get email postcard

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_postcard_uuid = "commseq_postcard_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailPostcard($storefront_oid, $commseq_postcard_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailPostcard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_postcard_uuid	string

Return type

\ultracart\v2\models\EmailCommseqPostcardResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailPostcards

\ultracart\v2\models\EmailCommseqPostcardsResponse getEmailPostcards($storefront_oid)

Get email postcards

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailPostcards($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailPostcards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailCommseqPostcardsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailPostcardsMultiple

\ultracart\v2\models\EmailCommseqPostcardsResponse getEmailPostcardsMultiple($storefront_oid, $email_commseq_postcards_request)

Get email postcards multiple

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_commseq_postcards_request = new \ultracart\v2\models\EmailCommseqPostcardsRequest(); // \ultracart\v2\models\EmailCommseqPostcardsRequest | Request of postcard uuids

try {
    $result = $apiInstance->getEmailPostcardsMultiple($storefront_oid, $email_commseq_postcards_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailPostcardsMultiple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_commseq_postcards_request	\ultracart\v2\models\EmailCommseqPostcardsRequest	Request of postcard uuids

Return type

\ultracart\v2\models\EmailCommseqPostcardsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSegment

\ultracart\v2\models\EmailSegmentResponse getEmailSegment($storefront_oid, $email_segment_uuid)

Get email segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailSegment($storefront_oid, $email_segment_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_segment_uuid	string

Return type

\ultracart\v2\models\EmailSegmentResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSegmentCustomerEditorUrl

\ultracart\v2\models\EmailCustomerEditorUrlResponse getEmailSegmentCustomerEditorUrl($storefront_oid, $email_segment_uuid, $email_customer_uuid)

Get email segment customers editor URL

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 
$email_customer_uuid = "email_customer_uuid_example"; // string | 

try {
    $result = $apiInstance->getEmailSegmentCustomerEditorUrl($storefront_oid, $email_segment_uuid, $email_customer_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSegmentCustomerEditorUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_segment_uuid	string
email_customer_uuid	string

Return type

\ultracart\v2\models\EmailCustomerEditorUrlResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSegmentCustomers

\ultracart\v2\models\EmailSegmentCustomersResponse getEmailSegmentCustomers($storefront_oid, $email_segment_uuid, $page_number, $page_size)

Get email segment customers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 
$page_number = 56; // int | 
$page_size = 56; // int | 

try {
    $result = $apiInstance->getEmailSegmentCustomers($storefront_oid, $email_segment_uuid, $page_number, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSegmentCustomers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
email_segment_uuid	string
page_number	int	[optional]
page_size	int	[optional]

Return type

\ultracart\v2\models\EmailSegmentCustomersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSegments

\ultracart\v2\models\EmailSegmentsResponse getEmailSegments($storefront_oid)

Get email segments

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailSegments($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSegments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailSegmentsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSendingDomain

\ultracart\v2\models\EmailSendingDomainResponse getEmailSendingDomain($domain)

Get email sending domain

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$domain = "domain_example"; // string | 

try {
    $result = $apiInstance->getEmailSendingDomain($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSendingDomain: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
domain	string

Return type

\ultracart\v2\models\EmailSendingDomainResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSendingDomainStatus

\ultracart\v2\models\EmailSendingDomainResponse getEmailSendingDomainStatus($domain)

Get email sending domain status

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$domain = "domain_example"; // string | 

try {
    $result = $apiInstance->getEmailSendingDomainStatus($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSendingDomainStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
domain	string

Return type

\ultracart\v2\models\EmailSendingDomainResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSendingDomains

\ultracart\v2\models\EmailSendingDomainsResponse getEmailSendingDomains()

Get email sending domains

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getEmailSendingDomains();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSendingDomains: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\EmailSendingDomainsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSettings

\ultracart\v2\models\EmailSettingsResponse getEmailSettings($storefront_oid)

Get email settings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailSettings($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailSettingsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailSmsOrders

\ultracart\v2\models\EmailSmsOrdersResponse getEmailSmsOrders($storefront_oid, $commseq_uuid, $commseq_step_uuid, $days)

Get email sms orders

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$commseq_step_uuid = "commseq_step_uuid_example"; // string | 
$days = 56; // int | 

try {
    $result = $apiInstance->getEmailSmsOrders($storefront_oid, $commseq_uuid, $commseq_step_uuid, $days);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailSmsOrders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
commseq_uuid	string
commseq_step_uuid	string
days	int	[optional]

Return type

\ultracart\v2\models\EmailSmsOrdersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailTemplate

\ultracart\v2\models\EmailTemplate getEmailTemplate($storefront_oid, $email_template_oid)

Get email template

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_template_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailTemplate($storefront_oid, $email_template_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_template_oid	int

Return type

\ultracart\v2\models\EmailTemplate

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailTemplates

\ultracart\v2\models\EmailTemplatesResponse getEmailTemplates($storefront_oid, $trigger_type)

Get email templates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$trigger_type = "trigger_type_example"; // string | 

try {
    $result = $apiInstance->getEmailTemplates($storefront_oid, $trigger_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
trigger_type	string		[optional]

Return type

\ultracart\v2\models\EmailTemplatesResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmailThirdPartyProviders

\ultracart\v2\models\EmailThirdPartyProvidersResponse getEmailThirdPartyProviders($storefront_oid)

Get a list of third party email providers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getEmailThirdPartyProviders($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getEmailThirdPartyProviders: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\EmailThirdPartyProvidersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getExperiments

\ultracart\v2\models\ExperimentsResponse getExperiments($storefront_oid)

Get experiments

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getExperiments($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getExperiments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\ExperimentsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFsDirectory

\ultracart\v2\models\FileManagerPageResponse getFsDirectory($id, $path, $storefront_fs_directory_oid, $storefront_theme_oid)

Get file manager directory

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$id = 56; // int | 
$path = "path_example"; // string | 
$storefront_fs_directory_oid = 56; // int | 
$storefront_theme_oid = 56; // int | 

try {
    $result = $apiInstance->getFsDirectory($id, $path, $storefront_fs_directory_oid, $storefront_theme_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getFsDirectory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
id	int
path	string	[optional]
storefront_fs_directory_oid	int	[optional]
storefront_theme_oid	int	[optional]

Return type

\ultracart\v2\models\FileManagerPageResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getHeatmap

\ultracart\v2\models\ScreenRecordingHeatmapResponse getHeatmap($storefront_oid, $query)

Get screen recording heatmap

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$query = new \ultracart\v2\models\ScreenRecordingHeatmapRequest(); // \ultracart\v2\models\ScreenRecordingHeatmapRequest | Query

try {
    $result = $apiInstance->getHeatmap($storefront_oid, $query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getHeatmap: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
query	\ultracart\v2\models\ScreenRecordingHeatmapRequest	Query

Return type

\ultracart\v2\models\ScreenRecordingHeatmapResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

getHeatmapIndex

\ultracart\v2\models\ScreenRecordingHeatmapIndexResponse getHeatmapIndex($storefront_oid, $query, $_limit, $_offset, $_sort)

Get screen recording heatmap index

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$query = new \ultracart\v2\models\ScreenRecordingHeatmapIndexRequest(); // \ultracart\v2\models\ScreenRecordingHeatmapIndexRequest | Query
$_limit = 100; // int | The maximum number of records to return on this one API call. (Default 100, Max 500)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_sort = "_sort_example"; // string | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

try {
    $result = $apiInstance->getHeatmapIndex($storefront_oid, $query, $_limit, $_offset, $_sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getHeatmapIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
query	\ultracart\v2\models\ScreenRecordingHeatmapIndexRequest	Query
_limit	int	The maximum number of records to return on this one API call. (Default 100, Max 500)	[optional] [default to 100]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_sort	string	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]

Return type

\ultracart\v2\models\ScreenRecordingHeatmapIndexResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

getHistogramPropertyNames

\ultracart\v2\models\EmailHistogramPropertyNamesResponse getHistogramPropertyNames($storefront_oid, $property_type)

Get histogram property names

Obtain a list of property names for a given property type

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$property_type = "property_type_example"; // string | 

try {
    $result = $apiInstance->getHistogramPropertyNames($storefront_oid, $property_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getHistogramPropertyNames: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
property_type	string		[optional]

Return type

\ultracart\v2\models\EmailHistogramPropertyNamesResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getHistogramPropertyValues

\ultracart\v2\models\EmailHistogramPropertyValuesResponse getHistogramPropertyValues($storefront_oid, $property_name, $property_type, $limit)

Get histogram property values

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$property_name = "property_name_example"; // string | 
$property_type = "property_type_example"; // string | 
$limit = 56; // int | 

try {
    $result = $apiInstance->getHistogramPropertyValues($storefront_oid, $property_name, $property_type, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getHistogramPropertyValues: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
property_name	string	[optional]
property_type	string	[optional]
limit	int	[optional]

Return type

\ultracart\v2\models\EmailHistogramPropertyValuesResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLibraryFilterValues

\ultracart\v2\models\LibraryFilterValuesResponse getLibraryFilterValues()

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getLibraryFilterValues();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getLibraryFilterValues: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\LibraryFilterValuesResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLibraryItem

\ultracart\v2\models\LibraryItemResponse getLibraryItem($library_item_oid)

Get library item.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$library_item_oid = 56; // int | 

try {
    $result = $apiInstance->getLibraryItem($library_item_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getLibraryItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
library_item_oid	int

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLibraryItemPublishedVersions

\ultracart\v2\models\LibraryItemsResponse getLibraryItemPublishedVersions($library_item_oid)

Get all published versions for a library item.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$library_item_oid = 56; // int | 

try {
    $result = $apiInstance->getLibraryItemPublishedVersions($library_item_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getLibraryItemPublishedVersions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
library_item_oid	int

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getScreenRecording

\ultracart\v2\models\ScreenRecordingResponse getScreenRecording($storefront_oid, $screen_recording_uuid)

Get screen recording

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_uuid = "screen_recording_uuid_example"; // string | 

try {
    $result = $apiInstance->getScreenRecording($storefront_oid, $screen_recording_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getScreenRecording: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
screen_recording_uuid	string

Return type

\ultracart\v2\models\ScreenRecordingResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

getScreenRecordingPageViewData

\ultracart\v2\models\ScreenRecordingPageViewDataResponse getScreenRecordingPageViewData($storefront_oid, $screen_recording_uuid, $screen_recording_page_view_uuid)

Get screen recording page view data

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_uuid = "screen_recording_uuid_example"; // string | 
$screen_recording_page_view_uuid = "screen_recording_page_view_uuid_example"; // string | 

try {
    $result = $apiInstance->getScreenRecordingPageViewData($storefront_oid, $screen_recording_uuid, $screen_recording_page_view_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getScreenRecordingPageViewData: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
screen_recording_uuid	string
screen_recording_page_view_uuid	string

Return type

\ultracart\v2\models\ScreenRecordingPageViewDataResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

getScreenRecordingSegment

\ultracart\v2\models\ScreenRecordingSegmentResponse getScreenRecordingSegment($storefront_oid, $screen_recording_segment_oid)

Get screen recording segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_segment_oid = 56; // int | 

try {
    $result = $apiInstance->getScreenRecordingSegment($storefront_oid, $screen_recording_segment_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getScreenRecordingSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
screen_recording_segment_oid	int

Return type

\ultracart\v2\models\ScreenRecordingSegmentResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getScreenRecordingSegments

\ultracart\v2\models\ScreenRecordingSegmentsResponse getScreenRecordingSegments($storefront_oid)

Get screen recording segments

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getScreenRecordingSegments($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getScreenRecordingSegments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\ScreenRecordingSegmentsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getScreenRecordingSettings

\ultracart\v2\models\ScreenRecordingSettingsResponse getScreenRecordingSettings($storefront_oid)

Get screen recording settings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getScreenRecordingSettings($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getScreenRecordingSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\ScreenRecordingSettingsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getScreenRecordingTags

\ultracart\v2\models\ScreenRecordingTagsResponse getScreenRecordingTags($storefront_oid)

Get tags used by screen recording

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getScreenRecordingTags($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getScreenRecordingTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\ScreenRecordingTagsResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

getScreenRecordingsByQuery

\ultracart\v2\models\ScreenRecordingQueryResponse getScreenRecordingsByQuery($storefront_oid, $query, $_limit, $_offset, $_sort)

Query screen recordings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$query = new \ultracart\v2\models\ScreenRecordingQueryRequest(); // \ultracart\v2\models\ScreenRecordingQueryRequest | Query
$_limit = 100; // int | The maximum number of records to return on this one API call. (Default 100, Max 500)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_sort = "_sort_example"; // string | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

try {
    $result = $apiInstance->getScreenRecordingsByQuery($storefront_oid, $query, $_limit, $_offset, $_sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getScreenRecordingsByQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
query	\ultracart\v2\models\ScreenRecordingQueryRequest	Query
_limit	int	The maximum number of records to return on this one API call. (Default 100, Max 500)	[optional] [default to 100]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_sort	string	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]

Return type

\ultracart\v2\models\ScreenRecordingQueryResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

getScreenRecordingsBySegment

\ultracart\v2\models\ScreenRecordingQueryResponse getScreenRecordingsBySegment($storefront_oid, $screen_recording_segment_oid, $_limit, $_offset, $_sort)

Get screen recordings by segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_segment_oid = 56; // int | 
$_limit = 100; // int | The maximum number of records to return on this one API call. (Default 100, Max 500)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_sort = "_sort_example"; // string | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

try {
    $result = $apiInstance->getScreenRecordingsBySegment($storefront_oid, $screen_recording_segment_oid, $_limit, $_offset, $_sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getScreenRecordingsBySegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
screen_recording_segment_oid	int
_limit	int	The maximum number of records to return on this one API call. (Default 100, Max 500)	[optional] [default to 100]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_sort	string	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]

Return type

\ultracart\v2\models\ScreenRecordingQueryResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

getStoreFrontPricingTiers

\ultracart\v2\models\PricingTiersResponse getStoreFrontPricingTiers($_expand)

Retrieve pricing tiers

Retrieves the pricing tiers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$_expand = "_expand_example"; // string | The object expansion to perform on the result.  See documentation for examples

try {
    $result = $apiInstance->getStoreFrontPricingTiers($_expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getStoreFrontPricingTiers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
_expand	string	The object expansion to perform on the result. See documentation for examples	[optional]

Return type

\ultracart\v2\models\PricingTiersResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

getStoreFronts

\ultracart\v2\models\StoreFrontsResponse getStoreFronts()

Get storefronts (internal use only for security reasons)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getStoreFronts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getStoreFronts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\StoreFrontsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getThumbnailParameters

\ultracart\v2\models\ThumbnailParametersResponse getThumbnailParameters($thumbnail_parameters)

Get thumbnail parameters

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$thumbnail_parameters = new \ultracart\v2\models\ThumbnailParametersRequest(); // \ultracart\v2\models\ThumbnailParametersRequest | Thumbnail Parameters

try {
    $result = $apiInstance->getThumbnailParameters($thumbnail_parameters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getThumbnailParameters: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
thumbnail_parameters	\ultracart\v2\models\ThumbnailParametersRequest	Thumbnail Parameters

Return type

\ultracart\v2\models\ThumbnailParametersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransactionEmail

\ultracart\v2\models\TransactionEmailResponse getTransactionEmail($storefront_oid, $email_id)

Gets a transaction email object

Fetch a transactional email

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_id = "email_id_example"; // string | 

try {
    $result = $apiInstance->getTransactionEmail($storefront_oid, $email_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getTransactionEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_id	string

Return type

\ultracart\v2\models\TransactionEmailResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransactionEmailList

\ultracart\v2\models\TransactionEmailListResponse getTransactionEmailList($storefront_oid)

Gets a list of transaction email names

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->getTransactionEmailList($storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getTransactionEmailList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int

Return type

\ultracart\v2\models\TransactionEmailListResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransactionEmailScreenshots

\ultracart\v2\models\ScreenshotsResponse getTransactionEmailScreenshots($storefront_oid, $email_id)

Get transactional email screenshots

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_id = "email_id_example"; // string | 

try {
    $result = $apiInstance->getTransactionEmailScreenshots($storefront_oid, $email_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getTransactionEmailScreenshots: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_id	string

Return type

\ultracart\v2\models\ScreenshotsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTwilioAccount

\ultracart\v2\models\TwilioResponse getTwilioAccount($esp_twilio_uuid)

Get Twilio account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$esp_twilio_uuid = "esp_twilio_uuid_example"; // string | 

try {
    $result = $apiInstance->getTwilioAccount($esp_twilio_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getTwilioAccount: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
esp_twilio_uuid	string

Return type

\ultracart\v2\models\TwilioResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTwilioAccounts

\ultracart\v2\models\TwiliosResponse getTwilioAccounts()

Get all Twilio accounts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTwilioAccounts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getTwilioAccounts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TwiliosResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUploadFsFileUrl

\ultracart\v2\models\FileManagerUploadUrlResponse getUploadFsFileUrl($id, $extension)

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$id = 56; // int | 
$extension = "extension_example"; // string | 

try {
    $result = $apiInstance->getUploadFsFileUrl($id, $extension);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->getUploadFsFileUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
extension	string

Return type

\ultracart\v2\models\FileManagerUploadUrlResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

globalUnsubscribe

\ultracart\v2\models\EmailGlobalUnsubscribeResponse globalUnsubscribe($storefront_oid, $unsubscribe)

Globally unsubscribe a customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$unsubscribe = new \ultracart\v2\models\EmailGlobalUnsubscribeRequest(); // \ultracart\v2\models\EmailGlobalUnsubscribeRequest | Unsubscribe

try {
    $result = $apiInstance->globalUnsubscribe($storefront_oid, $unsubscribe);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->globalUnsubscribe: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
unsubscribe	\ultracart\v2\models\EmailGlobalUnsubscribeRequest	Unsubscribe

Return type

\ultracart\v2\models\EmailGlobalUnsubscribeResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

importEmailThirdPartyProviderList

importEmailThirdPartyProviderList($storefront_oid, $import_request)

Import a third party provider list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$import_request = new \ultracart\v2\models\EmailThirdPartyListImportRequest(); // \ultracart\v2\models\EmailThirdPartyListImportRequest | lists to import

try {
    $apiInstance->importEmailThirdPartyProviderList($storefront_oid, $import_request);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->importEmailThirdPartyProviderList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
import_request	\ultracart\v2\models\EmailThirdPartyListImportRequest	lists to import

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailCampaign

\ultracart\v2\models\EmailCampaignResponse insertEmailCampaign($storefront_oid, $email_campaign)

Insert email campaign

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign = new \ultracart\v2\models\EmailCampaign(); // \ultracart\v2\models\EmailCampaign | Email campaign

try {
    $result = $apiInstance->insertEmailCampaign($storefront_oid, $email_campaign);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailCampaign: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_campaign	\ultracart\v2\models\EmailCampaign	Email campaign

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailCampaignFolder

\ultracart\v2\models\EmailCampaignFolderResponse insertEmailCampaignFolder($storefront_oid, $email_campaign_folder)

Insert email campaign folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_folder = new \ultracart\v2\models\EmailCampaignFolder(); // \ultracart\v2\models\EmailCampaignFolder | Email campaign folder

try {
    $result = $apiInstance->insertEmailCampaignFolder($storefront_oid, $email_campaign_folder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailCampaignFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_campaign_folder	\ultracart\v2\models\EmailCampaignFolder	Email campaign folder

Return type

\ultracart\v2\models\EmailCampaignFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailCommseq

\ultracart\v2\models\EmailCommseqResponse insertEmailCommseq($storefront_oid, $email_commseq)

Insert email commseq

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_commseq = new \ultracart\v2\models\EmailCommseq(); // \ultracart\v2\models\EmailCommseq | Email commseq

try {
    $result = $apiInstance->insertEmailCommseq($storefront_oid, $email_commseq);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailCommseq: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_commseq	\ultracart\v2\models\EmailCommseq	Email commseq

Return type

\ultracart\v2\models\EmailCommseqResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailEmail

\ultracart\v2\models\EmailCommseqEmailResponse insertEmailEmail($storefront_oid, $email_commseq_email)

Insert email email

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_commseq_email = new \ultracart\v2\models\EmailCommseqEmail(); // \ultracart\v2\models\EmailCommseqEmail | Email email

try {
    $result = $apiInstance->insertEmailEmail($storefront_oid, $email_commseq_email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_commseq_email	\ultracart\v2\models\EmailCommseqEmail	Email email

Return type

\ultracart\v2\models\EmailCommseqEmailResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailFlow

\ultracart\v2\models\EmailFlowResponse insertEmailFlow($storefront_oid, $email_flow)

Insert email flow

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow = new \ultracart\v2\models\EmailFlow(); // \ultracart\v2\models\EmailFlow | Email flow

try {
    $result = $apiInstance->insertEmailFlow($storefront_oid, $email_flow);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailFlow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_flow	\ultracart\v2\models\EmailFlow	Email flow

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailFlowFolder

\ultracart\v2\models\EmailFlowFolderResponse insertEmailFlowFolder($storefront_oid, $email_flow_folder)

Insert email flow folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_folder = new \ultracart\v2\models\EmailFlowFolder(); // \ultracart\v2\models\EmailFlowFolder | Email flow folder

try {
    $result = $apiInstance->insertEmailFlowFolder($storefront_oid, $email_flow_folder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailFlowFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_flow_folder	\ultracart\v2\models\EmailFlowFolder	Email flow folder

Return type

\ultracart\v2\models\EmailFlowFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailList

\ultracart\v2\models\EmailListResponse insertEmailList($storefront_oid, $email_list)

Insert email list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list = new \ultracart\v2\models\EmailList(); // \ultracart\v2\models\EmailList | Email list

try {
    $result = $apiInstance->insertEmailList($storefront_oid, $email_list);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_list	\ultracart\v2\models\EmailList	Email list

Return type

\ultracart\v2\models\EmailListResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailListSegmentFolder

\ultracart\v2\models\EmailListSegmentFolderResponse insertEmailListSegmentFolder($storefront_oid, $email_list_segment_folder)

Insert email campaign folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_segment_folder = new \ultracart\v2\models\EmailListSegmentFolder(); // \ultracart\v2\models\EmailListSegmentFolder | Email campaign folder

try {
    $result = $apiInstance->insertEmailListSegmentFolder($storefront_oid, $email_list_segment_folder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailListSegmentFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_list_segment_folder	\ultracart\v2\models\EmailListSegmentFolder	Email campaign folder

Return type

\ultracart\v2\models\EmailListSegmentFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailPostcard

\ultracart\v2\models\EmailCommseqPostcardResponse insertEmailPostcard($storefront_oid, $email_commseq_postcard)

Insert email postcard

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_commseq_postcard = new \ultracart\v2\models\EmailCommseqPostcard(); // \ultracart\v2\models\EmailCommseqPostcard | Email postcard

try {
    $result = $apiInstance->insertEmailPostcard($storefront_oid, $email_commseq_postcard);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailPostcard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_commseq_postcard	\ultracart\v2\models\EmailCommseqPostcard	Email postcard

Return type

\ultracart\v2\models\EmailCommseqPostcardResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertEmailSegment

\ultracart\v2\models\EmailSegmentResponse insertEmailSegment($storefront_oid, $email_segment)

Insert email segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment = new \ultracart\v2\models\EmailSegment(); // \ultracart\v2\models\EmailSegment | Email segment

try {
    $result = $apiInstance->insertEmailSegment($storefront_oid, $email_segment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertEmailSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_segment	\ultracart\v2\models\EmailSegment	Email segment

Return type

\ultracart\v2\models\EmailSegmentResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertScreenRecordingSegment

\ultracart\v2\models\ScreenRecordingSegmentResponse insertScreenRecordingSegment($storefront_oid, $segment)

Insert screen recording segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$segment = new \ultracart\v2\models\ScreenRecordingSegment(); // \ultracart\v2\models\ScreenRecordingSegment | Segment

try {
    $result = $apiInstance->insertScreenRecordingSegment($storefront_oid, $segment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertScreenRecordingSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
segment	\ultracart\v2\models\ScreenRecordingSegment	Segment

Return type

\ultracart\v2\models\ScreenRecordingSegmentResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insertUpdatePageContentAttribute

insertUpdatePageContentAttribute($page_attribute, $storefront_oid, $page_oid)

Upsert a page content attribute

Update a page content attribute, creating it new if it does not yet exist.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$page_attribute = new \ultracart\v2\models\StoreFrontPageContentAttribute(); // \ultracart\v2\models\StoreFrontPageContentAttribute | Page content attribute to upsert
$storefront_oid = 56; // int | 
$page_oid = 56; // int | The page oid to modify.

try {
    $apiInstance->insertUpdatePageContentAttribute($page_attribute, $storefront_oid, $page_oid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->insertUpdatePageContentAttribute: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
page_attribute	\ultracart\v2\models\StoreFrontPageContentAttribute	Page content attribute to upsert
storefront_oid	int
page_oid	int	The page oid to modify.

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

prepareDownloadEmailSegment

\ultracart\v2\models\EmailSegmentDownloadPrepareResponse prepareDownloadEmailSegment($storefront_oid, $email_segment_uuid)

Prepare download of email segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 

try {
    $result = $apiInstance->prepareDownloadEmailSegment($storefront_oid, $email_segment_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->prepareDownloadEmailSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_segment_uuid	string

Return type

\ultracart\v2\models\EmailSegmentDownloadPrepareResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publishLibraryItem

\ultracart\v2\models\LibraryItemResponse publishLibraryItem($library_item_oid, $publish_library_request)

Publish library item.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$library_item_oid = 56; // int | 
$publish_library_request = new \ultracart\v2\models\PublishLibraryItemRequest(); // \ultracart\v2\models\PublishLibraryItemRequest | Publish library item request

try {
    $result = $apiInstance->publishLibraryItem($library_item_oid, $publish_library_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->publishLibraryItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
library_item_oid	int
publish_library_request	\ultracart\v2\models\PublishLibraryItemRequest	Publish library item request

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchaseLibraryItem

\ultracart\v2\models\LibraryItemResponse purchaseLibraryItem($library_item_oid, $storefront_oid)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$library_item_oid = 56; // int | 
$storefront_oid = 56; // int | 

try {
    $result = $apiInstance->purchaseLibraryItem($library_item_oid, $storefront_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->purchaseLibraryItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
library_item_oid	int
storefront_oid	int		[optional]

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

releaseEmailCommseqStepWaiting

releaseEmailCommseqStepWaiting($storefront_oid, $commseq_uuid, $commseq_step_uuid)

Release email communication sequence customers waiting at the specified step

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$commseq_step_uuid = "commseq_step_uuid_example"; // string | 

try {
    $apiInstance->releaseEmailCommseqStepWaiting($storefront_oid, $commseq_uuid, $commseq_step_uuid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->releaseEmailCommseqStepWaiting: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_uuid	string
commseq_step_uuid	string

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resetEmailCommseqRateLimiters

resetEmailCommseqRateLimiters($storefront_oid, $commseq_uuid)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 

try {
    $apiInstance->resetEmailCommseqRateLimiters($storefront_oid, $commseq_uuid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->resetEmailCommseqRateLimiters: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
commseq_uuid	string

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

review

\ultracart\v2\models\EmailCommseqEmailSendTestResponse review($storefront_oid, $commseq_email_uuid, $email_commseq_email_review_request)

Request a review of an email

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_email_uuid = "commseq_email_uuid_example"; // string | 
$email_commseq_email_review_request = new \ultracart\v2\models\EmailCommseqEmailSendTestRequest(); // \ultracart\v2\models\EmailCommseqEmailSendTestRequest | Email commseq email review request

try {
    $result = $apiInstance->review($storefront_oid, $commseq_email_uuid, $email_commseq_email_review_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->review: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_email_uuid	string
email_commseq_email_review_request	\ultracart\v2\models\EmailCommseqEmailSendTestRequest	Email commseq email review request

Return type

\ultracart\v2\models\EmailCommseqEmailSendTestResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search

\ultracart\v2\models\LookupResponse search($category, $matches, $storefront_oid, $max_hits, $subcategory)

Searches for all matching values

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$category = "category_example"; // string | 
$matches = "matches_example"; // string | 
$storefront_oid = "storefront_oid_example"; // string | 
$max_hits = 56; // int | 
$subcategory = "subcategory_example"; // string | 

try {
    $result = $apiInstance->search($category, $matches, $storefront_oid, $max_hits, $subcategory);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->search: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
category	string	[optional]
matches	string	[optional]
storefront_oid	string	[optional]
max_hits	int	[optional]
subcategory	string	[optional]

Return type

\ultracart\v2\models\LookupResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search2

\ultracart\v2\models\LookupResponse search2($lookup_request)

Searches for all matching values (using POST)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$lookup_request = new \ultracart\v2\models\LookupRequest(); // \ultracart\v2\models\LookupRequest | LookupRequest

try {
    $result = $apiInstance->search2($lookup_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->search2: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lookup_request	\ultracart\v2\models\LookupRequest	LookupRequest

Return type

\ultracart\v2\models\LookupResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchEmailListCustomers

\ultracart\v2\models\EmailListCustomersResponse searchEmailListCustomers($storefront_oid, $email_list_uuid, $starts_with)

Search email list customers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_uuid = "email_list_uuid_example"; // string | 
$starts_with = "starts_with_example"; // string | 

try {
    $result = $apiInstance->searchEmailListCustomers($storefront_oid, $email_list_uuid, $starts_with);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->searchEmailListCustomers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
email_list_uuid	string
starts_with	string	[optional]

Return type

\ultracart\v2\models\EmailListCustomersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchEmailSegmentCustomers

\ultracart\v2\models\EmailSegmentCustomersResponse searchEmailSegmentCustomers($storefront_oid, $email_segment_uuid, $starts_with)

Search email segment customers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 
$starts_with = "starts_with_example"; // string | 

try {
    $result = $apiInstance->searchEmailSegmentCustomers($storefront_oid, $email_segment_uuid, $starts_with);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->searchEmailSegmentCustomers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
storefront_oid	int
email_segment_uuid	string
starts_with	string	[optional]

Return type

\ultracart\v2\models\EmailSegmentCustomersResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchLibraryItems

\ultracart\v2\models\LibraryItemsResponse searchLibraryItems($item_query, $_limit, $_offset, $_sort)

Retrieve library items

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$item_query = new \ultracart\v2\models\LibraryItemQuery(); // \ultracart\v2\models\LibraryItemQuery | Item query
$_limit = 10000; // int | The maximum number of records to return on this one API call. (Maximum 10000)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_sort = "_sort_example"; // string | The sort order of the library items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

try {
    $result = $apiInstance->searchLibraryItems($item_query, $_limit, $_offset, $_sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->searchLibraryItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
item_query	\ultracart\v2\models\LibraryItemQuery	Item query
_limit	int	The maximum number of records to return on this one API call. (Maximum 10000)	[optional] [default to 10000]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_sort	string	The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

searchPublishedItems

\ultracart\v2\models\LibraryItemsResponse searchPublishedItems($item_query, $_limit, $_offset, $_sort)

Retrieve library items

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$item_query = new \ultracart\v2\models\LibraryItemQuery(); // \ultracart\v2\models\LibraryItemQuery | Item query
$_limit = 10000; // int | The maximum number of records to return on this one API call. (Maximum 10000)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_sort = "_sort_example"; // string | The sort order of the library items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

try {
    $result = $apiInstance->searchPublishedItems($item_query, $_limit, $_offset, $_sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->searchPublishedItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
item_query	\ultracart\v2\models\LibraryItemQuery	Item query
_limit	int	The maximum number of records to return on this one API call. (Maximum 10000)	[optional] [default to 10000]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_sort	string	The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

searchReviewItems

\ultracart\v2\models\LibraryItemsResponse searchReviewItems($item_query, $_limit, $_offset, $_sort)

Retrieve library items needing review or rejected

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$item_query = new \ultracart\v2\models\LibraryItemQuery(); // \ultracart\v2\models\LibraryItemQuery | Item query
$_limit = 10000; // int | The maximum number of records to return on this one API call. (Maximum 10000)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_sort = "_sort_example"; // string | The sort order of the library items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

try {
    $result = $apiInstance->searchReviewItems($item_query, $_limit, $_offset, $_sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->searchReviewItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
item_query	\ultracart\v2\models\LibraryItemQuery	Item query
_limit	int	The maximum number of records to return on this one API call. (Maximum 10000)	[optional] [default to 10000]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_sort	string	The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

searchSharedItems

\ultracart\v2\models\LibraryItemsResponse searchSharedItems($item_query, $_limit, $_offset, $_sort)

Retrieve library items

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$item_query = new \ultracart\v2\models\LibraryItemQuery(); // \ultracart\v2\models\LibraryItemQuery | Item query
$_limit = 10000; // int | The maximum number of records to return on this one API call. (Maximum 10000)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_sort = "_sort_example"; // string | The sort order of the library items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

try {
    $result = $apiInstance->searchSharedItems($item_query, $_limit, $_offset, $_sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->searchSharedItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
item_query	\ultracart\v2\models\LibraryItemQuery	Item query
_limit	int	The maximum number of records to return on this one API call. (Maximum 10000)	[optional] [default to 10000]
_offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_sort	string	The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

sendEmailTest

\ultracart\v2\models\EmailCommseqEmailSendTestResponse sendEmailTest($storefront_oid, $commseq_email_uuid, $email_commseq_email_test_request)

Send email test

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_email_uuid = "commseq_email_uuid_example"; // string | 
$email_commseq_email_test_request = new \ultracart\v2\models\EmailCommseqEmailSendTestRequest(); // \ultracart\v2\models\EmailCommseqEmailSendTestRequest | Email commseq email test request

try {
    $result = $apiInstance->sendEmailTest($storefront_oid, $commseq_email_uuid, $email_commseq_email_test_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->sendEmailTest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_email_uuid	string
email_commseq_email_test_request	\ultracart\v2\models\EmailCommseqEmailSendTestRequest	Email commseq email test request

Return type

\ultracart\v2\models\EmailCommseqEmailSendTestResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendPostcardTest

\ultracart\v2\models\EmailCommseqPostcardSendTestResponse sendPostcardTest($storefront_oid, $commseq_postcard_uuid, $email_commseq_postcard_test_request)

Send postcard test

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_postcard_uuid = "commseq_postcard_uuid_example"; // string | 
$email_commseq_postcard_test_request = new \ultracart\v2\models\EmailCommseqPostcardSendTestRequest(); // \ultracart\v2\models\EmailCommseqPostcardSendTestRequest | Email commseq email test request

try {
    $result = $apiInstance->sendPostcardTest($storefront_oid, $commseq_postcard_uuid, $email_commseq_postcard_test_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->sendPostcardTest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_postcard_uuid	string
email_commseq_postcard_test_request	\ultracart\v2\models\EmailCommseqPostcardSendTestRequest	Email commseq email test request

Return type

\ultracart\v2\models\EmailCommseqPostcardSendTestResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendSmsTest

\ultracart\v2\models\EmailCommseqSmsSendTestResponse sendSmsTest($storefront_oid, $commseq_uuid, $commseq_step_uuid, $email_commseq_sms_test_request)

Send SMS test

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$commseq_step_uuid = "commseq_step_uuid_example"; // string | 
$email_commseq_sms_test_request = new \ultracart\v2\models\EmailCommseqSmsSendTestRequest(); // \ultracart\v2\models\EmailCommseqSmsSendTestRequest | Email commseq sms test request

try {
    $result = $apiInstance->sendSmsTest($storefront_oid, $commseq_uuid, $commseq_step_uuid, $email_commseq_sms_test_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->sendSmsTest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_uuid	string
commseq_step_uuid	string
email_commseq_sms_test_request	\ultracart\v2\models\EmailCommseqSmsSendTestRequest	Email commseq sms test request

Return type

\ultracart\v2\models\EmailCommseqSmsSendTestResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendWebhookTest

\ultracart\v2\models\EmailCommseqWebhookSendTestResponse sendWebhookTest($storefront_oid, $email_commseq_webhook_test_request)

Send webhook test

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_commseq_webhook_test_request = new \ultracart\v2\models\EmailCommseqWebhookSendTestRequest(); // \ultracart\v2\models\EmailCommseqWebhookSendTestRequest | Email commseq webhook test request

try {
    $result = $apiInstance->sendWebhookTest($storefront_oid, $email_commseq_webhook_test_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->sendWebhookTest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_commseq_webhook_test_request	\ultracart\v2\models\EmailCommseqWebhookSendTestRequest	Email commseq webhook test request

Return type

\ultracart\v2\models\EmailCommseqWebhookSendTestResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sequenceTest

\ultracart\v2\models\EmailCommseqSequenceTestResponse sequenceTest($storefront_oid, $commseq_uuid, $email_commseq_sequence_test_request)

Sequence test

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$email_commseq_sequence_test_request = new \ultracart\v2\models\EmailCommseqSequenceTestRequest(); // \ultracart\v2\models\EmailCommseqSequenceTestRequest | Commseq test request

try {
    $result = $apiInstance->sequenceTest($storefront_oid, $commseq_uuid, $email_commseq_sequence_test_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->sequenceTest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_uuid	string
email_commseq_sequence_test_request	\ultracart\v2\models\EmailCommseqSequenceTestRequest	Commseq test request

Return type

\ultracart\v2\models\EmailCommseqSequenceTestResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startEmailCampaign

\ultracart\v2\models\BaseResponse startEmailCampaign($storefront_oid, $email_campaign_uuid)

Start email campaign

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_uuid = "email_campaign_uuid_example"; // string | 

try {
    $result = $apiInstance->startEmailCampaign($storefront_oid, $email_campaign_uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->startEmailCampaign: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_campaign_uuid	string

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

subscribeToEmailList

\ultracart\v2\models\EmailListSubscribeResponse subscribeToEmailList($storefront_oid, $email_list_uuid, $customers)

Subscribe customers to email list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_uuid = "email_list_uuid_example"; // string | 
$customers = array(new \ultracart\v2\models\EmailCustomer()); // \ultracart\v2\models\EmailCustomer[] | Customers

try {
    $result = $apiInstance->subscribeToEmailList($storefront_oid, $email_list_uuid, $customers);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->subscribeToEmailList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_list_uuid	string
customers	\ultracart\v2\models\EmailCustomer[]	Customers

Return type

\ultracart\v2\models\EmailListSubscribeResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sunsetEmailSegment

sunsetEmailSegment($storefront_oid, $email_segment_uuid)

Sunset email segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 

try {
    $apiInstance->sunsetEmailSegment($storefront_oid, $email_segment_uuid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->sunsetEmailSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
email_segment_uuid	string

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unfavoriteScreenRecording

unfavoriteScreenRecording($storefront_oid, $screen_recording_uuid)

Remove favorite flag on screen recording

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_uuid = "screen_recording_uuid_example"; // string | 

try {
    $apiInstance->unfavoriteScreenRecording($storefront_oid, $screen_recording_uuid);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->unfavoriteScreenRecording: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
screen_recording_uuid	string

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

updateEmailCampaign

\ultracart\v2\models\EmailCampaignResponse updateEmailCampaign($storefront_oid, $email_campaign_uuid, $email_campaign)

Update email campaign

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_uuid = "email_campaign_uuid_example"; // string | 
$email_campaign = new \ultracart\v2\models\EmailCampaign(); // \ultracart\v2\models\EmailCampaign | Email campaign

try {
    $result = $apiInstance->updateEmailCampaign($storefront_oid, $email_campaign_uuid, $email_campaign);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailCampaign: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_campaign_uuid	string
email_campaign	\ultracart\v2\models\EmailCampaign	Email campaign

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailCampaignFolder

\ultracart\v2\models\EmailCampaignFolderResponse updateEmailCampaignFolder($storefront_oid, $email_campaign_folder_uuid, $email_campaign_folder)

Update email campaign folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_campaign_folder_uuid = "email_campaign_folder_uuid_example"; // string | 
$email_campaign_folder = new \ultracart\v2\models\EmailCampaignFolder(); // \ultracart\v2\models\EmailCampaignFolder | Email campaign folder

try {
    $result = $apiInstance->updateEmailCampaignFolder($storefront_oid, $email_campaign_folder_uuid, $email_campaign_folder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailCampaignFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_campaign_folder_uuid	string
email_campaign_folder	\ultracart\v2\models\EmailCampaignFolder	Email campaign folder

Return type

\ultracart\v2\models\EmailCampaignFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailCommseq

\ultracart\v2\models\EmailCommseqResponse updateEmailCommseq($storefront_oid, $commseq_uuid, $email_commseq)

Update email commseq

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_uuid = "commseq_uuid_example"; // string | 
$email_commseq = new \ultracart\v2\models\EmailCommseq(); // \ultracart\v2\models\EmailCommseq | Email commseq

try {
    $result = $apiInstance->updateEmailCommseq($storefront_oid, $commseq_uuid, $email_commseq);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailCommseq: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_uuid	string
email_commseq	\ultracart\v2\models\EmailCommseq	Email commseq

Return type

\ultracart\v2\models\EmailCommseqResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailCustomer

updateEmailCustomer($storefront_oid, $email_customer_uuid, $email_customer)

Update email customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_customer_uuid = "email_customer_uuid_example"; // string | 
$email_customer = new \ultracart\v2\models\EmailCustomer(); // \ultracart\v2\models\EmailCustomer | Email customer

try {
    $apiInstance->updateEmailCustomer($storefront_oid, $email_customer_uuid, $email_customer);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_customer_uuid	string
email_customer	\ultracart\v2\models\EmailCustomer	Email customer

Return type

void (empty response body)

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailEmail

\ultracart\v2\models\EmailCommseqEmailResponse updateEmailEmail($storefront_oid, $commseq_email_uuid, $email_commseq_email)

Update email email

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_email_uuid = "commseq_email_uuid_example"; // string | 
$email_commseq_email = new \ultracart\v2\models\EmailCommseqEmail(); // \ultracart\v2\models\EmailCommseqEmail | Email commseq email

try {
    $result = $apiInstance->updateEmailEmail($storefront_oid, $commseq_email_uuid, $email_commseq_email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_email_uuid	string
email_commseq_email	\ultracart\v2\models\EmailCommseqEmail	Email commseq email

Return type

\ultracart\v2\models\EmailCommseqEmailResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailFlow

\ultracart\v2\models\EmailFlowResponse updateEmailFlow($storefront_oid, $email_flow_uuid, $email_flow)

Update email flow

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_uuid = "email_flow_uuid_example"; // string | 
$email_flow = new \ultracart\v2\models\EmailFlow(); // \ultracart\v2\models\EmailFlow | Email flow

try {
    $result = $apiInstance->updateEmailFlow($storefront_oid, $email_flow_uuid, $email_flow);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailFlow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_flow_uuid	string
email_flow	\ultracart\v2\models\EmailFlow	Email flow

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailFlowFolder

\ultracart\v2\models\EmailFlowFolderResponse updateEmailFlowFolder($storefront_oid, $email_flow_folder_uuid, $email_flow_folder)

Update email flow folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_flow_folder_uuid = "email_flow_folder_uuid_example"; // string | 
$email_flow_folder = new \ultracart\v2\models\EmailFlowFolder(); // \ultracart\v2\models\EmailFlowFolder | Email flow folder

try {
    $result = $apiInstance->updateEmailFlowFolder($storefront_oid, $email_flow_folder_uuid, $email_flow_folder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailFlowFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_flow_folder_uuid	string
email_flow_folder	\ultracart\v2\models\EmailFlowFolder	Email flow folder

Return type

\ultracart\v2\models\EmailFlowFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailGlobalSettings

\ultracart\v2\models\EmailGlobalSettingsResponse updateEmailGlobalSettings($global_settings)

Update email global settings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$global_settings = new \ultracart\v2\models\EmailGlobalSettings(); // \ultracart\v2\models\EmailGlobalSettings | global settings request

try {
    $result = $apiInstance->updateEmailGlobalSettings($global_settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailGlobalSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
global_settings	\ultracart\v2\models\EmailGlobalSettings	global settings request

Return type

\ultracart\v2\models\EmailGlobalSettingsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailList

\ultracart\v2\models\EmailListResponse updateEmailList($storefront_oid, $email_list_uuid, $email_list)

Update email list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_uuid = "email_list_uuid_example"; // string | 
$email_list = new \ultracart\v2\models\EmailList(); // \ultracart\v2\models\EmailList | Email list

try {
    $result = $apiInstance->updateEmailList($storefront_oid, $email_list_uuid, $email_list);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_list_uuid	string
email_list	\ultracart\v2\models\EmailList	Email list

Return type

\ultracart\v2\models\EmailListResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailListSegmentFolder

\ultracart\v2\models\EmailListSegmentFolderResponse updateEmailListSegmentFolder($storefront_oid, $email_list_segment_folder_uuid, $email_list_segment_folder)

Update email campaign folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_list_segment_folder_uuid = "email_list_segment_folder_uuid_example"; // string | 
$email_list_segment_folder = new \ultracart\v2\models\EmailListSegmentFolder(); // \ultracart\v2\models\EmailListSegmentFolder | Email campaign folder

try {
    $result = $apiInstance->updateEmailListSegmentFolder($storefront_oid, $email_list_segment_folder_uuid, $email_list_segment_folder);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailListSegmentFolder: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_list_segment_folder_uuid	string
email_list_segment_folder	\ultracart\v2\models\EmailListSegmentFolder	Email campaign folder

Return type

\ultracart\v2\models\EmailListSegmentFolderResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailPlan

\ultracart\v2\models\EmailPlanResponse updateEmailPlan($storefront_oid, $settings)

Update email plan

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$settings = new \ultracart\v2\models\EmailPlan(); // \ultracart\v2\models\EmailPlan | plan request

try {
    $result = $apiInstance->updateEmailPlan($storefront_oid, $settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailPlan: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
settings	\ultracart\v2\models\EmailPlan	plan request

Return type

\ultracart\v2\models\EmailPlanResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailPostcard

\ultracart\v2\models\EmailCommseqPostcardResponse updateEmailPostcard($storefront_oid, $commseq_postcard_uuid, $email_commseq_postcard)

Update email postcard

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$commseq_postcard_uuid = "commseq_postcard_uuid_example"; // string | 
$email_commseq_postcard = new \ultracart\v2\models\EmailCommseqPostcard(); // \ultracart\v2\models\EmailCommseqPostcard | Email commseq postcard

try {
    $result = $apiInstance->updateEmailPostcard($storefront_oid, $commseq_postcard_uuid, $email_commseq_postcard);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailPostcard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
commseq_postcard_uuid	string
email_commseq_postcard	\ultracart\v2\models\EmailCommseqPostcard	Email commseq postcard

Return type

\ultracart\v2\models\EmailCommseqPostcardResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailSegment

\ultracart\v2\models\EmailSegmentResponse updateEmailSegment($storefront_oid, $email_segment_uuid, $email_segment)

Update email segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$email_segment_uuid = "email_segment_uuid_example"; // string | 
$email_segment = new \ultracart\v2\models\EmailSegment(); // \ultracart\v2\models\EmailSegment | Email segment

try {
    $result = $apiInstance->updateEmailSegment($storefront_oid, $email_segment_uuid, $email_segment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
email_segment_uuid	string
email_segment	\ultracart\v2\models\EmailSegment	Email segment

Return type

\ultracart\v2\models\EmailSegmentResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailSendingDomain

\ultracart\v2\models\EmailSendingDomainResponse updateEmailSendingDomain($domain, $email_domain)

Update email sending domain

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$domain = "domain_example"; // string | 
$email_domain = new \ultracart\v2\models\EmailDomain(); // \ultracart\v2\models\EmailDomain | EmailDomain

try {
    $result = $apiInstance->updateEmailSendingDomain($domain, $email_domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailSendingDomain: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
domain	string
email_domain	\ultracart\v2\models\EmailDomain	EmailDomain

Return type

\ultracart\v2\models\EmailSendingDomainResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEmailSettings

\ultracart\v2\models\EmailSettingsResponse updateEmailSettings($storefront_oid, $settings)

Update email settings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$settings = new \ultracart\v2\models\EmailSettings(); // \ultracart\v2\models\EmailSettings | settings request

try {
    $result = $apiInstance->updateEmailSettings($storefront_oid, $settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateEmailSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
settings	\ultracart\v2\models\EmailSettings	settings request

Return type

\ultracart\v2\models\EmailSettingsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateExperiment

\ultracart\v2\models\ExperimentResponse updateExperiment($storefront_oid, $storefront_experiment_oid, $experiment)

Update experiment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$storefront_experiment_oid = 56; // int | 
$experiment = new \ultracart\v2\models\Experiment(); // \ultracart\v2\models\Experiment | Experiment

try {
    $result = $apiInstance->updateExperiment($storefront_oid, $storefront_experiment_oid, $experiment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateExperiment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
storefront_experiment_oid	int
experiment	\ultracart\v2\models\Experiment	Experiment

Return type

\ultracart\v2\models\ExperimentResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateLibraryItem

\ultracart\v2\models\LibraryItemResponse updateLibraryItem($library_item_oid, $library_item)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$library_item_oid = 56; // int | 
$library_item = new \ultracart\v2\models\LibraryItem(); // \ultracart\v2\models\LibraryItem | Library item

try {
    $result = $apiInstance->updateLibraryItem($library_item_oid, $library_item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateLibraryItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
library_item_oid	int
library_item	\ultracart\v2\models\LibraryItem	Library item

Return type

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateScreenRecordingMerchantNotes

updateScreenRecordingMerchantNotes($storefront_oid, $screen_recording_uuid, $merchant_notes_request)

Update merchant notes on a screen recording

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_uuid = "screen_recording_uuid_example"; // string | 
$merchant_notes_request = new \ultracart\v2\models\ScreenRecordingMerchantNotesRequest(); // \ultracart\v2\models\ScreenRecordingMerchantNotesRequest | Merchant Notes

try {
    $apiInstance->updateScreenRecordingMerchantNotes($storefront_oid, $screen_recording_uuid, $merchant_notes_request);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateScreenRecordingMerchantNotes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
screen_recording_uuid	string
merchant_notes_request	\ultracart\v2\models\ScreenRecordingMerchantNotesRequest	Merchant Notes

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

updateScreenRecordingSegment

\ultracart\v2\models\ScreenRecordingSegmentResponse updateScreenRecordingSegment($storefront_oid, $screen_recording_segment_oid, $segment)

Update screen recording segment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_segment_oid = 56; // int | 
$segment = new \ultracart\v2\models\ScreenRecordingSegment(); // \ultracart\v2\models\ScreenRecordingSegment | Segment

try {
    $result = $apiInstance->updateScreenRecordingSegment($storefront_oid, $screen_recording_segment_oid, $segment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateScreenRecordingSegment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
screen_recording_segment_oid	int
segment	\ultracart\v2\models\ScreenRecordingSegment	Segment

Return type

\ultracart\v2\models\ScreenRecordingSegmentResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateScreenRecordingSettings

\ultracart\v2\models\ScreenRecordingSettingsResponse updateScreenRecordingSettings($storefront_oid, $settings)

Update screen recording settings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$settings = new \ultracart\v2\models\ScreenRecordingSettings(); // \ultracart\v2\models\ScreenRecordingSettings | Settings

try {
    $result = $apiInstance->updateScreenRecordingSettings($storefront_oid, $settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateScreenRecordingSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
storefront_oid	int
settings	\ultracart\v2\models\ScreenRecordingSettings	Settings

Return type

\ultracart\v2\models\ScreenRecordingSettingsResponse

Authorization

ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateScreenRecordingTags

updateScreenRecordingTags($storefront_oid, $screen_recording_uuid, $tags)

Update tags on a screen recording

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\StorefrontApi::usingApiKey($simple_key);

$storefront_oid = 56; // int | 
$screen_recording_uuid = "screen_recording_uuid_example"; // string | 
$tags = new \ultracart\v2\models\ScreenRecordingTagsRequest(); // \ultracart\v2\models\ScreenRecordingTagsRequest | Tags

try {
    $apiInstance->updateScreenRecordingTags($storefront_oid, $screen_recording_uuid, $tags);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontApi->updateScreenRecordingTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
storefront_oid	int
screen_recording_uuid	string
tags	\ultracart\v2\models\ScreenRecordingTagsRequest	Tags

Return type

void (empty response body)

Authorization