Skip to content

UltraCart/rest_api_v2_sdk_php

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SwaggerClient-php

UltraCart REST API Version 2

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 2.0.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit http://www.ultracart.com

Requirements

  • PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/ultracart/rest_api_v2_sdk_php.git"
    }
  ],
  "require": {
    "ultracart/rest_api_v2_sdk_php": "*@dev",
    "guzzlehttp/guzzle": "~6.0"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/vendor/whatever_you_named_your_ultracart_sdk_directory/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php

require_once __DIR__ . '/vendor/autoload.php';

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

// The UltraCart objects are large.  Very large.  So we have encapsulated the fields in sub objects allowing you to
// only request the sub objects you need.  This is done via the expansion object.   The API docs on the main web site
// have more details about expansions:  https://www.ultracart.com/api/#expansion.html
$_expand = "affiliate,affiliate.ledger,auto_order,billing,buysafe,channel_partner,checkout,coupon,customer_profile,digital_order,edi,fraud_score,gift,gift_certificate,internal,item,linked_shipment,marketing,payment,payment.transaction,quote,salesforce,shipping,summary,taxes"; // string | The object expansion to perform on the result.

// this is a detailed example that includes chunking to illustrate how to fetch large record sets from UltraCart.
$_limit = 100;
$counter = 1;
$order_query = new \ultracart\v2\models\OrderQuery();
// we are essentially setting the dates to 'forever' to get all records.
$order_query->setPaymentDateBegin("2010-01-01T00:00:00.0000000-05:00");
$order_query->setPaymentDateEnd("2021-01-01T00:00:00.0000000-05:00");
// there are multiple stages for order flow.  when doing analysis, you almost always want *only* completed orders.
$order_query->setCurrentStage(\ultracart\v2\models\OrderQuery::CURRENT_STAGE_COMPLETED_ORDER);

$order_response = null;

echo "<html><body><pre>";
try {
    do {
        if ($order_response == null) {
            $order_response = $api_instance->getOrdersByQuery($order_query, $_limit, 0, null, $_expand);
        } else {
            $order_response = $api_instance->getOrdersByQuery($order_query, $_limit, $order_response->getMetadata()->getResultSet()->getNextOffset(), null, $_expand);
        }

        echo "order_response.Orders.length: " . sizeof($order_response->getOrders()) . "\n";
        // print out a line for each order *item*
        // notice, email is within the billing child object.
        foreach ($order_response->getOrders() as $order) {
            $order_id = $order->getOrderId();
            $email = $order->getBilling()->getEmail(); // notice the email is part of the billing sub object.
            foreach($order->getItems() as $item){
                echo $order_id . ',' . $email . ',' . $item->getMerchantItemId() . ',' . $item->getQuantity() . "\n";
            }
        }
    } while ($order_response->getMetadata()->getResultSet()->getMore());

} catch (Exception $e) {
    echo 'Exception when calling OrderApi->getOrdersByQuery: ', $e->getMessage(), PHP_EOL;
}
echo "</pre></body></html>";
?>

Automatic Retry (v3.0.62, January 2021)

Starting with 3.0.62, we have modified the standard SDK to include retry logic. This logic was handled to allow client code to automatically retry if it trips the server side rate limiter

Usage

Set the MaxRetyAfter (seconds) within the Configuration object. This is a failsafe to avoid having client code hang forever if the retry-after header returns a large number. If you don't mind your code waiting for an hour, then you may set the retry to 3600, etc.

ultracart\v2\Configuration::getDefaultConfiguration()->setMaxRetrySeconds(30);

This is the actual logic used to determine if a retry should be attempted:

try {
    $response = $this->client->send($request, $options);
} catch (RequestException $e) {

    // BEGIN Retry Logic
    if($e->getResponse()) {
        $retryAfter = 0;
        if (array_key_exists('Retry-After', $headers)) {
            $retryAfter = intval($headers['Retry-After'][0]);
        }

        if ($statusCode == 429 && $retry && $retryAfter > 0 && $retryAfter <= $this->config->getMaxRetrySeconds()) {
            sleep($retryAfter);
            return $this->getCustomersByQueryWithHttpInfoRetry(false, $customer_query, $_limit, $_offset, $_since, $_sort, $_expand);
        }
    }
    // End Retry Logic

    throw new ApiException(
        "[{$e->getCode()}] {$e->getMessage()}",
        $e->getCode(),
        $e->getResponse() ? $e->getResponse()->getHeaders() : null,
        $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
    );
}

Documentation for API Endpoints

All URIs are relative to https://secure.ultracart.com/rest/v2

Class Method HTTP request Description
AffiliateApi getClicksByQuery POST /affiliate/clicks/query Retrieve clicks
AffiliateApi getLedgersByQuery POST /affiliate/ledgers/query Retrieve ledger entries
AutoOrderApi consolidateAutoOrders PUT /auto_order/auto_orders/{auto_order_oid}/consolidate Consolidates multiple auto orders
AutoOrderApi establishAutoOrderByReferenceOrderId POST /auto_order/auto_orders/reference_order_id/{reference_order_id} Establish an auto order by referencing a regular order id
AutoOrderApi getAutoOrder GET /auto_order/auto_orders/{auto_order_oid} Retrieve an auto order by oid
AutoOrderApi getAutoOrderByCode GET /auto_order/auto_orders/code/{auto_order_code} Retrieve an auto order by code
AutoOrderApi getAutoOrderByReferenceOrderId GET /auto_order/auto_orders/reference_order_id/{reference_order_id} Retrieve an auto order by order id
AutoOrderApi getAutoOrders GET /auto_order/auto_orders Retrieve auto orders
AutoOrderApi getAutoOrdersBatch POST /auto_order/auto_orders/batch Retrieve auto order batch
AutoOrderApi getAutoOrdersByQuery POST /auto_order/auto_orders/query Retrieve auto orders by query
AutoOrderApi updateAutoOrder PUT /auto_order/auto_orders/{auto_order_oid} Update an auto order
AutoOrderApi updateAutoOrdersBatch PUT /auto_order/auto_orders/batch Update multiple auto orders
ChannelPartnerApi cancelOrderByChannelPartnerOrderId DELETE /channel_partner/cancel/by_channel_partner_order_id/{order_id} Cancel channel partner order by channel partner order id
ChannelPartnerApi cancelOrderByUltraCartOrderId DELETE /channel_partner/cancel/by_ultracart_order_id/{order_id} Cancel channel partner order by UltraCart order id
ChannelPartnerApi deleteChannelPartnerShipToPreference DELETE /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} Delete a ship to preference record for the channel partner.
ChannelPartnerApi estimateShippingForChannelPartnerOrder POST /channel_partner/estimate_shipping Estimate shipping for channel partner order
ChannelPartnerApi estimateTaxForChannelPartnerOrder POST /channel_partner/estimate_tax Estimate tax for channel partner order
ChannelPartnerApi getChannelPartnerShipToPreference GET /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} Retrieve the ship to preference associated with the channel partner and the specific id.
ChannelPartnerApi getChannelPartnerShipToPreferences GET /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences Retrieve the ship to preferences associated with the channel partner.
ChannelPartnerApi getChannelPartners GET /channel_partner/channel_partners Retrieve the channel partners configured on the account.
ChannelPartnerApi importChannelPartnerOrder POST /channel_partner/import Insert channel partner order
ChannelPartnerApi insertChannelPartnerShipToPreference POST /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences Insert a ship to preference record for the channel partner.
ChannelPartnerApi updateChannelPartnerShipToPreference PUT /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} Update a ship to preference record for the channel partner.
ChargebackApi deleteChargeback DELETE /chargeback/chargebacks/{chargeback_dispute_oid} Delete a chargeback
ChargebackApi getChargebackDispute GET /chargeback/chargebacks/{chargeback_dispute_oid} Retrieve a chargeback
ChargebackApi getChargebackDisputes GET /chargeback/chargebacks Retrieve chargebacks
ChargebackApi insertChargeback POST /chargeback/chargebacks Insert a chargeback
ChargebackApi updateChargeback PUT /chargeback/chargebacks/{chargeback_dispute_oid} Update a chargeback
CheckoutApi cityState POST /checkout/city_state City/State for Zip
CheckoutApi finalizeOrder POST /checkout/cart/finalizeOrder Finalize Order
CheckoutApi getAffirmCheckout GET /checkout/cart/{cart_id}/affirmCheckout Get affirm checkout (by cart id)
CheckoutApi getAllowedCountries POST /checkout/allowedCountries Allowed countries
CheckoutApi getCart GET /checkout/cart Get cart
CheckoutApi getCartByCartId GET /checkout/cart/{cart_id} Get cart (by cart id)
CheckoutApi getCartByReturnCode GET /checkout/return/{return_code} Get cart (by return code)
CheckoutApi getCartByReturnToken GET /checkout/return_token Get cart (by return token)
CheckoutApi getStateProvincesForCountry POST /checkout/stateProvincesForCountry/{country_code} Get state/province list for a country code
CheckoutApi handoffCart POST /checkout/cart/handoff Handoff cart
CheckoutApi login POST /checkout/cart/profile/login Profile login
CheckoutApi logout POST /checkout/cart/profile/logout Profile logout
CheckoutApi register POST /checkout/cart/profile/register Profile registration
CheckoutApi registerAffiliateClick POST /checkout/affiliateClick/register Register affiliate click
CheckoutApi relatedItemsForCart POST /checkout/related_items Related items
CheckoutApi relatedItemsForItem POST /checkout/relatedItems/{item_id} Related items (specific item)
CheckoutApi setupBrowserKey PUT /checkout/browser_key Setup Browser Application
CheckoutApi updateCart PUT /checkout/cart Update cart
CheckoutApi validateCart POST /checkout/cart/validate Validate
ConversationApi deleteConversationCannedMessage DELETE /conversation/canned_messages/{conversation_canned_message_oid} Delete a conversation canned message
ConversationApi deleteDepartment DELETE /conversation/departments/{conversation_department_oid} Delete a conversation department
ConversationApi deleteEngagement DELETE /conversation/engagements/{conversation_engagement_oid} Delete a conversation engagement
ConversationApi deletePbxAgentVoicemail DELETE /conversation/pbx/agent/voicemails/{recording_sid} Delete Agent Voicemail
ConversationApi deletePbxAudio DELETE /conversation/pbx/audio/{conversationPbxAudioUuid} Delete pbx audio
ConversationApi deletePbxMenu DELETE /conversation/pbx/menu/{conversationPbxMenuUuid} Delete pbx menu
ConversationApi deletePbxQueue DELETE /conversation/pbx/queue/{conversationPbxQueueUuid} Delete pbx queue
ConversationApi deletePbxQueueVoicemail DELETE /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} Delete Queue Voicemail
ConversationApi deletePbxTimeBased DELETE /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} Delete pbx timeBased
ConversationApi deletePbxTimeRange DELETE /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} Delete pbx timeRange
ConversationApi deletePbxVoicemailMailbox DELETE /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} Delete pbx voicemailMailbox
ConversationApi getAgentKeepAlive GET /conversation/agent/keepalive Agent keep alive
ConversationApi getAgentProfile GET /conversation/agent/profile Get agent profile
ConversationApi getAgentWebsocketAuthorization PUT /conversation/agent/auth Get agent websocket authorization
ConversationApi getConversation GET /conversation/conversations/{conversation_uuid} Retrieve a conversation
ConversationApi getConversationCannedMessages GET /conversation/canned_messages Retrieve a list of canned messages ordered by short_code
ConversationApi getConversationContext PUT /conversation/conversations/{conversation_uuid}/context Get a webchat conversation context
ConversationApi getConversationDepartmentMemberList GET /conversation/department_members Retrieve a list of possible department members
ConversationApi getConversationDepartments GET /conversation/departments Retrieve a list of departments ordered by name
ConversationApi getConversationEngagement GET /conversation/engagements/{conversation_engagement_oid} Retrieve an engagement
ConversationApi getConversationEngagements GET /conversation/engagements Retrieve a list of engagements ordered by name
ConversationApi getConversationMessages GET /conversation/conversations/{conversation_uuid}/messages/{since} Retrieve conversation messages
ConversationApi getConversationMultimediaUploadUrl GET /conversation/upload_url/{extension} Get a presigned conversation multimedia upload URL
ConversationApi getConversationPbxAudioUploadUrl GET /conversation/pbx/audio/upload_url/{extension} Get a pre-signed conversation multimedia upload URL
ConversationApi getConversationPbxCustomerSnapshot POST /conversation/pbx/customer_snapshot Get orders and customer information for a phone number
ConversationApi getConversationPermissions GET /conversation/permissions Retrieve conversation permissions
ConversationApi getConversationWebchatQueueStatuses GET /conversation/conversations/queues/statuses Retrieve a conversation webchat queue statuses
ConversationApi getConversations GET /conversation/conversations Retrieve a list of conversation summaries newest to oldest
ConversationApi getConversationsAutocomplete POST /conversation/conversations/autocomplete Retrieve a list of matching terms for a search field
ConversationApi getConversationsSearch POST /conversation/conversations/search Search conversations
ConversationApi getLocationsForEngagement POST /conversation/locations Get location data for engagement configuration
ConversationApi getPbxAgent GET /conversation/pbx/agent/{conversationPbxAgentUuid} Get pbx agent
ConversationApi getPbxAgentVoicemail GET /conversation/pbx/agent/voicemails/{recording_sid} Get Agent Voicemail
ConversationApi getPbxAgentVoicemails GET /conversation/pbx/agent/voicemails Get Agent Voicemails
ConversationApi getPbxAgents GET /conversation/pbx/agent Get pbx agents
ConversationApi getPbxAudio GET /conversation/pbx/audio/{conversationPbxAudioUuid} Get pbx audio
ConversationApi getPbxAudioUsage GET /conversation/pbx/audio/{conversationPbxAudioUuid}/usage Get pbx audio usage
ConversationApi getPbxAudios GET /conversation/pbx/audio Get pbx audios
ConversationApi getPbxMenu GET /conversation/pbx/menu/{conversationPbxMenuUuid} Get pbx menu
ConversationApi getPbxMenus GET /conversation/pbx/menu Get pbx menus
ConversationApi getPbxPhoneNumber GET /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} Get pbx phoneNumber
ConversationApi getPbxPhoneNumbers GET /conversation/pbx/phone_number Get pbx phoneNumbers
ConversationApi getPbxQueue GET /conversation/pbx/queue/{conversationPbxQueueUuid} Get pbx queue
ConversationApi getPbxQueueVoicemail GET /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid} Get Queue Voicemail
ConversationApi getPbxQueueVoicemails GET /conversation/pbx/queues/{queue_uuid}/voicemails Get Queue Voicemails
ConversationApi getPbxQueues GET /conversation/pbx/queue Get pbx queues
ConversationApi getPbxTimeBased GET /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} Get pbx timeBased
ConversationApi getPbxTimeBaseds GET /conversation/pbx/time_based Get pbx timeBaseds
ConversationApi getPbxTimeRange GET /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} Get pbx timeRange
ConversationApi getPbxTimeRanges GET /conversation/pbx/time_range Get pbx timeRanges
ConversationApi getPbxVoicemailMailbox GET /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} Get pbx voicemailMailbox
ConversationApi getPbxVoicemailMailboxes GET /conversation/pbx/voicemail_mailbox Get pbx voicemailMailboxes
ConversationApi insertConversationCannedMessage POST /conversation/canned_messages Insert a canned message
ConversationApi insertConversationDepartment POST /conversation/departments Insert a department
ConversationApi insertConversationEngagement POST /conversation/engagements Insert a engagement
ConversationApi insertPbxAudio POST /conversation/pbx/audio Insert pbx audio
ConversationApi insertPbxMenu POST /conversation/pbx/menu Insert pbx menu
ConversationApi insertPbxQueue POST /conversation/pbx/queue Insert pbx queue
ConversationApi insertPbxTimeBased POST /conversation/pbx/time_based Insert pbx timeBased
ConversationApi insertPbxTimeRange POST /conversation/pbx/time_range Insert pbx timeRange
ConversationApi insertPbxVoicemailMailbox POST /conversation/pbx/voicemail_mailbox Insert pbx voicemailMailbox
ConversationApi joinConversation PUT /conversation/conversations/{conversation_uuid}/join Join a conversation
ConversationApi leaveConversation DELETE /conversation/conversations/{conversation_uuid}/leave Leave a conversation
ConversationApi listenedPbxAgentVoicemail GET /conversation/pbx/agent/voicemails/{recording_sid}/listened Listened Agent Voicemail
ConversationApi listenedPbxQueueVoicemail GET /conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened Listened Queue Voicemail
ConversationApi markReadConversation PUT /conversation/conversations/{conversation_uuid}/markread Mark a conversation as read
ConversationApi resetConversationPbxQueueStatistics POST /conversation/pbx/queues/{queue_uuid}/reset_statistics reset statistics within the queue
ConversationApi searchConversationCannedMessages POST /conversation/canned_messages/search Search for canned messages by short_code
ConversationApi smsUnsubscribeConversation PUT /conversation/conversations/{conversation_uuid}/sms_unsubscribe Unsubscribe any SMS participants in this conversation
ConversationApi startConversation PUT /conversation/conversations Start a conversation
ConversationApi updateAgentProfile PUT /conversation/agent/profile Update agent profile
ConversationApi updateConversationCannedMessage PUT /conversation/canned_messages/{conversation_canned_message_oid} Update a canned message
ConversationApi updateConversationDepartment PUT /conversation/departments/{conversation_department_oid} Update a department
ConversationApi updateConversationEngagement PUT /conversation/engagements/{conversation_engagement_oid} Update a engagement
ConversationApi updateConversationWebchatQueueStatus PUT /conversation/conversations/queues/{queue_name}/status Update status within the queue
ConversationApi updatePbxAgent PUT /conversation/pbx/agent/{conversationPbxAgentUuid} Update pbx agent
ConversationApi updatePbxAudio PUT /conversation/pbx/audio/{conversationPbxAudioUuid} Update pbx audio
ConversationApi updatePbxMenu PUT /conversation/pbx/menu/{conversationPbxMenuUuid} Update pbx menu
ConversationApi updatePbxPhoneNumber PUT /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} Update pbx phoneNumber
ConversationApi updatePbxQueue PUT /conversation/pbx/queue/{conversationPbxQueueUuid} Update pbx queue
ConversationApi updatePbxTimeBased PUT /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} Update pbx timeBased
ConversationApi updatePbxTimeRange PUT /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} Update pbx timeRange
ConversationApi updatePbxVoicemailMailbox PUT /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} Update pbx voicemailMailbox
CouponApi deleteCoupon DELETE /coupon/coupons/{coupon_oid} Delete a coupon
CouponApi deleteCouponsByCode DELETE /coupon/coupons/by_code Deletes multiple coupons
CouponApi deleteCouponsByOid DELETE /coupon/coupons/by_oid Deletes multiple coupons
CouponApi doesCouponCodeExist GET /coupon/coupons/merchant_code/{merchant_code}/exists Determines if a coupon merchant code already exists
CouponApi generateCouponCodes POST /coupon/coupons/{coupon_oid}/generate_codes Generates one time codes for a coupon
CouponApi generateOneTimeCodesByMerchantCode POST /coupon/coupons/merchant_code/{merchant_code}/generate_codes Generates one time codes by merchant code
CouponApi getAutoApply GET /coupon/auto_apply Retrieve auto apply rules and conditions
CouponApi getCoupon GET /coupon/coupons/{coupon_oid} Retrieve a coupon
CouponApi getCouponByMerchantCode GET /coupon/coupons/merchant_code/{merchant_code} Retrieve a coupon by merchant code
CouponApi getCoupons GET /coupon/coupons Retrieve coupons
CouponApi getCouponsByQuery POST /coupon/coupons/query Retrieve coupons by query
CouponApi getEditorValues GET /coupon/editor_values Retrieve values needed for a coupon editor
CouponApi insertCoupon POST /coupon/coupons Insert a coupon
CouponApi insertCoupons POST /coupon/coupons/batch Insert multiple coupons
CouponApi searchItems GET /coupon/searchItems Searches for items to display within a coupon editor and assign to coupons
CouponApi updateAutoApply POST /coupon/auto_apply Update auto apply rules and conditions
CouponApi updateCoupon PUT /coupon/coupons/{coupon_oid} Update a coupon
CouponApi updateCoupons PUT /coupon/coupons/batch Update multiple coupons
CouponApi uploadCouponCodes POST /coupon/coupons/{coupon_oid}/upload_codes Upload one-time codes for a coupon
CustomerApi addCustomerStoreCredit POST /customer/customers/{customer_profile_oid}/store_credit Adds store credit to a customer
CustomerApi adjustInternalCertificate POST /customer/customers/{customer_profile_oid}/adjust_cashback_balance Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
CustomerApi deleteCustomer DELETE /customer/customers/{customer_profile_oid} Delete a customer
CustomerApi deleteWishListItem DELETE /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} Delete a customer wishlist item
CustomerApi getCustomer GET /customer/customers/{customer_profile_oid} Retrieve a customer
CustomerApi getCustomerByEmail GET /customer/customers/by_email/{email} Retrieve a customer by Email
CustomerApi getCustomerEditorValues GET /customer/editor_values Retrieve values needed for a customer profile editor
CustomerApi getCustomerEmailLists GET /customer/email_lists Retrieve all email lists across all storefronts
CustomerApi getCustomerStoreCredit GET /customer/customers/{customer_profile_oid}/store_credit Retrieve the customer store credit accumulated through loyalty programs
CustomerApi getCustomerWishList GET /customer/customers/{customer_profile_oid}/wishlist Retrieve wishlist items for customer
CustomerApi getCustomerWishListItem GET /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} Retrieve wishlist item for customer
CustomerApi getCustomers GET /customer/customers Retrieve customers
CustomerApi getCustomersByQuery POST /customer/customers/query Retrieve customers by query
CustomerApi getCustomersForDataTables POST /customer/customers/dataTables Retrieve customers for DataTables plugin
CustomerApi getEmailVerificationToken POST /customer/customers/email_verify/get_token Create a token that can be used to verify a customer email address
CustomerApi getMagicLink PUT /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} getMagicLink
CustomerApi insertCustomer POST /customer/customers Insert a customer
CustomerApi insertWishListItem POST /customer/customers/{customer_profile_oid}/wishlist Insert a customer wishlist item
CustomerApi mergeCustomer PUT /customer/customers/{customer_profile_oid}/merge Merge customer into this customer
CustomerApi searchCustomerProfileValues POST /customer/search Searches for all matching values (using POST)
CustomerApi updateCustomer PUT /customer/customers/{customer_profile_oid} Update a customer
CustomerApi updateCustomerEmailLists POST /customer/customers/{customer_profile_oid}/email_lists Update email list subscriptions for a customer
CustomerApi updateWishListItem PUT /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} Update a customer wishlist item
CustomerApi validateEmailVerificationToken POST /customer/customers/email_verify/validate_token Validate a token that can be used to verify a customer email address
DatawarehouseApi deleteReport DELETE /datawarehouse/reports/{report_oid} Delete a report
DatawarehouseApi dryRunReportQueries PUT /datawarehouse/reports/dryrun Dry run the report queries
DatawarehouseApi executeReportQueries PUT /datawarehouse/reports/execute Execute the report queries
DatawarehouseApi getReport GET /datawarehouse/reports/{report_oid} Get a report
DatawarehouseApi getReportDataSet GET /datawarehouse/reports/dataset/{dataset_uuid} Get a report data set
DatawarehouseApi getReportDataSetPage GET /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} Get a report data set page
DatawarehouseApi getReportWebsocketAuthorization PUT /datawarehouse/reports/auth Get report websocket authorization
DatawarehouseApi getReports GET /datawarehouse/reports Get list of reports available
DatawarehouseApi insertReport POST /datawarehouse/reports Create a report
DatawarehouseApi updateReport PUT /datawarehouse/reports/{report_oid} Update a report
FulfillmentApi acknowledgeOrders PUT /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements Acknowledge receipt of orders.
FulfillmentApi generatePackingSlip GET /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} Generate a packing slip for this order for the given distribution center.
FulfillmentApi getDistributionCenterOrders GET /fulfillment/distribution_centers/{distribution_center_code}/orders Retrieve orders queued up for this distribution center.
FulfillmentApi getDistributionCenters GET /fulfillment/distribution_centers Retrieve distribution centers
FulfillmentApi shipOrders POST /fulfillment/distribution_centers/{distribution_center_code}/shipments Mark orders as shipped
FulfillmentApi updateInventory POST /fulfillment/distribution_centers/{distribution_center_code}/inventory Update inventory
GiftCertificateApi addGiftCertificateLedgerEntry POST /gift_certificate/gift_certificates/{gift_certificate_oid}/ledger_entry Add a gift certificate ledger entry
GiftCertificateApi createGiftCertificate POST /gift_certificate/gift_certificates Create a gift certificate
GiftCertificateApi deleteGiftCertificate DELETE /gift_certificate/gift_certificates/{gift_certificate_oid} Delete a gift certificate
GiftCertificateApi getGiftCertificateByCode POST /gift_certificate/gift_certificates/by_code/{code} Retrieve gift certificate by code
GiftCertificateApi getGiftCertificateByOid POST /gift_certificate/gift_certificates/{gift_certificate_oid} Retrieve gift certificate by oid
GiftCertificateApi getGiftCertificatesByEmail POST /gift_certificate/gift_certificates/by_email/{email} Retrieve gift certificate by email
GiftCertificateApi getGiftCertificatesByQuery POST /gift_certificate/gift_certificates/query Retrieve gift certificates by query
GiftCertificateApi updateGiftCertificate PUT /gift_certificate/gift_certificates/{gift_certificate_oid} Update a gift certificate
IntegrationLogApi getIntegrationLog GET /integration_log/query/{pk}/{sk} Retrieve an integration log
IntegrationLogApi getIntegrationLogFile GET /integration_log/query/{pk}/{sk}/{uuid} Retrieve an integration log file
IntegrationLogApi getIntegrationLogFilePdf GET /integration_log/query/{pk}/{sk}/{uuid}/pdf Retrieve an integration log file converted to PDF
IntegrationLogApi getIntegrationLogSummariesQuery POST /integration_log/summary/query Retrieve integration log summaries
IntegrationLogApi getIntegrationLogsQuery POST /integration_log/query Retrieve integration logs
ItemApi deleteDigitalItem DELETE /item/digital_library/{digital_item_oid} Delete a digital item, which is a file within the digital library, not an actual merchant item
ItemApi deleteItem DELETE /item/items/{merchant_item_oid} Delete an item
ItemApi deleteReview DELETE /item/items/{merchant_item_oid}/reviews/{review_oid} Delete a review
ItemApi getDigitalItem GET /item/digital_library/{digital_item_oid} Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
ItemApi getDigitalItems GET /item/digital_library Retrieve digital items from the digital library which are digital files that may be attached to normal items
ItemApi getDigitalItemsByExternalId GET /item/digital_library/by_external/{external_id} Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
ItemApi getItem GET /item/items/{merchant_item_oid} Retrieve an item
ItemApi getItemByMerchantItemId GET /item/items/merchant_item_id/{merchant_item_id} Retrieve an item by item id
ItemApi getItems GET /item/items Retrieve items
ItemApi getPricingTiers GET /item/pricing_tiers Retrieve pricing tiers
ItemApi getReview GET /item/items/{merchant_item_oid}/reviews/{review_oid} Get a review
ItemApi getReviews GET /item/items/{merchant_item_oid}/reviews Get reviews for an item
ItemApi getUnassociatedDigitalItems GET /item/digital_library/unassociated Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
ItemApi insertDigitalItem POST /item/digital_library Create a file within the digital library
ItemApi insertItem POST /item/items Create an item
ItemApi insertReview POST /item/items/{merchant_item_oid}/reviews Insert a review
ItemApi insertUpdateItemContentAttribute POST /item/items/{merchant_item_oid}/content/attributes Upsert an item content attribute
ItemApi restItemInventorySnapshotResponse GET /item/items/inventory_snapshot Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
ItemApi updateDigitalItem PUT /item/digital_library/{digital_item_oid} Updates a file within the digital library
ItemApi updateItem PUT /item/items/{merchant_item_oid} Update an item
ItemApi updateItems PUT /item/items/batch Update multiple items
ItemApi updateReview PUT /item/items/{merchant_item_oid}/reviews/{review_oid} Update a review
ItemApi uploadTemporaryMultimedia POST /item/temp_multimedia Upload an image to the temporary multimedia.
OauthApi oauthAccessToken POST /oauth/token Exchange authorization code for access token.
OauthApi oauthRevoke POST /oauth/revoke Revoke this OAuth application.
OrderApi adjustOrderTotal POST /order/orders/{order_id}/adjust_order_total/{desired_total} Adjusts an order total
OrderApi cancelOrder POST /order/orders/{order_id}/cancel Cancel an order
OrderApi deleteOrder DELETE /order/orders/{order_id} Delete an order
OrderApi duplicateOrder POST /order/orders/{order_id}/duplicate Duplicate an order
OrderApi format POST /order/orders/{order_id}/format Format order
OrderApi generateInvoice GET /order/orders/{order_id}/invoice Generate an invoice for this order.
OrderApi generateOrderToken GET /order/orders/token/{order_id} Generate an order token for a given order id
OrderApi generatePackingSlipAllDC GET /order/orders/{order_id}/packing_slip Generate a packing slip for this order across all distribution centers.
OrderApi generatePackingSlipSpecificDC GET /order/orders/{order_id}/packing_slip/{distribution_center_code} Generate a packing slip for this order for the given distribution center.
OrderApi getAccountsReceivableRetryConfig GET /order/accountsReceivableRetryConfig Retrieve A/R Retry Configuration
OrderApi getAccountsReceivableRetryStats GET /order/accountsReceivableRetryConfig/stats Retrieve A/R Retry Statistics
OrderApi getOrder GET /order/orders/{order_id} Retrieve an order
OrderApi getOrderByToken POST /order/orders/token Retrieve an order using a token
OrderApi getOrderEdiDocuments GET /order/orders/{order_id}/edi Retrieve EDI documents associated with this order.
OrderApi getOrders GET /order/orders Retrieve orders
OrderApi getOrdersBatch POST /order/orders/batch Retrieve order batch
OrderApi getOrdersByQuery POST /order/orders/query Retrieve orders by query
OrderApi insertOrder POST /order/orders Insert an order
OrderApi isRefundableOrder GET /order/orders/{order_id}/refundable Determine if an order can be refunded
OrderApi processPayment POST /order/orders/{order_id}/process_payment Process payment
OrderApi refundOrder PUT /order/orders/{order_id}/refund Refund an order
OrderApi replacement POST /order/orders/{order_id}/replacement Replacement order
OrderApi resendReceipt POST /order/orders/{order_id}/resend_receipt Resend receipt
OrderApi resendShipmentConfirmation POST /order/orders/{order_id}/resend_shipment_confirmation Resend shipment confirmation
OrderApi updateAccountsReceivableRetryConfig POST /order/accountsReceivableRetryConfig Update A/R Retry Configuration
OrderApi updateOrder PUT /order/orders/{order_id} Update an order
OrderApi validateOrder POST /order/validate Validate
SsoApi getSsoSessionUser GET /sso/session/user Get single sign on session user
SsoApi ssoAuthorize PUT /sso/authorize Authorize a single sign on session
SsoApi ssoSessionRevoke DELETE /sso/session/revoke Revoke single sign on session
SsoApi ssoToken PUT /sso/token Exchange a single sign on code for a simple key token
StorefrontApi addToLibrary POST /storefront/code_library Add to library
StorefrontApi applyToStoreFront POST /storefront/code_library/apply Apply library item to storefront.
StorefrontApi archiveEmailList POST /storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive Archive email list
StorefrontApi archiveEmailSegment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/archive Archive email segment
StorefrontApi backPopulateEmailFlow POST /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/backfill Back populate email flow
StorefrontApi checkDownloadEmailSegment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid} Check download of email segment
StorefrontApi cloneEmailCampaign POST /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone Clone email campaign
StorefrontApi cloneEmailFlow POST /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone Clone email flow
StorefrontApi createEmailSendingDomain POST /storefront/email/sending_domains/{domain}/create Create email campaign
StorefrontApi createEmailSendingDomain2 POST /storefront/email/sending_domains Create email sending domain for various providers
StorefrontApi createFsDirectory POST /storefront/{id}/fs/dir Create file manager directory
StorefrontApi createTwilioAccount POST /storefront/twilio/accounts Create Twilio account
StorefrontApi deleteEmailCampaignFolder DELETE /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Delete email campaignFolder
StorefrontApi deleteEmailCommseqStat DELETE /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat Delete communication sequence stats
StorefrontApi deleteEmailEmail DELETE /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Delete email email
StorefrontApi deleteEmailFlowFolder DELETE /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Delete email flowFolder
StorefrontApi deleteEmailListCustomer DELETE /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid} Delete email list customer
StorefrontApi deleteEmailListSegmentFolder DELETE /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} Delete email ListSegmentFolder
StorefrontApi deleteEmailPostcard DELETE /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Delete email postcard
StorefrontApi deleteEmailSendingDomain DELETE /storefront/email/sending_domains/{domain} delete email campaign
StorefrontApi deleteExperiment DELETE /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} Delete experiment
StorefrontApi deleteFsFile DELETE /storefront/{id}/fs/file Delete file manager directory
StorefrontApi deleteHeatmap DELETE /storefront/{storefront_oid}/screen_recordings/heatmap Delete screen recording heatmap
StorefrontApi deleteLibraryItem DELETE /storefront/code_library/{library_item_oid} Delete library item
StorefrontApi deleteLibraryItemPublishedVersions DELETE /storefront/code_library/{library_item_oid}/published_versions Delete all published versions for a library item, including anything in review.
StorefrontApi deleteScreenRecordingSegment DELETE /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Delete screen recording segment
StorefrontApi deleteTwilioAccount DELETE /storefront/twilio/accounts/{esp_twilio_uuid} delete Twilio account
StorefrontApi duplicateLibraryItem POST /storefront/code_library/{library_item_oid}/duplicate Duplicate library item.
StorefrontApi favoriteScreenRecording POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite Update favorite flag on screen recording
StorefrontApi geocodeAddress POST /storefront/{storefront_oid}/email/geocode Obtain lat/long for an address
StorefrontApi getCountries GET /storefront/{storefront_oid}/email/countries Get countries
StorefrontApi getEditorToken GET /storefront/{storefront_oid}/editor_token Gets editor token
StorefrontApi getEmailBaseTemplates GET /storefront/{storefront_oid}/email/baseTemplates Get email communication base templates
StorefrontApi getEmailCampaign GET /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} Get email campaign
StorefrontApi getEmailCampaignFolder GET /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Get email campaign folder
StorefrontApi getEmailCampaignFolders GET /storefront/{storefront_oid}/email/campaign_folders Get email campaign folders
StorefrontApi getEmailCampaignScreenshots GET /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/screenshots Get email campaign screenshots
StorefrontApi getEmailCampaigns GET /storefront/{storefront_oid}/email/campaigns Get email campaigns
StorefrontApi getEmailCampaignsWithStats GET /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} Get email campaigns with stats
StorefrontApi getEmailCommseq GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} Get email commseq
StorefrontApi getEmailCommseqEmailStats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats Get email communication sequence emails stats
StorefrontApi getEmailCommseqPostcardStats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats Get email communication sequence postcard stats
StorefrontApi getEmailCommseqPostcardTracking GET /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking Get email communication postcard tracking
StorefrontApi getEmailCommseqRateLimiters GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters Get email commseq rate limiters
StorefrontApi getEmailCommseqSmsStats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats Get email communication sequence sms stats
StorefrontApi getEmailCommseqStatOverall GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat Get communication sequence stats overall
StorefrontApi getEmailCommseqStepStats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats Get email communication sequence step stats
StorefrontApi getEmailCommseqStepWaiting POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting Get email communication sequence customers waiting at each requested step
StorefrontApi getEmailCommseqWebhookEditorValues GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues Get email webhook editor values
StorefrontApi getEmailCommseqs GET /storefront/{storefront_oid}/email/commseqs Get email commseqs
StorefrontApi getEmailCustomerEditorUrl GET /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url Get customers editor URL
StorefrontApi getEmailCustomers GET /storefront/{storefront_oid}/email/customers Get email customers
StorefrontApi getEmailDashboardActivity GET /storefront/{storefront_oid}/email/dashboard_activity Get email dashboard activity
StorefrontApi getEmailDashboardStats GET /storefront/{storefront_oid}/email/dashboard_stats Get dashboard stats
StorefrontApi getEmailDispatchLogs GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs Get email dispatch logs
StorefrontApi getEmailEmail GET /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Get email email
StorefrontApi getEmailEmailClicks GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks Get email email clicks
StorefrontApi getEmailEmailCustomerEditorUrl GET /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url Get email order customer editor url
StorefrontApi getEmailEmailOrders GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/orders Get email email orders
StorefrontApi getEmailEmails GET /storefront/{storefront_oid}/email/emails Get email emails
StorefrontApi getEmailEmailsMultiple POST /storefront/{storefront_oid}/email/emails/multiple Get email emails multiple
StorefrontApi getEmailFlow GET /storefront/{storefront_oid}/email/flows/{email_flow_uuid} Get email flow
StorefrontApi getEmailFlowFolder GET /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Get email flow folder
StorefrontApi getEmailFlowFolders GET /storefront/{storefront_oid}/email/flow_folders Get email flow folders
StorefrontApi getEmailFlowScreenshots GET /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/screenshots Get email flow screenshots
StorefrontApi getEmailFlows GET /storefront/{storefront_oid}/email/flows Get email flows
StorefrontApi getEmailGlobalSettings GET /storefront/email/global_settings Get email globalsettings
StorefrontApi getEmailList GET /storefront/{storefront_oid}/email/lists/{email_list_uuid} Get email list
StorefrontApi getEmailListCustomerEditorUrl GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url Get email list customer editor url
StorefrontApi getEmailListCustomers GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers Get email list customers
StorefrontApi getEmailListSegmentFolder GET /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} Get email campaign folder
StorefrontApi getEmailListSegmentFolders GET /storefront/{storefront_oid}/email/list_segment_folders Get email campaign folders
StorefrontApi getEmailLists GET /storefront/{storefront_oid}/email/lists Get email lists
StorefrontApi getEmailPerformance GET /storefront/{storefront_oid}/email/performance Get email performance
StorefrontApi getEmailPlan GET /storefront/{storefront_oid}/email/plan Get email plan
StorefrontApi getEmailPostcard GET /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Get email postcard
StorefrontApi getEmailPostcards GET /storefront/{storefront_oid}/email/postcards Get email postcards
StorefrontApi getEmailPostcardsMultiple POST /storefront/{storefront_oid}/email/postcards/multiple Get email postcards multiple
StorefrontApi getEmailSegment GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid} Get email segment
StorefrontApi getEmailSegmentCustomerEditorUrl GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url Get email segment customers editor URL
StorefrontApi getEmailSegmentCustomers GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers Get email segment customers
StorefrontApi getEmailSegments GET /storefront/{storefront_oid}/email/segments Get email segments
StorefrontApi getEmailSendingDomain GET /storefront/email/sending_domain/{domain} Get email sending domain
StorefrontApi getEmailSendingDomainStatus POST /storefront/email/sending_domains/{domain}/status Get email sending domain status
StorefrontApi getEmailSendingDomains GET /storefront/email/sending_domains Get email sending domains
StorefrontApi getEmailSettings GET /storefront/{storefront_oid}/email/settings Get email settings
StorefrontApi getEmailSmsOrders GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders Get email sms orders
StorefrontApi getEmailTemplate GET /storefront/{storefront_oid}/email/templates/{email_template_oid} Get email template
StorefrontApi getEmailTemplates GET /storefront/{storefront_oid}/email/templates Get email templates
StorefrontApi getEmailThirdPartyProviders GET /storefront/{storefront_oid}/email/third_party_providers Get a list of third party email providers
StorefrontApi getExperiments GET /storefront/{storefront_oid}/experiments Get experiments
StorefrontApi getFsDirectory GET /storefront/{id}/fs/dir Get file manager directory
StorefrontApi getHeatmap POST /storefront/{storefront_oid}/screen_recordings/heatmap Get screen recording heatmap
StorefrontApi getHeatmapIndex POST /storefront/{storefront_oid}/screen_recordings/heatmap/index Get screen recording heatmap index
StorefrontApi getHistogramPropertyNames GET /storefront/{storefront_oid}/email/histogram/property_names Get histogram property names
StorefrontApi getHistogramPropertyValues GET /storefront/{storefront_oid}/email/histogram/property_values Get histogram property values
StorefrontApi getLibraryFilterValues GET /storefront/code_library/filter_values Get library values used to populate drop down boxes for filtering.
StorefrontApi getLibraryItem GET /storefront/code_library/{library_item_oid} Get library item.
StorefrontApi getLibraryItemPublishedVersions GET /storefront/code_library/{library_item_oid}/published_versions Get all published versions for a library item.
StorefrontApi getScreenRecording GET /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid} Get screen recording
StorefrontApi getScreenRecordingPageViewData GET /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/page_view_data/{screen_recording_page_view_uuid} Get screen recording page view data
StorefrontApi getScreenRecordingSegment GET /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Get screen recording segment
StorefrontApi getScreenRecordingSegments GET /storefront/{storefront_oid}/screen_recordings/segments Get screen recording segments
StorefrontApi getScreenRecordingSettings GET /storefront/{storefront_oid}/screen_recordings/settings Get screen recording settings
StorefrontApi getScreenRecordingTags POST /storefront/{storefront_oid}/screen_recordings/tags Get tags used by screen recording
StorefrontApi getScreenRecordingsByQuery POST /storefront/{storefront_oid}/screen_recordings/query Query screen recordings
StorefrontApi getScreenRecordingsBySegment POST /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query Get screen recordings by segment
StorefrontApi getStoreFrontPricingTiers GET /storefront/pricing_tiers Retrieve pricing tiers
StorefrontApi getStoreFronts GET /storefront Get storefronts (internal use only for security reasons)
StorefrontApi getThumbnailParameters POST /storefront/thumbnailParameters Get thumbnail parameters
StorefrontApi getTransactionEmail GET /storefront/{storefront_oid}/transaction_email/list/{email_id} Gets a transaction email object
StorefrontApi getTransactionEmailList GET /storefront/{storefront_oid}/transaction_email/list Gets a list of transaction email names
StorefrontApi getTransactionEmailScreenshots GET /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots Get transactional email screenshots
StorefrontApi getTwilioAccount GET /storefront/twilio/accounts/{esp_twilio_uuid} Get Twilio account
StorefrontApi getTwilioAccounts GET /storefront/twilio/accounts Get all Twilio accounts
StorefrontApi getUploadFsFileUrl GET /storefront/{id}/fs/upload_url/{extension} Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
StorefrontApi globalUnsubscribe POST /storefront/{storefront_oid}/email/globalUnsubscribe Globally unsubscribe a customer
StorefrontApi importEmailThirdPartyProviderList POST /storefront/{storefront_oid}/email/third_party_providers/import Import a third party provider list
StorefrontApi insertEmailCampaign POST /storefront/{storefront_oid}/email/campaigns Insert email campaign
StorefrontApi insertEmailCampaignFolder POST /storefront/{storefront_oid}/email/campaign_folders Insert email campaign folder
StorefrontApi insertEmailCommseq POST /storefront/{storefront_oid}/email/commseqs Insert email commseq
StorefrontApi insertEmailEmail POST /storefront/{storefront_oid}/email/emails Insert email email
StorefrontApi insertEmailFlow POST /storefront/{storefront_oid}/email/flows Insert email flow
StorefrontApi insertEmailFlowFolder POST /storefront/{storefront_oid}/email/flow_folders Insert email flow folder
StorefrontApi insertEmailList POST /storefront/{storefront_oid}/email/lists Insert email list
StorefrontApi insertEmailListSegmentFolder POST /storefront/{storefront_oid}/email/list_segment_folders Insert email campaign folder
StorefrontApi insertEmailPostcard POST /storefront/{storefront_oid}/email/postcards Insert email postcard
StorefrontApi insertEmailSegment POST /storefront/{storefront_oid}/email/segments Insert email segment
StorefrontApi insertScreenRecordingSegment POST /storefront/{storefront_oid}/screen_recordings/segments Insert screen recording segment
StorefrontApi prepareDownloadEmailSegment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare Prepare download of email segment
StorefrontApi publishLibraryItem POST /storefront/code_library/{library_item_oid}/publish Publish library item.
StorefrontApi purchaseLibraryItem POST /storefront/code_library/{library_item_oid}/purchase Purchase public library item, which creates a copy of the item in your personal code library
StorefrontApi releaseEmailCommseqStepWaiting POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid} Release email communication sequence customers waiting at the specified step
StorefrontApi resetEmailCommseqRateLimiters DELETE /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters Reset email commseq rate limiters (only callable by UltraCart Support)
StorefrontApi review POST /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review Request a review of an email
StorefrontApi search GET /storefront/search Searches for all matching values
StorefrontApi search2 POST /storefront/search Searches for all matching values (using POST)
StorefrontApi searchEmailListCustomers GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/search Search email list customers
StorefrontApi searchEmailSegmentCustomers GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/search Search email segment customers
StorefrontApi searchLibraryItems POST /storefront/code_library/search Retrieve library items
StorefrontApi searchPublishedItems POST /storefront/code_library/search_published Retrieve library items
StorefrontApi searchReviewItems POST /storefront/code_library/search_review Retrieve library items needing review or rejected
StorefrontApi searchSharedItems POST /storefront/code_library/search_shared Retrieve library items
StorefrontApi sendEmailTest POST /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test Send email test
StorefrontApi sendPostcardTest POST /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test Send postcard test
StorefrontApi sendSmsTest POST /storefront/{storefront_oid}/email/sms/{commseq_uuid}/{commseq_step_uuid}/test Send SMS test
StorefrontApi sendWebhookTest POST /storefront/{storefront_oid}/email/webhooks/test Send webhook test
StorefrontApi sequenceTest POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test Sequence test
StorefrontApi startEmailCampaign PUT /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start Start email campaign
StorefrontApi subscribeToEmailList POST /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe Subscribe customers to email list
StorefrontApi sunsetEmailSegment PUT /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset Sunset email segment
StorefrontApi unfavoriteScreenRecording DELETE /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite Remove favorite flag on screen recording
StorefrontApi updateEmailCampaign PUT /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} Update email campaign
StorefrontApi updateEmailCampaignFolder PUT /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Update email campaign folder
StorefrontApi updateEmailCommseq PUT /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} Update email commseq
StorefrontApi updateEmailCustomer PUT /storefront/{storefront_oid}/email/customers/{email_customer_uuid} Update email customer
StorefrontApi updateEmailEmail PUT /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Update email email
StorefrontApi updateEmailFlow PUT /storefront/{storefront_oid}/email/flows/{email_flow_uuid} Update email flow
StorefrontApi updateEmailFlowFolder PUT /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Update email flow folder
StorefrontApi updateEmailGlobalSettings POST /storefront/email/global_settings Update email global settings
StorefrontApi updateEmailList PUT /storefront/{storefront_oid}/email/lists/{email_list_uuid} Update email list
StorefrontApi updateEmailListSegmentFolder PUT /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} Update email campaign folder
StorefrontApi updateEmailPlan POST /storefront/{storefront_oid}/email/plan Update email plan
StorefrontApi updateEmailPostcard PUT /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Update email postcard
StorefrontApi updateEmailSegment PUT /storefront/{storefront_oid}/email/segments/{email_segment_uuid} Update email segment
StorefrontApi updateEmailSendingDomain PUT /storefront/email/sending_domains/{domain} Update email sending domain
StorefrontApi updateEmailSettings POST /storefront/{storefront_oid}/email/settings Update email settings
StorefrontApi updateExperiment PUT /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} Update experiment
StorefrontApi updateLibraryItem PUT /storefront/code_library/{library_item_oid} Update library item. Note that only certain fields may be updated via this method.
StorefrontApi updateScreenRecordingMerchantNotes POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes Update merchant notes on a screen recording
StorefrontApi updateScreenRecordingSegment POST /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Update screen recording segment
StorefrontApi updateScreenRecordingSettings POST /storefront/{storefront_oid}/screen_recordings/settings Update screen recording settings
StorefrontApi updateScreenRecordingTags POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags Update tags on a screen recording
StorefrontApi updateTransactionEmail PUT /storefront/{storefront_oid}/transaction_email/list/{email_id} Updates a transaction email object
StorefrontApi updateTwilioAccount PUT /storefront/twilio/accounts/{esp_twilio_uuid} Update Twilio account
StorefrontApi uploadFsFile POST /storefront/{id}/fs/upload This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
StorefrontApi validateRuler POST /storefront/ruler/validate Validate AWS Event Ruler
TaxApi deleteTaxProviderSelfCity DELETE /tax/providers/self/city/{city} Deletes a Self tax provider city
TaxApi deleteTaxProviderSelfCountry DELETE /tax/providers/self/country/{countryCode} Deletes a Self tax provider country
TaxApi deleteTaxProviderSelfCounty DELETE /tax/providers/self/county/{county} Deletes a Self tax provider county
TaxApi deleteTaxProviderSelfPostalCode DELETE /tax/providers/self/postalCode/{postal_code} Deletes a Self tax provider postalCode
TaxApi deleteTaxProviderSelfState DELETE /tax/providers/self/state/{stateCode} Deletes a Self tax provider state
TaxApi getTaxProviderAvalara GET /tax/providers/avalara Retrieve the Avalara tax provider
TaxApi getTaxProviderAvalaraCompanies POST /tax/providers/avalara/companies Returns Avalara Tax companies configured by the merchant
TaxApi getTaxProviderAvalaraTest GET /tax/providers/avalara/test Attempts to connect to Avalara and returns back the response
TaxApi getTaxProviderSelf GET /tax/providers/self Retrieve the Self tax provider
TaxApi getTaxProviderSelfCountries GET /tax/providers/self/countries Retrieve the Self tax provider countries
TaxApi getTaxProviderSelfRegionsByCountryCode GET /tax/providers/self/regions/{countryCode} Retrieve the Self tax provider regions for a given country code
TaxApi getTaxProviderSovos GET /tax/providers/sovos Retrieve the Sovos tax provider
TaxApi getTaxProviderSovosTest GET /tax/providers/sovos/test Attempts to connect to Sovos and returns back the response
TaxApi getTaxProviderTaxJar GET /tax/providers/taxjar Retrieve the TaxJar tax provider
TaxApi getTaxProviderTaxJarTest GET /tax/providers/taxjar/test Attempts to connect to TaxJar and returns back the response
TaxApi getTaxProviderUltraCart GET /tax/providers/ultracart Retrieve the UltraCart tax provider
TaxApi getTaxProviders GET /tax/providers Retrieve tax methods
TaxApi setActiveTaxProvider POST /tax/providers/setActive/{providerName} Toggle a tax provider to active
TaxApi updateTaxProviderAvalara POST /tax/providers/avalara Update the Avalara tax provider
TaxApi updateTaxProviderSelf POST /tax/providers/self Update the Self tax provider
TaxApi updateTaxProviderSelfCity POST /tax/providers/self/city/{city} Updates a Self tax provider city
TaxApi updateTaxProviderSelfCountry POST /tax/providers/self/country/{countryCode} Updates a Self tax provider country
TaxApi updateTaxProviderSelfCounty POST /tax/providers/self/county/{county} Updates a Self tax provider county
TaxApi updateTaxProviderSelfPostalCode POST /tax/providers/self/postalCode/{postal_code} Updates a Self tax provider postalCode
TaxApi updateTaxProviderSelfState POST /tax/providers/self/state/{stateCode} Updates a Self tax provider state
TaxApi updateTaxProviderSovos POST /tax/providers/sovos Update the Sovos tax provider
TaxApi updateTaxProviderTaxJar POST /tax/providers/taxjar Update the TaxJar tax provider
TaxApi updateTaxProviderUltraCart POST /tax/providers/ultracart Update the UltraCart tax provider
UserApi deleteGroup DELETE /user/groups/{group_oid} Delete a group
UserApi deleteUser DELETE /user/users/{user_id} Delete a user
UserApi getGroup GET /user/groups/{group_oid} Retrieve a group
UserApi getGroups GET /user/groups Get groups
UserApi getUser GET /user/users/{user_id} Retrieve a user
UserApi getUserLogins GET /user/users/{user_id}/logins Retrieve a user's login history
UserApi getUsers GET /user/users Get users
UserApi insertGroup POST /user/groups Insert a group
UserApi insertUser POST /user/users Insert a user
UserApi updateGroup PUT /user/groups/{group_oid} Update a group
UserApi updateUser PUT /user/users/{user_id} Update a user
WebhookApi deleteWebhook DELETE /webhook/webhooks/{webhookOid} Delete a webhook
WebhookApi deleteWebhookByUrl DELETE /webhook/webhooks Delete a webhook by URL
WebhookApi getWebhookLog GET /webhook/webhooks/{webhookOid}/logs/{requestId} Retrieve an individual log
WebhookApi getWebhookLogSummaries GET /webhook/webhooks/{webhookOid}/logs Retrieve the log summaries
WebhookApi getWebhooks GET /webhook/webhooks Retrieve webhooks
WebhookApi insertWebhook POST /webhook/webhooks Add a webhook
WebhookApi resendEvent POST /webhook/webhooks/{webhookOid}/reflow/{eventName} Resend events to the webhook endpoint.
WebhookApi updateWebhook PUT /webhook/webhooks/{webhookOid} Update a webhook
WorkflowApi getWorkflowAgentWebsocketAuthorization PUT /workflow/agent/auth Get agent websocket authorization
WorkflowApi getWorkflowAssignmentGroups GET /workflow/assignment_groups Retrieve a list of groups that workflow tasks can be assigned to
WorkflowApi getWorkflowAssignmentUsers GET /workflow/assignment_users Retrieve a list of users that workflow tasks can be assigned to
WorkflowApi getWorkflowMe GET /workflow/me Retrieve a user object for myself
WorkflowApi getWorkflowTask GET /workflow/tasks/{task_uuid} Retrieve a workflow task
WorkflowApi getWorkflowTaskAttachmentUploadUrl GET /workflow/tasks/attachments/{extension} Get a presigned workflow task attachment upload URL
WorkflowApi getWorkflowTaskByObjectType GET /workflow/tasks/by/{object_type}/{object_id} Retrieve a workflow task by object type and id
WorkflowApi getWorkflowTaskOpenCount GET /workflow/tasks/open_count Retrieve workflow task open count
WorkflowApi getWorkflowTaskTags GET /workflow/tasks/tags Get a list of existing workflow task tags
WorkflowApi getWorkflowTasks POST /workflow/tasks/search Search workflow tasks
WorkflowApi insertWorkflowTask POST /workflow/tasks Insert a workflow task
WorkflowApi updateWorkflowTask PUT /workflow/tasks/{task_uuid} Update a workflow task

Documentation For Models