csharp
java
javascript
php
python
ruby
typescript

storefront

/storefront




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

namespace SdkSample.storefront
{
    public class introduction
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class Introduction {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Add to library

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/code_library

SDK Function Name: addToLibrary

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



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

namespace SdkSample.storefront
{
    public class AddToLibrary
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class AddToLibrary {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Apply library item to storefront.

Permissions:
  • storefront_write

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

SDK Function Name: applyToStoreFront

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



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

namespace SdkSample.storefront
{
    public class ApplyToStoreFront
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class ApplyToStoreFront {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

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

Permissions:
  • storefront_read

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

SDK Function Name: getLibraryFilterValues

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



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

namespace SdkSample.storefront
{
    public class GetLibraryFilterValues
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetLibraryFilterValues {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Retrieve library items

Permissions:
  • affiliate_read

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

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

SDK Function Name: searchLibraryItems

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



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

namespace SdkSample.storefront
{
    public class SearchLibraryItems
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class SearchLibraryItems {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Retrieve library items

Permissions:
  • affiliate_read

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

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

SDK Function Name: searchPublishedItems

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



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

namespace SdkSample.storefront
{
    public class SearchPublishedItems
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class SearchPublishedItems {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Retrieve library items needing review or rejected

Permissions:
  • affiliate_read

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

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

SDK Function Name: searchReviewItems

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



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

namespace SdkSample.storefront
{
    public class SearchReviewItems
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class SearchReviewItems {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Retrieve library items

Permissions:
  • affiliate_read

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

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

SDK Function Name: searchSharedItems

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



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

namespace SdkSample.storefront
{
    public class SearchSharedItems
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class SearchSharedItems {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Delete library item

Permissions:
  • storefront_write

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

SDK Function Name: deleteLibraryItem

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



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

namespace SdkSample.storefront
{
    public class DeleteLibraryItem
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DeleteLibraryItem {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get library item.

Permissions:
  • storefront_read

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

SDK Function Name: getLibraryItem

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



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

namespace SdkSample.storefront
{
    public class GetLibraryItem
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetLibraryItem {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

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

Permissions:
  • storefront_write

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

SDK Function Name: updateLibraryItem

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



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

namespace SdkSample.storefront
{
    public class UpdateLibraryItem
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateLibraryItem {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Duplicate library item.

Permissions:
  • storefront_write

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

SDK Function Name: duplicateLibraryItem

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



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

namespace SdkSample.storefront
{
    public class DuplicateLibraryItem
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DuplicateLibraryItem {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Publish library item.

Permissions:
  • storefront_write

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

SDK Function Name: publishLibraryItem

Parameters
Parameter Description Location Data Type Required
library_item_oid path integer (int32) optional
publish_library_request Publish library item request body PublishLibraryItemRequest required
Responses
Status Code Reason Response Model
200
Successful response LibraryItemResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500



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

namespace SdkSample.storefront
{
    public class PublishLibraryItem
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class PublishLibraryItem {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

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

Permissions:
  • storefront_write

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

SDK Function Name: deleteLibraryItemPublishedVersions

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



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

namespace SdkSample.storefront
{
    public class DeleteLibraryItemPublishedVersions
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DeleteLibraryItemPublishedVersions {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get all published versions for a library item.

Permissions:
  • storefront_read

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

SDK Function Name: getLibraryItemPublishedVersions

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



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

namespace SdkSample.storefront
{
    public class GetLibraryItemPublishedVersions
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetLibraryItemPublishedVersions {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

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

Permissions:
  • storefront_write

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

SDK Function Name: purchaseLibraryItem

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



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

namespace SdkSample.storefront
{
    public class PurchaseLibraryItem
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class PurchaseLibraryItem {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email globalsettings

Permissions:
  • storefront_read

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

SDK Function Name: getEmailGlobalSettings

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



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

namespace SdkSample.storefront
{
    public class GetEmailGlobalSettings
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailGlobalSettings {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email global settings

Permissions:
  • storefront_write

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

SDK Function Name: updateEmailGlobalSettings

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



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

namespace SdkSample.storefront
{
    public class UpdateEmailGlobalSettings
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailGlobalSettings {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email sending domain

Permissions:
  • storefront_read

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

SDK Function Name: getEmailSendingDomain

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



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

namespace SdkSample.storefront
{
    public class GetEmailSendingDomain
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailSendingDomain {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email sending domains

Permissions:
  • storefront_read

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

SDK Function Name: getEmailSendingDomains

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



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

namespace SdkSample.storefront
{
    public class GetEmailSendingDomains
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailSendingDomains {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

delete email campaign

Permissions:
  • storefront_write

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

SDK Function Name: deleteEmailSendingDomain

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



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

namespace SdkSample.storefront
{
    public class DeleteEmailSendingDomain
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DeleteEmailSendingDomain {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Create email campaign

Permissions:
  • storefront_write

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

SDK Function Name: createEmailSendingDomain

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



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

namespace SdkSample.storefront
{
    public class CreateEmailSendingDomain
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class CreateEmailSendingDomain {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email sending domain status

Permissions:
  • storefront_write

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

SDK Function Name: getEmailSendingDomainStatus

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



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

namespace SdkSample.storefront
{
    public class GetEmailSendingDomainStatus
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailSendingDomainStatus {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Retrieve pricing tiers

Permissions:
  • item_read

Produces: application/json
get
/storefront/pricing_tiers

Retrieves the pricing tiers

SDK Function Name: getStoreFrontPricingTiers

Parameters
Parameter Description Location Data Type Required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response PricingTiersResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Searches for all matching values

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/search

SDK Function Name: search

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



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

namespace SdkSample.storefront
{
    public class Search
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class Search {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Searches for all matching values (using POST)

Permissions:
  • storefront_read

Produces: application/json
post
/storefront/search

SDK Function Name: search2

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



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

namespace SdkSample.storefront
{
    public class Search2
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class Search2 {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get thumbnail parameters

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/thumbnailParameters

SDK Function Name: getThumbnailParameters

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



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

namespace SdkSample.storefront
{
    public class GetThumbnailParameters
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetThumbnailParameters {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get all Twilio accounts

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/twilio/accounts

SDK Function Name: getTwilioAccounts

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

Create Twilio account

Permissions:
  • storefront_write

Produces: application/json
post
/storefront/twilio/accounts

SDK Function Name: createTwilioAccount

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

delete Twilio account

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/twilio/accounts/{esp_twilio_uuid}

SDK Function Name: deleteTwilioAccount

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

Get Twilio account

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/twilio/accounts/{esp_twilio_uuid}

SDK Function Name: getTwilioAccount

Parameters
Parameter Description Location Data Type Required
esp_twilio_uuid path string optional
Responses
Status Code Reason Response Model
200
Successful response TwilioResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Update Twilio account

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/twilio/accounts/{esp_twilio_uuid}

SDK Function Name: updateTwilioAccount

Parameters
Parameter Description Location Data Type Required
esp_twilio_uuid path string optional
twilio Twilio body Twilio required
Responses
Status Code Reason Response Model
200
Successful response TwilioResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Gets editor token

Permissions:
  • storefront_read

get
/storefront/{storefront_oid}/editor_token

Fetches a temporary authentication token for the editor

SDK Function Name: getEditorToken

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



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

namespace SdkSample.storefront
{
    public class GetEditorToken
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEditorToken {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email communication base templates

Permissions:
  • storefront_read

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

SDK Function Name: getEmailBaseTemplates

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



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

namespace SdkSample.storefront
{
    public class GetEmailBaseTemplates
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailBaseTemplates {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email campaign folders

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCampaignFolders

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



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

namespace SdkSample.storefront
{
    public class GetEmailCampaignFolders
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCampaignFolders {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Insert email campaign folder

Permissions:
  • storefront_write

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

SDK Function Name: insertEmailCampaignFolder

Parameters
Parameter Description Location Data Type Required
storefront_oid path integer (int32) optional
email_campaign_folder Email campaign folder body EmailCampaignFolder required
Responses
Status Code Reason Response Model
200
Successful response EmailCampaignFolderResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500



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

namespace SdkSample.storefront
{
    public class InsertEmailCampaignFolder
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class InsertEmailCampaignFolder {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Delete email campaignFolder

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}

SDK Function Name: deleteEmailCampaignFolder

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



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

namespace SdkSample.storefront
{
    public class DeleteEmailCampaignFolder
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DeleteEmailCampaignFolder {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email campaign folder

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}

SDK Function Name: getEmailCampaignFolder

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



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

namespace SdkSample.storefront
{
    public class GetEmailCampaignFolder
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCampaignFolder {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email campaign folder

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}

SDK Function Name: updateEmailCampaignFolder

Parameters
Parameter Description Location Data Type Required
storefront_oid path integer (int32) optional
email_campaign_folder_uuid path string optional
email_campaign_folder Email campaign folder body EmailCampaignFolder required
Responses
Status Code Reason Response Model
200
Successful response EmailCampaignFolderResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500



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

namespace SdkSample.storefront
{
    public class UpdateEmailCampaignFolder
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailCampaignFolder {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email campaigns

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCampaigns

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



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

namespace SdkSample.storefront
{
    public class GetEmailCampaigns
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCampaigns {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Insert email campaign

Permissions:
  • storefront_write

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

SDK Function Name: insertEmailCampaign

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



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

namespace SdkSample.storefront
{
    public class InsertEmailCampaign
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class InsertEmailCampaign {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email campaign

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCampaign

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



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

namespace SdkSample.storefront
{
    public class GetEmailCampaign
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCampaign {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email campaign

Permissions:
  • storefront_write

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

SDK Function Name: updateEmailCampaign

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



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

namespace SdkSample.storefront
{
    public class UpdateEmailCampaign
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailCampaign {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Clone email campaign

Permissions:
  • storefront_write

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

SDK Function Name: cloneEmailCampaign

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



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

namespace SdkSample.storefront
{
    public class CloneEmailCampaign
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class CloneEmailCampaign {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email campaign screenshots

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCampaignScreenshots

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



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

namespace SdkSample.storefront
{
    public class GetEmailCampaignScreenshots
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCampaignScreenshots {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Start email campaign

Permissions:
  • storefront_write

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

SDK Function Name: startEmailCampaign

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



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

namespace SdkSample.storefront
{
    public class StartEmailCampaign
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class StartEmailCampaign {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email campaigns with stats

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCampaignsWithStats

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



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

namespace SdkSample.storefront
{
    public class GetEmailCampaignsWithStats
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCampaignsWithStats {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email commseqs

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCommseqs

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



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

namespace SdkSample.storefront
{
    public class GetEmailCommseqs
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCommseqs {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Insert email commseq

Permissions:
  • storefront_write

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

SDK Function Name: insertEmailCommseq

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



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

namespace SdkSample.storefront
{
    public class InsertEmailCommseq
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class InsertEmailCommseq {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email commseq

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCommseq

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



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

namespace SdkSample.storefront
{
    public class GetEmailCommseq
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCommseq {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email commseq

Permissions:
  • storefront_write

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

SDK Function Name: updateEmailCommseq

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



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

namespace SdkSample.storefront
{
    public class UpdateEmailCommseq
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailCommseq {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email communication sequence emails stats

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCommseqEmailStats

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



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

namespace SdkSample.storefront
{
    public class GetEmailCommseqEmailStats
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCommseqEmailStats {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email communication sequence postcard stats

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCommseqPostcardStats

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



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

namespace SdkSample.storefront
{
    public class GetEmailCommseqPostcardStats
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCommseqPostcardStats {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Delete communication sequence stats

Permissions:
  • storefront_write

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

SDK Function Name: deleteEmailCommseqStat

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



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

namespace SdkSample.storefront
{
    public class DeleteEmailCommseqStat
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DeleteEmailCommseqStat {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get communication sequence stats overall

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCommseqStatOverall

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



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

namespace SdkSample.storefront
{
    public class GetEmailCommseqStatOverall
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCommseqStatOverall {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email communication sequence step stats

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCommseqStepStats

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



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

namespace SdkSample.storefront
{
    public class GetEmailCommseqStepStats
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCommseqStepStats {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email email clicks

Permissions:
  • storefront_read

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

SDK Function Name: getEmailEmailClicks

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



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

namespace SdkSample.storefront
{
    public class GetEmailEmailClicks
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailEmailClicks {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email email orders

Permissions:
  • storefront_read

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

SDK Function Name: getEmailEmailOrders

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



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

namespace SdkSample.storefront
{
    public class GetEmailEmailOrders
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailEmailOrders {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email dispatch logs

Permissions:
  • storefront_read

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

SDK Function Name: getEmailDispatchLogs

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

Get email communication sequence customers waiting at each requested step

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCommseqStepWaiting

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



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

namespace SdkSample.storefront
{
    public class GetEmailCommseqStepWaiting
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCommseqStepWaiting {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Release email communication sequence customers waiting at the specified step

Permissions:
  • storefront_read

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

SDK Function Name: releaseEmailCommseqStepWaiting

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



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

namespace SdkSample.storefront
{
    public class ReleaseEmailCommseqStepWaiting
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class ReleaseEmailCommseqStepWaiting {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email webhook editor values

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCommseqWebhookEditorValues

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

Get countries

Permissions:
  • storefront_read

get
/storefront/{storefront_oid}/email/countries

Obtain a list of all the countries

SDK Function Name: getCountries

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



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

namespace SdkSample.storefront
{
    public class GetCountries
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetCountries {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email customers

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCustomers

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



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

namespace SdkSample.storefront
{
    public class GetEmailCustomers
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCustomers {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email customer

Permissions:
  • storefront_write

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

SDK Function Name: updateEmailCustomer

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



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

namespace SdkSample.storefront
{
    public class UpdateEmailCustomer
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailCustomer {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get customers editor URL

Permissions:
  • storefront_read

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

SDK Function Name: getEmailCustomerEditorUrl

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



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

namespace SdkSample.storefront
{
    public class GetEmailCustomerEditorUrl
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailCustomerEditorUrl {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email dashboard activity

Permissions:
  • storefront_read

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

SDK Function Name: getEmailDashboardActivity

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



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

namespace SdkSample.storefront
{
    public class GetEmailDashboardActivity
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailDashboardActivity {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get dashboard stats

Permissions:
  • storefront_read

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

SDK Function Name: getEmailDashboardStats

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



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

namespace SdkSample.storefront
{
    public class GetEmailDashboardStats
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailDashboardStats {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email emails

Permissions:
  • storefront_read

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

SDK Function Name: getEmailEmails

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



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

namespace SdkSample.storefront
{
    public class GetEmailEmails
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailEmails {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Insert email email

Permissions:
  • storefront_write

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

SDK Function Name: insertEmailEmail

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



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

namespace SdkSample.storefront
{
    public class InsertEmailEmail
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class InsertEmailEmail {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email emails multiple

Permissions:
  • storefront_read

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

SDK Function Name: getEmailEmailsMultiple

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



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

namespace SdkSample.storefront
{
    public class GetEmailEmailsMultiple
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailEmailsMultiple {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Delete email email

Permissions:
  • storefront_write

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

SDK Function Name: deleteEmailEmail

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



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

namespace SdkSample.storefront
{
    public class DeleteEmailEmail
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DeleteEmailEmail {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email email

Permissions:
  • storefront_read

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

SDK Function Name: getEmailEmail

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



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

namespace SdkSample.storefront
{
    public class GetEmailEmail
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailEmail {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email email

Permissions:
  • storefront_write

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

SDK Function Name: updateEmailEmail

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



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

namespace SdkSample.storefront
{
    public class UpdateEmailEmail
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailEmail {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email order customer editor url

Permissions:
  • storefront_read

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

SDK Function Name: getEmailEmailCustomerEditorUrl

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



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

namespace SdkSample.storefront
{
    public class GetEmailEmailCustomerEditorUrl
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailEmailCustomerEditorUrl {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Request a review of an email

Permissions:
  • storefront_write

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

SDK Function Name: review

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



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

namespace SdkSample.storefront
{
    public class Review
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class Review {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Send email test

Permissions:
  • storefront_write

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

SDK Function Name: sendEmailTest

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



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

namespace SdkSample.storefront
{
    public class SendEmailTest
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class SendEmailTest {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email flow folders

Permissions:
  • storefront_read

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

SDK Function Name: getEmailFlowFolders

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



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

namespace SdkSample.storefront
{
    public class GetEmailFlowFolders
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailFlowFolders {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Insert email flow folder

Permissions:
  • storefront_write

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

SDK Function Name: insertEmailFlowFolder

Parameters
Parameter Description Location Data Type Required
storefront_oid path integer (int32) optional
email_flow_folder Email flow folder body EmailFlowFolder required
Responses
Status Code Reason Response Model
200
Successful response EmailFlowFolderResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500



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

namespace SdkSample.storefront
{
    public class InsertEmailFlowFolder
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class InsertEmailFlowFolder {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Delete email flowFolder

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}

SDK Function Name: deleteEmailFlowFolder

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



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

namespace SdkSample.storefront
{
    public class DeleteEmailFlowFolder
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DeleteEmailFlowFolder {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email flow folder

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}

SDK Function Name: getEmailFlowFolder

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



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

namespace SdkSample.storefront
{
    public class GetEmailFlowFolder
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailFlowFolder {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email flow folder

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}

SDK Function Name: updateEmailFlowFolder

Parameters
Parameter Description Location Data Type Required
storefront_oid path integer (int32) optional
email_flow_folder_uuid path string optional
email_flow_folder Email flow folder body EmailFlowFolder required
Responses
Status Code Reason Response Model
200
Successful response EmailFlowFolderResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500



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

namespace SdkSample.storefront
{
    public class UpdateEmailFlowFolder
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailFlowFolder {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email flows

Permissions:
  • storefront_read

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

SDK Function Name: getEmailFlows

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



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

namespace SdkSample.storefront
{
    public class GetEmailFlows
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailFlows {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Insert email flow

Permissions:
  • storefront_write

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

SDK Function Name: insertEmailFlow

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



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

namespace SdkSample.storefront
{
    public class InsertEmailFlow
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class InsertEmailFlow {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email flow

Permissions:
  • storefront_read

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

SDK Function Name: getEmailFlow

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



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

namespace SdkSample.storefront
{
    public class GetEmailFlow
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailFlow {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email flow

Permissions:
  • storefront_write

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

SDK Function Name: updateEmailFlow

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



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

namespace SdkSample.storefront
{
    public class UpdateEmailFlow
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailFlow {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Back populate email flow

Permissions:
  • storefront_write

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

SDK Function Name: backPopulateEmailFlow

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



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

namespace SdkSample.storefront
{
    public class BackPopulateEmailFlow
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class BackPopulateEmailFlow {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Clone email flow

Permissions:
  • storefront_write

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

SDK Function Name: cloneEmailFlow

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



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

namespace SdkSample.storefront
{
    public class CloneEmailFlow
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class CloneEmailFlow {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email flow screenshots

Permissions:
  • storefront_read

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

SDK Function Name: getEmailFlowScreenshots

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



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

namespace SdkSample.storefront
{
    public class GetEmailFlowScreenshots
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailFlowScreenshots {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Obtain lat/long for an address

Permissions:
  • storefront_read

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

SDK Function Name: geocodeAddress

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



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

namespace SdkSample.storefront
{
    public class GeocodeAddress
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GeocodeAddress {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Globally unsubscribe a customer

Permissions:
  • storefront_write

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

SDK Function Name: globalUnsubscribe

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



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

namespace SdkSample.storefront
{
    public class GlobalUnsubscribe
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GlobalUnsubscribe {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get histogram property names

Permissions:
  • storefront_read

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

Obtain a list of property names for a given property type

SDK Function Name: getHistogramPropertyNames

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



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

namespace SdkSample.storefront
{
    public class GetHistogramPropertyNames
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetHistogramPropertyNames {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get histogram property values

Permissions:
  • storefront_read

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

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

SDK Function Name: getHistogramPropertyValues

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



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

namespace SdkSample.storefront
{
    public class GetHistogramPropertyValues
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetHistogramPropertyValues {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email campaign folders

Permissions:
  • storefront_read

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

SDK Function Name: getEmailListSegmentFolders

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

Insert email campaign folder

Permissions:
  • storefront_write

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

SDK Function Name: insertEmailListSegmentFolder

Parameters
Parameter Description Location Data Type Required
storefront_oid path integer (int32) optional
email_list_segment_folder Email campaign folder body EmailListSegmentFolder required
Responses
Status Code Reason Response Model
200
Successful response EmailListSegmentFolderResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Delete email ListSegmentFolder

Permissions:
  • storefront_write

Produces: application/json
delete
/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}

SDK Function Name: deleteEmailListSegmentFolder

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

Get email campaign folder

Permissions:
  • storefront_read

Produces: application/json
get
/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}

SDK Function Name: getEmailListSegmentFolder

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

Update email campaign folder

Permissions:
  • storefront_write

Produces: application/json
put
/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}

SDK Function Name: updateEmailListSegmentFolder

Parameters
Parameter Description Location Data Type Required
storefront_oid path integer (int32) optional
email_list_segment_folder_uuid path string optional
email_list_segment_folder Email campaign folder body EmailListSegmentFolder required
Responses
Status Code Reason Response Model
200
Successful response EmailListSegmentFolderResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Get email lists

Permissions:
  • storefront_read

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

SDK Function Name: getEmailLists

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



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

namespace SdkSample.storefront
{
    public class GetEmailLists
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailLists {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Insert email list

Permissions:
  • storefront_write

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

SDK Function Name: insertEmailList

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



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

namespace SdkSample.storefront
{
    public class InsertEmailList
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class InsertEmailList {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email list

Permissions:
  • storefront_read

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

SDK Function Name: getEmailList

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



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

namespace SdkSample.storefront
{
    public class GetEmailList
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailList {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Update email list

Permissions:
  • storefront_write

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

SDK Function Name: updateEmailList

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



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

namespace SdkSample.storefront
{
    public class UpdateEmailList
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class UpdateEmailList {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Archive email list

Permissions:
  • storefront_write

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

SDK Function Name: archiveEmailList

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



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

namespace SdkSample.storefront
{
    public class ArchiveEmailList
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class ArchiveEmailList {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email list customers

Permissions:
  • storefront_read

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

SDK Function Name: getEmailListCustomers

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



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

namespace SdkSample.storefront
{
    public class GetEmailListCustomers
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailListCustomers {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Delete email list customer

Permissions:
  • storefront_read

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

SDK Function Name: deleteEmailListCustomer

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



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

namespace SdkSample.storefront
{
    public class DeleteEmailListCustomer
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class DeleteEmailListCustomer {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email list customer editor url

Permissions:
  • storefront_read

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

SDK Function Name: getEmailListCustomerEditorUrl

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



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

namespace SdkSample.storefront
{
    public class GetEmailListCustomerEditorUrl
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailListCustomerEditorUrl {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Search email list customers

Permissions:
  • storefront_read

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

SDK Function Name: searchEmailListCustomers

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



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

namespace SdkSample.storefront
{
    public class SearchEmailListCustomers
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class SearchEmailListCustomers {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Subscribe customers to email list

Permissions:
  • storefront_write

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

SDK Function Name: subscribeToEmailList

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



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

namespace SdkSample.storefront
{
    public class SubscribeToEmailList
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class SubscribeToEmailList {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        StorefrontApi storefrontApi = new StorefrontApi(apiKey);

        // TODO-PT

    }

}

Get email performance

Permissions:
  • storefront_read

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

SDK Function Name: getEmailPerformance

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



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

namespace SdkSample.storefront
{
    public class GetEmailPerformance
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

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


    }
}



package storefront;

import com.ultracart.admin.v2.StorefrontApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.swagger.ApiException;

public class GetEmailPerformance {

    public static void main(String[] a