Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ultra_cart_rest_api_v2

UltraCartRestApiV2 - JavaScript client for ultra_cart_rest_api_v2 UltraCart REST API Version 2 This SDK is automatically generated by the Swagger Codegen project:

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

Installation

For Node.js

npm

To install this SDK in your project, execute the following command:

npm install ultra_cart_rest_api_v2 --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your ultra_cart_rest_api_v2 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('ultra_cart_rest_api_v2') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/UltraCart/rest_api_v2_sdk_javascript then install it via:

    npm install UltraCart/rest_api_v2_sdk_javascript --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');



// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)

var api = new UltraCartRestApiV2.AffiliateApi()

var click_query = new UltraCartRestApiV2.AffiliateClickQuery(); // {AffiliateClickQuery} Click query

var opts = { 
  '_limit': 10000, // {Number} The maximum number of records to return on this one API call. (Maximum 10000)
  '_offset': 0, // {Number} Pagination of the record set.  Offset is a zero based index.
  '_expand': "_expand_example" // {String} The object expansion to perform on the result.  Only option is link.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClicksByQuery(click_query, opts, callback);

Documentation for API Endpoints

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

Class Method HTTP request Description
UltraCartRestApiV2.AffiliateApi getClicksByQuery POST /affiliate/clicks/query Retrieve clicks
UltraCartRestApiV2.AffiliateApi getLedgersByQuery POST /affiliate/ledgers/query Retrieve ledger entries
UltraCartRestApiV2.AutoOrderApi getAutoOrder GET /auto_order/auto_orders/{auto_order_oid} Retrieve an auto order by oid
UltraCartRestApiV2.AutoOrderApi getAutoOrderByCode GET /auto_order/auto_orders/code/{auto_order_code} Retrieve an auto order by code
UltraCartRestApiV2.AutoOrderApi getAutoOrderByReferenceOrderId GET /auto_order/auto_orders/reference_order_id/{reference_order_id} Retrieve an auto order by order id
UltraCartRestApiV2.AutoOrderApi getAutoOrders GET /auto_order/auto_orders Retrieve auto orders
UltraCartRestApiV2.AutoOrderApi getAutoOrdersBatch POST /auto_order/auto_orders/batch Retrieve auto order batch
UltraCartRestApiV2.AutoOrderApi getAutoOrdersByQuery POST /auto_order/auto_orders/query Retrieve auto orders by query
UltraCartRestApiV2.AutoOrderApi updateAutoOrder PUT /auto_order/auto_orders/{auto_order_oid} Update an auto order
UltraCartRestApiV2.AutoOrderApi updateAutoOrdersBatch PUT /auto_order/auto_orders/batch Update multiple auto orders
UltraCartRestApiV2.ChargebackApi deleteChargeback DELETE /chargeback/chargebacks/{chargeback_dispute_oid} Delete a chargeback
UltraCartRestApiV2.ChargebackApi getChargebackDispute GET /chargeback/chargebacks/{chargeback_dispute_oid} Retrieve a chargeback
UltraCartRestApiV2.ChargebackApi getChargebackDisputes GET /chargeback/chargebacks Retrieve chargebacks
UltraCartRestApiV2.ChargebackApi insertChargeback POST /chargeback/chargebacks Insert a chargeback
UltraCartRestApiV2.ChargebackApi updateChargeback PUT /chargeback/chargebacks/{chargeback_dispute_oid} Update a chargeback
UltraCartRestApiV2.CheckoutApi cityState POST /checkout/city_state City/State for Zip
UltraCartRestApiV2.CheckoutApi finalizeOrder POST /checkout/cart/finalizeOrder Finalize Order
UltraCartRestApiV2.CheckoutApi getAffirmCheckout GET /checkout/cart/{cart_id}/affirmCheckout Get affirm checkout (by cart id)
UltraCartRestApiV2.CheckoutApi getAllowedCountries POST /checkout/allowedCountries Allowed countries
UltraCartRestApiV2.CheckoutApi getCart GET /checkout/cart Get cart
UltraCartRestApiV2.CheckoutApi getCartByCartId GET /checkout/cart/{cart_id} Get cart (by cart id)
UltraCartRestApiV2.CheckoutApi getCartByReturnCode GET /checkout/return/{return_code} Get cart (by return code)
UltraCartRestApiV2.CheckoutApi getCartByReturnToken GET /checkout/return_token Get cart (by return token)
UltraCartRestApiV2.CheckoutApi getStateProvincesForCountry POST /checkout/stateProvincesForCountry/{country_code} Get state/province list for a country code
UltraCartRestApiV2.CheckoutApi handoffCart POST /checkout/cart/handoff Handoff cart
UltraCartRestApiV2.CheckoutApi login POST /checkout/cart/profile/login Profile login
UltraCartRestApiV2.CheckoutApi logout POST /checkout/cart/profile/logout Profile logout
UltraCartRestApiV2.CheckoutApi register POST /checkout/cart/profile/register Profile registration
UltraCartRestApiV2.CheckoutApi registerAffiliateClick POST /checkout/affiliateClick/register Register affiliate click
UltraCartRestApiV2.CheckoutApi relatedItemsForCart POST /checkout/related_items Related items
UltraCartRestApiV2.CheckoutApi relatedItemsForItem POST /checkout/relatedItems/{item_id} Related items (specific item)
UltraCartRestApiV2.CheckoutApi setupBrowserKey PUT /checkout/browser_key Setup Browser Application
UltraCartRestApiV2.CheckoutApi updateCart PUT /checkout/cart Update cart
UltraCartRestApiV2.CheckoutApi validateCart POST /checkout/cart/validate Validate
UltraCartRestApiV2.CouponApi deleteCoupon DELETE /coupon/coupons/{coupon_oid} Delete a coupon
UltraCartRestApiV2.CouponApi deleteCouponsByCode DELETE /coupon/coupons/by_code Deletes multiple coupons
UltraCartRestApiV2.CouponApi deleteCouponsByOid DELETE /coupon/coupons/by_oid Deletes multiple coupons
UltraCartRestApiV2.CouponApi doesCouponCodeExist GET /coupon/coupons/merchant_code/{merchant_code}/exists Determines if a coupon merchant code already exists
UltraCartRestApiV2.CouponApi generateCouponCodes POST /coupon/coupons/{coupon_oid}/generate_codes Generates one time codes for a coupon
UltraCartRestApiV2.CouponApi generateOneTimeCodesByMerchantCode POST /coupon/coupons/merchant_code/{merchant_code}/generate_codes Generates one time codes by merchant code
UltraCartRestApiV2.CouponApi getAutoApply GET /coupon/auto_apply Retrieve auto apply rules and conditions
UltraCartRestApiV2.CouponApi getCoupon GET /coupon/coupons/{coupon_oid} Retrieve a coupon
UltraCartRestApiV2.CouponApi getCouponByMerchantCode GET /coupon/coupons/merchant_code/{merchant_code} Retrieve a coupon by merchant code
UltraCartRestApiV2.CouponApi getCoupons GET /coupon/coupons Retrieve coupons
UltraCartRestApiV2.CouponApi getCouponsByQuery GET /coupon/coupons/query Retrieve coupons by query
UltraCartRestApiV2.CouponApi getEditorValues GET /coupon/editor_values Retrieve values needed for a coupon editor
UltraCartRestApiV2.CouponApi insertCoupon POST /coupon/coupons Insert a coupon
UltraCartRestApiV2.CouponApi insertCoupons POST /coupon/coupons/batch Insert multiple coupons
UltraCartRestApiV2.CouponApi searchItems GET /coupon/searchItems Searches for items to display within a coupon editor and assign to coupons
UltraCartRestApiV2.CouponApi updateAutoApply POST /coupon/auto_apply Update auto apply rules and conditions
UltraCartRestApiV2.CouponApi updateCoupon PUT /coupon/coupons/{coupon_oid} Update a coupon
UltraCartRestApiV2.CouponApi updateCoupons PUT /coupon/coupons/batch Update multiple coupons
UltraCartRestApiV2.CouponApi uploadCouponCodes POST /coupon/coupons/{coupon_oid}/upload_codes Upload one-time codes for a coupon
UltraCartRestApiV2.CustomerApi deleteCustomer DELETE /customer/customers/{customer_profile_oid} Delete a customer
UltraCartRestApiV2.CustomerApi getCustomer GET /customer/customers/{customer_profile_oid} Retrieve a customer
UltraCartRestApiV2.CustomerApi getCustomerByEmail GET /customer/customers/by_email/{email} Retrieve a customer by Email
UltraCartRestApiV2.CustomerApi getCustomers GET /customer/customers Retrieve customers
UltraCartRestApiV2.CustomerApi getCustomersByQuery POST /customer/customers/query Retrieve customers by query
UltraCartRestApiV2.CustomerApi getCustomersForDataTables POST /customer/customers/dataTables Retrieve customers for DataTables plugin
UltraCartRestApiV2.CustomerApi getEditorValues GET /customer/editor_values Retrieve values needed for a customer profile editor
UltraCartRestApiV2.CustomerApi getEmailLists GET /customer/email_lists Retrieve all email lists across all storefronts
UltraCartRestApiV2.CustomerApi getEmailVerificationToken POST /customer/customers/email_verify/get_token Create a token that can be used to verify a customer email address
UltraCartRestApiV2.CustomerApi insertCustomer POST /customer/customers Insert a customer
UltraCartRestApiV2.CustomerApi updateCustomer PUT /customer/customers/{customer_profile_oid} Update a customer
UltraCartRestApiV2.CustomerApi updateCustomerEmailLists POST /customer/customers/{customer_profile_oid}/email_lists Update email list subscriptions for a customer
UltraCartRestApiV2.CustomerApi validateEmailVerificationToken POST /customer/customers/email_verify/validate_token Validate a token that can be used to verify a customer email address
UltraCartRestApiV2.FulfillmentApi acknowledgeOrders PUT /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements Acknowledge receipt of orders.
UltraCartRestApiV2.FulfillmentApi getDistributionCenterOrders GET /fulfillment/distribution_centers/{distribution_center_code}/orders Retrieve orders queued up for this distribution center.
UltraCartRestApiV2.FulfillmentApi getDistributionCenters GET /fulfillment/distribution_centers Retrieve distribution centers
UltraCartRestApiV2.FulfillmentApi shipOrders POST /fulfillment/distribution_centers/{distribution_center_code}/shipments Mark orders as shipped
UltraCartRestApiV2.FulfillmentApi updateInventory POST /fulfillment/distribution_centers/{distribution_center_code}/inventory Update inventory
UltraCartRestApiV2.ItemApi deleteItem DELETE /item/items/{merchant_item_oid} Delete an item
UltraCartRestApiV2.ItemApi getItem GET /item/items/{merchant_item_oid} Retrieve an item
UltraCartRestApiV2.ItemApi getItemByMerchantItemId GET /item/items/merchant_item_id/{merchant_item_id} Retrieve an item by item id
UltraCartRestApiV2.ItemApi getItems GET /item/items Retrieve items
UltraCartRestApiV2.ItemApi getPricingTiers GET /item/pricing_tiers Retrieve pricing tiers
UltraCartRestApiV2.ItemApi insertItem POST /item/items Create an item
UltraCartRestApiV2.ItemApi updateItem PUT /item/items/{merchant_item_oid} Update an item
UltraCartRestApiV2.ItemApi updateItems PUT /item/items/batch Update multiple items
UltraCartRestApiV2.ItemApi uploadTemporaryMultimedia POST /item/temp_multimedia Upload an image to the temporary multimedia.
UltraCartRestApiV2.OauthApi oauthAccessToken POST /oauth/token Exchange authorization code for access token.
UltraCartRestApiV2.OauthApi oauthRevoke POST /oauth/revoke Revoke this OAuth application.
UltraCartRestApiV2.OrderApi adjustOrderTotal POST /order/orders/{order_id}/adjust_order_total/{desired_total} Adjusts an order total
UltraCartRestApiV2.OrderApi cancelOrder POST /order/orders/{order_id}/cancel Cancel an order
UltraCartRestApiV2.OrderApi deleteOrder DELETE /order/orders/{order_id} Delete an order
UltraCartRestApiV2.OrderApi format POST /order/orders/{order_id}/format Format order
UltraCartRestApiV2.OrderApi generateOrderToken GET /order/orders/token/{order_id} Generate an order token for a given order id
UltraCartRestApiV2.OrderApi getAccountsReceivableRetryConfig GET /order/accountsReceivableRetryConfig Retrieve A/R Retry Configuration
UltraCartRestApiV2.OrderApi getAccountsReceivableRetryStats GET /order/accountsReceivableRetryConfig/stats Retrieve A/R Retry Statistics
UltraCartRestApiV2.OrderApi getOrder GET /order/orders/{order_id} Retrieve an order
UltraCartRestApiV2.OrderApi getOrderByToken POST /order/orders/token Retrieve an order using a token
UltraCartRestApiV2.OrderApi getOrders GET /order/orders Retrieve orders
UltraCartRestApiV2.OrderApi getOrdersBatch POST /order/orders/batch Retrieve order batch
UltraCartRestApiV2.OrderApi getOrdersByQuery POST /order/orders/query Retrieve orders by query
UltraCartRestApiV2.OrderApi insertOrder POST /order/orders Insert an order
UltraCartRestApiV2.OrderApi processPayment POST /order/orders/{order_id}/process_payment Process payment
UltraCartRestApiV2.OrderApi refundOrder PUT /order/orders/{order_id}/refund Refund an order
UltraCartRestApiV2.OrderApi replacement POST /order/orders/{order_id}/replacement Replacement order
UltraCartRestApiV2.OrderApi resendReceipt POST /order/orders/{order_id}/resend_receipt Resend receipt
UltraCartRestApiV2.OrderApi resendShipmentConfirmation POST /order/orders/{order_id}/resend_shipment_confirmation Resend shipment confirmation
UltraCartRestApiV2.OrderApi updateAccountsReceivableRetryConfig POST /order/accountsReceivableRetryConfig Update A/R Retry Configuration
UltraCartRestApiV2.OrderApi updateOrder PUT /order/orders/{order_id} Update an order
UltraCartRestApiV2.StorefrontApi addToLibrary POST /storefront/code_library Add to library
UltraCartRestApiV2.StorefrontApi applyToStoreFront POST /storefront/code_library/apply Apply library item to storefront.
UltraCartRestApiV2.StorefrontApi archiveEmailList POST /storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive Archive email list
UltraCartRestApiV2.StorefrontApi archiveEmailSegment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/archive Archive email segment
UltraCartRestApiV2.StorefrontApi backPopulateEmailFlow POST /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/backfill Back populate email flow
UltraCartRestApiV2.StorefrontApi checkDownloadEmailSegment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid} Check download of email segment
UltraCartRestApiV2.StorefrontApi cloneEmailCampaign POST /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone Clone email campaign
UltraCartRestApiV2.StorefrontApi cloneEmailFlow POST /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone Clone email flow
UltraCartRestApiV2.StorefrontApi createEmailSendingDomain POST /storefront/email/sending_domains/{domain}/create Create email campaign
UltraCartRestApiV2.StorefrontApi deleteEmailCampaignFolder DELETE /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Delete email campaignFolder
UltraCartRestApiV2.StorefrontApi deleteEmailCommseqStat DELETE /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat Delete communication sequence stats
UltraCartRestApiV2.StorefrontApi deleteEmailEmail DELETE /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Delete email email
UltraCartRestApiV2.StorefrontApi deleteEmailFlowFolder DELETE /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Delete email flowFolder
UltraCartRestApiV2.StorefrontApi deleteEmailListCustomer DELETE /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid} Delete email list customer
UltraCartRestApiV2.StorefrontApi deleteEmailPostcard DELETE /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Delete email postcard
UltraCartRestApiV2.StorefrontApi deleteEmailSendingDomain DELETE /storefront/email/sending_domains/{domain} delete email campaign
UltraCartRestApiV2.StorefrontApi deleteExperiment DELETE /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} Delete experiment
UltraCartRestApiV2.StorefrontApi deleteLibraryItem DELETE /storefront/code_library/{library_item_oid} Delete library item
UltraCartRestApiV2.StorefrontApi deleteLibraryItemPublishedVersions DELETE /storefront/code_library/{library_item_oid}/published_versions Delete all published versions for a library item, including anything in review.
UltraCartRestApiV2.StorefrontApi deleteScreenRecordingSegment DELETE /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Delete screen recording segment
UltraCartRestApiV2.StorefrontApi duplicateLibraryItem POST /storefront/code_library/{library_item_oid}/duplicate Duplicate library item.
UltraCartRestApiV2.StorefrontApi favoriteScreenRecording POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite Update favorite flag on screen recording
UltraCartRestApiV2.StorefrontApi geocodeAddress POST /storefront/{storefront_oid}/email/geocode Obtain lat/long for an address
UltraCartRestApiV2.StorefrontApi getCountries GET /storefront/{storefront_oid}/email/countries Get countries
UltraCartRestApiV2.StorefrontApi getEditorToken GET /storefront/{storefront_oid}/editor_token Gets editor token
UltraCartRestApiV2.StorefrontApi getEmailBaseTemplates GET /storefront/{storefront_oid}/email/baseTemplates Get email communication base templates
UltraCartRestApiV2.StorefrontApi getEmailCampaign GET /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} Get email campaign
UltraCartRestApiV2.StorefrontApi getEmailCampaignFolder GET /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Get email campaign folder
UltraCartRestApiV2.StorefrontApi getEmailCampaignFolders GET /storefront/{storefront_oid}/email/campaign_folders Get email campaign folders
UltraCartRestApiV2.StorefrontApi getEmailCampaignScreenshots GET /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/screenshots Get email campaign screenshots
UltraCartRestApiV2.StorefrontApi getEmailCampaigns GET /storefront/{storefront_oid}/email/campaigns Get email campaigns
UltraCartRestApiV2.StorefrontApi getEmailCampaignsWithStats GET /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} Get email campaigns with stats
UltraCartRestApiV2.StorefrontApi getEmailCommseq GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} Get email commseq
UltraCartRestApiV2.StorefrontApi getEmailCommseqEmailStats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats Get email communication sequence emails stats
UltraCartRestApiV2.StorefrontApi getEmailCommseqPostcardStats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats Get email communication sequence postcard stats
UltraCartRestApiV2.StorefrontApi getEmailCommseqStatOverall GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat Get communication sequence stats overall
UltraCartRestApiV2.StorefrontApi getEmailCommseqStepStats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats Get email communication sequence step stats
UltraCartRestApiV2.StorefrontApi getEmailCommseqStepWaiting POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting Get email communication sequence customers waiting at each requested step
UltraCartRestApiV2.StorefrontApi getEmailCommseqs GET /storefront/{storefront_oid}/email/commseqs Get email commseqs
UltraCartRestApiV2.StorefrontApi getEmailCustomerEditorUrl GET /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url Get customers editor URL
UltraCartRestApiV2.StorefrontApi getEmailCustomers GET /storefront/{storefront_oid}/email/customers Get email customers
UltraCartRestApiV2.StorefrontApi getEmailDashboardActivity GET /storefront/{storefront_oid}/email/dashboard_activity Get email dashboard activity
UltraCartRestApiV2.StorefrontApi getEmailDashboardStats GET /storefront/{storefront_oid}/email/dashboard_stats Get dashboard stats
UltraCartRestApiV2.StorefrontApi getEmailEmail GET /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Get email email
UltraCartRestApiV2.StorefrontApi getEmailEmailClicks GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks Get email email clicks
UltraCartRestApiV2.StorefrontApi getEmailEmailCustomerEditorUrl GET /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url Get email order customer editor url
UltraCartRestApiV2.StorefrontApi getEmailEmailOrders GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/orders Get email email orders
UltraCartRestApiV2.StorefrontApi getEmailEmails GET /storefront/{storefront_oid}/email/emails Get email emails
UltraCartRestApiV2.StorefrontApi getEmailEmailsMultiple POST /storefront/{storefront_oid}/email/emails/multiple Get email emails multiple
UltraCartRestApiV2.StorefrontApi getEmailFlow GET /storefront/{storefront_oid}/email/flows/{email_flow_uuid} Get email flow
UltraCartRestApiV2.StorefrontApi getEmailFlowFolder GET /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Get email flow folder
UltraCartRestApiV2.StorefrontApi getEmailFlowFolders GET /storefront/{storefront_oid}/email/flow_folders Get email flow folders
UltraCartRestApiV2.StorefrontApi getEmailFlowScreenshots GET /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/screenshots Get email flow screenshots
UltraCartRestApiV2.StorefrontApi getEmailFlows GET /storefront/{storefront_oid}/email/flows Get email flows
UltraCartRestApiV2.StorefrontApi getEmailGlobalSettings GET /storefront/email/global_settings Get email globalsettings
UltraCartRestApiV2.StorefrontApi getEmailList GET /storefront/{storefront_oid}/email/lists/{email_list_uuid} Get email list
UltraCartRestApiV2.StorefrontApi getEmailListCustomerEditorUrl GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url Get email list customer editor url
UltraCartRestApiV2.StorefrontApi getEmailListCustomers GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers Get email list customers
UltraCartRestApiV2.StorefrontApi getEmailLists GET /storefront/{storefront_oid}/email/lists Get email lists
UltraCartRestApiV2.StorefrontApi getEmailPerformance GET /storefront/{storefront_oid}/email/performance Get email performance
UltraCartRestApiV2.StorefrontApi getEmailPlan GET /storefront/{storefront_oid}/email/plan Get email plan
UltraCartRestApiV2.StorefrontApi getEmailPostcard GET /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Get email postcard
UltraCartRestApiV2.StorefrontApi getEmailPostcards GET /storefront/{storefront_oid}/email/postcards Get email postcards
UltraCartRestApiV2.StorefrontApi getEmailPostcardsMultiple POST /storefront/{storefront_oid}/email/postcards/multiple Get email postcards multiple
UltraCartRestApiV2.StorefrontApi getEmailSegment GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid} Get email segment
UltraCartRestApiV2.StorefrontApi getEmailSegmentCustomerEditorUrl GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url Get email segment customers editor URL
UltraCartRestApiV2.StorefrontApi getEmailSegmentCustomers GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers Get email segment customers
UltraCartRestApiV2.StorefrontApi getEmailSegments GET /storefront/{storefront_oid}/email/segments Get email segments
UltraCartRestApiV2.StorefrontApi getEmailSendingDomain GET /storefront/email/sending_domain/{domain} Get email sending domain
UltraCartRestApiV2.StorefrontApi getEmailSendingDomainStatus POST /storefront/email/sending_domains/{domain}/status Get email sending domain status
UltraCartRestApiV2.StorefrontApi getEmailSendingDomains GET /storefront/email/sending_domains Get email sending domains
UltraCartRestApiV2.StorefrontApi getEmailSettings GET /storefront/{storefront_oid}/email/settings Get email settings
UltraCartRestApiV2.StorefrontApi getEmailTemplate GET /storefront/{storefront_oid}/email/templates/{email_template_oid} Get email template
UltraCartRestApiV2.StorefrontApi getEmailTemplates GET /storefront/{storefront_oid}/email/templates Get email templates
UltraCartRestApiV2.StorefrontApi getEmailThirdPartyProviders GET /storefront/{storefront_oid}/email/third_party_providers Get a list of third party email providers
UltraCartRestApiV2.StorefrontApi getExperiments GET /storefront/{storefront_oid}/experiments Get experiments
UltraCartRestApiV2.StorefrontApi getHistogramPropertyNames GET /storefront/{storefront_oid}/email/histogram/property_names Get histogram property names
UltraCartRestApiV2.StorefrontApi getHistogramPropertyValues GET /storefront/{storefront_oid}/email/histogram/property_values Get histogram property values
UltraCartRestApiV2.StorefrontApi getLibraryFilterValues GET /storefront/code_library/filter_values Get library values used to populate drop down boxes for filtering.
UltraCartRestApiV2.StorefrontApi getLibraryItem GET /storefront/code_library/{library_item_oid} Get library item.
UltraCartRestApiV2.StorefrontApi getLibraryItemPublishedVersions GET /storefront/code_library/{library_item_oid}/published_versions Get all published versions for a library item.
UltraCartRestApiV2.StorefrontApi getPricingTiers GET /storefront/pricing_tiers Retrieve pricing tiers
UltraCartRestApiV2.StorefrontApi getScreenRecording GET /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid} Get screen recording
UltraCartRestApiV2.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
UltraCartRestApiV2.StorefrontApi getScreenRecordingSegment GET /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Get screen recording segment
UltraCartRestApiV2.StorefrontApi getScreenRecordingSegments GET /storefront/{storefront_oid}/screen_recordings/segments Get screen recording segments
UltraCartRestApiV2.StorefrontApi getScreenRecordingSettings GET /storefront/{storefront_oid}/screen_recordings/settings Get screen recording settings
UltraCartRestApiV2.StorefrontApi getScreenRecordingTags POST /storefront/{storefront_oid}/screen_recordings/tags Get tags used by screen recording
UltraCartRestApiV2.StorefrontApi getScreenRecordingsByQuery POST /storefront/{storefront_oid}/screen_recordings/query Query screen recordings
UltraCartRestApiV2.StorefrontApi getScreenRecordingsBySegment POST /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query Get screen recordings by segment
UltraCartRestApiV2.StorefrontApi getThumbnailParameters POST /storefront/thumbnailParameters Get thumbnail parameters
UltraCartRestApiV2.StorefrontApi getTransactionEmail GET /storefront/{storefront_oid}/transaction_email/list/{email_id} Gets a transaction email object
UltraCartRestApiV2.StorefrontApi getTransactionEmailList GET /storefront/{storefront_oid}/transaction_email/list Gets a list of transaction email names
UltraCartRestApiV2.StorefrontApi getTransactionEmailScreenshots GET /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots Get transactional email screenshots
UltraCartRestApiV2.StorefrontApi globalUnsubscribe POST /storefront/{storefront_oid}/email/globalUnsubscribe Globally unsubscribe a customer
UltraCartRestApiV2.StorefrontApi importEmailThirdPartyProviderList POST /storefront/{storefront_oid}/email/third_party_providers/import Import a third party provider list
UltraCartRestApiV2.StorefrontApi insertEmailCampaign POST /storefront/{storefront_oid}/email/campaigns Insert email campaign
UltraCartRestApiV2.StorefrontApi insertEmailCampaignFolder POST /storefront/{storefront_oid}/email/campaign_folders Insert email campaign folder
UltraCartRestApiV2.StorefrontApi insertEmailCommseq POST /storefront/{storefront_oid}/email/commseqs Insert email commseq
UltraCartRestApiV2.StorefrontApi insertEmailEmail POST /storefront/{storefront_oid}/email/emails Insert email email
UltraCartRestApiV2.StorefrontApi insertEmailFlow POST /storefront/{storefront_oid}/email/flows Insert email flow
UltraCartRestApiV2.StorefrontApi insertEmailFlowFolder POST /storefront/{storefront_oid}/email/flow_folders Insert email flow folder
UltraCartRestApiV2.StorefrontApi insertEmailList POST /storefront/{storefront_oid}/email/lists Insert email list
UltraCartRestApiV2.StorefrontApi insertEmailPostcard POST /storefront/{storefront_oid}/email/postcards Insert email postcard
UltraCartRestApiV2.StorefrontApi insertEmailSegment POST /storefront/{storefront_oid}/email/segments Insert email segment
UltraCartRestApiV2.StorefrontApi insertScreenRecordingSegment POST /storefront/{storefront_oid}/screen_recordings/segments Insert screen recording segment
UltraCartRestApiV2.StorefrontApi prepareDownloadEmailSegment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare Prepare download of email segment
UltraCartRestApiV2.StorefrontApi publishLibraryItem POST /storefront/code_library/{library_item_oid}/publish Publish library item.
UltraCartRestApiV2.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
UltraCartRestApiV2.StorefrontApi releaseEmailCommseqStepWaiting POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid} Release email communication sequence customers waiting at the specified step
UltraCartRestApiV2.StorefrontApi review POST /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review Request a review of an email
UltraCartRestApiV2.StorefrontApi search GET /storefront/search Searches for all matching values
UltraCartRestApiV2.StorefrontApi search2 POST /storefront/search Searches for all matching values (using POST)
UltraCartRestApiV2.StorefrontApi searchEmailListCustomers GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/search Search email list customers
UltraCartRestApiV2.StorefrontApi searchEmailSegmentCustomers GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/search Search email segment customers
UltraCartRestApiV2.StorefrontApi searchLibraryItems POST /storefront/code_library/search Retrieve library items
UltraCartRestApiV2.StorefrontApi searchPublishedItems POST /storefront/code_library/search_published Retrieve library items
UltraCartRestApiV2.StorefrontApi searchReviewItems POST /storefront/code_library/search_review Retrieve library items needing review or rejected
UltraCartRestApiV2.StorefrontApi searchSharedItems POST /storefront/code_library/search_shared Retrieve library items
UltraCartRestApiV2.StorefrontApi sendEmailTest POST /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test Send email test
UltraCartRestApiV2.StorefrontApi sendPostcardTest POST /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test Send postcard test
UltraCartRestApiV2.StorefrontApi startEmailCampaign PUT /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start Start email campaign
UltraCartRestApiV2.StorefrontApi subscribeToEmailList POST /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe Subscribe customers to email list
UltraCartRestApiV2.StorefrontApi unfavoriteScreenRecording DELETE /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite Remove favorite flag on screen recording
UltraCartRestApiV2.StorefrontApi updateEmailCampaign PUT /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} Update email campaign
UltraCartRestApiV2.StorefrontApi updateEmailCampaignFolder PUT /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Update email campaign folder
UltraCartRestApiV2.StorefrontApi updateEmailCommseq PUT /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} Update email commseq
UltraCartRestApiV2.StorefrontApi updateEmailCustomer PUT /storefront/{storefront_oid}/email/customers/{email_customer_uuid} Update email customer
UltraCartRestApiV2.StorefrontApi updateEmailEmail PUT /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Update email email
UltraCartRestApiV2.StorefrontApi updateEmailFlow PUT /storefront/{storefront_oid}/email/flows/{email_flow_uuid} Update email flow
UltraCartRestApiV2.StorefrontApi updateEmailFlowFolder PUT /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Update email flow folder
UltraCartRestApiV2.StorefrontApi updateEmailGlobalSettings POST /storefront/email/global_settings Update email global settings
UltraCartRestApiV2.StorefrontApi updateEmailList PUT /storefront/{storefront_oid}/email/lists/{email_list_uuid} Update email list
UltraCartRestApiV2.StorefrontApi updateEmailPlan POST /storefront/{storefront_oid}/email/plan Update email plan
UltraCartRestApiV2.StorefrontApi updateEmailPostcard PUT /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Update email postcard
UltraCartRestApiV2.StorefrontApi updateEmailSegment PUT /storefront/{storefront_oid}/email/segments/{email_segment_uuid} Update email segment
UltraCartRestApiV2.StorefrontApi updateEmailSettings POST /storefront/{storefront_oid}/email/settings Update email settings
UltraCartRestApiV2.StorefrontApi updateExperiment PUT /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} Update experiment
UltraCartRestApiV2.StorefrontApi updateLibraryItem PUT /storefront/code_library/{library_item_oid} Update library item. Note that only certain fields may be updated via this method.
UltraCartRestApiV2.StorefrontApi updateScreenRecordingMerchantNotes POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes Update merchant notes on a screen recording
UltraCartRestApiV2.StorefrontApi updateScreenRecordingSegment POST /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Update screen recording segment
UltraCartRestApiV2.StorefrontApi updateScreenRecordingSettings POST /storefront/{storefront_oid}/screen_recordings/settings Update screen recording settings
UltraCartRestApiV2.StorefrontApi updateScreenRecordingTags POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags Update tags on a screen recording
UltraCartRestApiV2.StorefrontApi updateTransactionEmail PUT /storefront/{storefront_oid}/transaction_email/list/{email_id} Updates a transaction email object
UltraCartRestApiV2.TaxApi deleteTaxProviderSelfCity DELETE /tax/providers/self/city/{city} Deletes a Self tax provider city
UltraCartRestApiV2.TaxApi deleteTaxProviderSelfCountry DELETE /tax/providers/self/country/{countryCode} Deletes a Self tax provider country
UltraCartRestApiV2.TaxApi deleteTaxProviderSelfCounty DELETE /tax/providers/self/county/{county} Deletes a Self tax provider county
UltraCartRestApiV2.TaxApi deleteTaxProviderSelfPostalCode DELETE /tax/providers/self/postalCode/{postal_code} Deletes a Self tax provider postalCode
UltraCartRestApiV2.TaxApi deleteTaxProviderSelfState DELETE /tax/providers/self/state/{stateCode} Deletes a Self tax provider state
UltraCartRestApiV2.TaxApi getTaxProviderAvalara GET /tax/providers/avalara Retrieve the Avalara tax provider
UltraCartRestApiV2.TaxApi getTaxProviderAvalaraCompanies POST /tax/providers/avalara/companies Returns Avalara Tax companies configured by the merchant
UltraCartRestApiV2.TaxApi getTaxProviderAvalaraTest GET /tax/providers/avalara/test Attempts to connect to Avalara and returns back the response
UltraCartRestApiV2.TaxApi getTaxProviderSelf GET /tax/providers/self Retrieve the Self tax provider
UltraCartRestApiV2.TaxApi getTaxProviderSelfCountries GET /tax/providers/self/countries Retrieve the Self tax provider countries
UltraCartRestApiV2.TaxApi getTaxProviderSelfRegionsByCountryCode GET /tax/providers/self/regions/{countryCode} Retrieve the Self tax provider regions for a given country code
UltraCartRestApiV2.TaxApi getTaxProviderSovos GET /tax/providers/sovos Retrieve the Sovos tax provider
UltraCartRestApiV2.TaxApi getTaxProviderSovosTest GET /tax/providers/sovos/test Attempts to connect to Sovos and returns back the response
UltraCartRestApiV2.TaxApi getTaxProviderTaxJar GET /tax/providers/taxjar Retrieve the TaxJar tax provider
UltraCartRestApiV2.TaxApi getTaxProviderTaxJarTest GET /tax/providers/taxjar/test Attempts to connect to TaxJar and returns back the response
UltraCartRestApiV2.TaxApi getTaxProviderUltraCart GET /tax/providers/ultracart Retrieve the UltraCart tax provider
UltraCartRestApiV2.TaxApi getTaxProviders GET /tax/providers Retrieve tax methods
UltraCartRestApiV2.TaxApi setActiveTaxProvider POST /tax/providers/setActive/{providerName} Toggle a tax provider to active
UltraCartRestApiV2.TaxApi updateTaxProviderAvalara POST /tax/providers/avalara Update the Avalara tax provider
UltraCartRestApiV2.TaxApi updateTaxProviderSelf POST /tax/providers/self Update the Self tax provider
UltraCartRestApiV2.TaxApi updateTaxProviderSelfCity POST /tax/providers/self/city/{city} Updates a Self tax provider city
UltraCartRestApiV2.TaxApi updateTaxProviderSelfCountry POST /tax/providers/self/country/{countryCode} Updates a Self tax provider country
UltraCartRestApiV2.TaxApi updateTaxProviderSelfCounty POST /tax/providers/self/county/{county} Updates a Self tax provider county
UltraCartRestApiV2.TaxApi updateTaxProviderSelfPostalCode POST /tax/providers/self/postalCode/{postal_code} Updates a Self tax provider postalCode
UltraCartRestApiV2.TaxApi updateTaxProviderSelfState POST /tax/providers/self/state/{stateCode} Updates a Self tax provider state
UltraCartRestApiV2.TaxApi updateTaxProviderSovos POST /tax/providers/sovos Update the Sovos tax provider
UltraCartRestApiV2.TaxApi updateTaxProviderTaxJar POST /tax/providers/taxjar Update the TaxJar tax provider
UltraCartRestApiV2.TaxApi updateTaxProviderUltraCart POST /tax/providers/ultracart Update the UltraCart tax provider
UltraCartRestApiV2.UserApi deleteGroup DELETE /user/groups/{group_oid} Delete a group
UltraCartRestApiV2.UserApi deleteUser DELETE /user/users/{user_id} Delete a user
UltraCartRestApiV2.UserApi getGroup GET /user/groups/{group_oid} Retrieve a group
UltraCartRestApiV2.UserApi getGroups GET /user/groups Get groups
UltraCartRestApiV2.UserApi getUser GET /user/users/{user_id} Retrieve a user
UltraCartRestApiV2.UserApi getUserLogins GET /user/users/{user_id}/logins Retrieve a user's login history
UltraCartRestApiV2.UserApi getUsers GET /user/users Get users
UltraCartRestApiV2.UserApi insertGroup POST /user/groups Insert a group
UltraCartRestApiV2.UserApi insertUser POST /user/users Insert a user
UltraCartRestApiV2.UserApi updateGroup PUT /user/groups/{group_oid} Update a group
UltraCartRestApiV2.UserApi updateUser PUT /user/users/{user_id} Update a user
UltraCartRestApiV2.WebhookApi deleteWebhook DELETE /webhook/webhooks/{webhookOid} Delete a webhook
UltraCartRestApiV2.WebhookApi deleteWebhookByUrl DELETE /webhook/webhooks Delete a webhook by URL
UltraCartRestApiV2.WebhookApi getWebhookLog GET /webhook/webhooks/{webhookOid}/logs/{requestId} Retrieve an individual log
UltraCartRestApiV2.WebhookApi getWebhookLogSummaries GET /webhook/webhooks/{webhookOid}/logs Retrieve the log summaries
UltraCartRestApiV2.WebhookApi getWebhooks GET /webhook/webhooks Retrieve webhooks
UltraCartRestApiV2.WebhookApi insertWebhook POST /webhook/webhooks Add a webhook
UltraCartRestApiV2.WebhookApi resendEvent POST /webhook/webhooks/{webhookOid}/reflow/{eventName} Resend events to the webhook endpoint.
UltraCartRestApiV2.WebhookApi updateWebhook PUT /webhook/webhooks/{webhookOid} Update a webhook

Documentation for Models

Documentation for Authorization

ultraCartBrowserApiKey

  • Type: API key
  • API key parameter name: x-ultracart-browser-key
  • Location: HTTP header

ultraCartOauth

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://secure.ultracart.com/rest/v2/oauth/authorize
  • Scopes:
    • affiliate_read: Allows you to read affiliate information.
    • affiliate_write: Allows you to write affiliate information.
    • auto_order_read: Allows you to read auto order information.
    • auto_order_write: Allows you to write auto order information.
    • chargeback_read: Allows you to read chargeback information.
    • chargeback_write: Allows you to write chargeback information.
    • checkout_read: Allows you to read checkout information.
    • checkout_write: Allows you to write checkout information.
    • coupon_read: Allows you to read coupon information.
    • coupon_write: Allows you to write coupon information.
    • customer_read: Allows you to read customer information.
    • customer_write: Allows you to write customer information.
    • fulfillment_read: Allows you to read fulfillment information.
    • fulfillment_write: Allows you to write fulfillment information.
    • order_read: Allows you to read order information.
    • order_write: Allows you to write order information.
    • item_read: Allows you to read item information.
    • item_write: Allows you to write item information.
    • storefront_read: Allows you to read storefront information.
    • storefront_write: Allows you to write storefront information.
    • tax_read: Allows you to read tax configuration information.
    • tax_write: Allows you to write tax configuration information.
    • webhook_read: Allows you to read webhook information.
    • webhook_write: Allows you to write webhook information.
    • ultrabooks_read: 1 of 2 required to use UltraBooks
    • ultrabooks_write: 2 of 2 required to use UltraBooks
    • user_read: Allows you to read user information.
    • user_write: Allows you to write user information.

ultraCartSimpleApiKey

  • Type: API key
  • API key parameter name: x-ultracart-simple-key
  • Location: HTTP header

CHANGE LOG

Not every change is committed to every SDK.

Version Date Comments
3.1.32 05/06/2021 customer profile pending loyalty points
3.1.31 05/06/2021 Added email domian field to screen recordings for filtering
3.1.30 04/27/2021 OrderApi.processPayment now allows a specific amount to be billed
3.1.29 04/26/2021 screen recording language iso code
3.1.28 04/26/2021 screen recording statistics on the setting object
3.1.27 04/20/2021 bug fix - annotation misspell on new email campaign property
3.1.26 04/20/2021 StoreFront Connumications - flag to end campaign or flow once purchase happens anywhere
3.1.25 04/19/2021 Screen recording UTM campaign and source fields
3.1.24 04/16/2021 Screen recording aggregations on communications campaign/flows
3.1.22 04/09/2021 Move URL filter values into page level view for screen recordings
3.1.18 03/17/2021 Added order query by ship on date
3.1.17 03/17/2021 New coupon - percent off MSRP item
3.1.16 03/16/2021 screen recording filter page parameter names
3.1.15 03/15/2021 fix response from deleteScreenRecordingSegment that should have been void
3.1.14 03/15/2021 sort screen recordings by favorite flag
3.1.13 03/02/2021 new webhook order_payment_failed
3.1.12 02/25/2021 added screen recording visitor_first_seen property
3.1.11 02/24/2021 Added Screen recording visitor number
3.1.10 02/24/2021 Added Screen recording merchant notes
3.1.9 02/24/2021 Allow coupons to be configured as unique with expiration on cart step within StoreFront Communications
3.1.8 02/24/2021 Add flag: screen recording missing event boolean
3.1.5 02/12/2021 Bug Fix: PHP retry logic missing a closing brace. Also screen recording page view data response refactor
3.1.3 02/11/2021 Bug Fix: wrong return type on CustomerApi.validateEmailVerificationToken
3.1.2 02/11/2021 CustomerApi.getEmailVerificationToken, CustomerApi.validateEmailVerificationToken added to allow for custom email verification. Also added favorite flag to screen recording object
3.1.1 02/10/2021 CustomerApi.getCustomerByEmail() method added
3.1.0 02/10/2021 Minor revision jump. Added new convenience methods for simple_key use to all api calls. Updated docs
3.0.75 02/01/2021 StoreFront Communication plan revision (internal use)
3.0.71 01/28/2021 BugFix: PHP SDK retry logic NPE
3.0.70 01/26/2021 Checkout return URL support
3.0.66 01/22/2021 code library attributes (mostly internal dev)
3.0.65 01/22/2021 Added folder support for email campaigns and flows
3.0.64 01/20/2021 Bug fix on revenue per customer field incorrectly named.
3.0.63 01/20/2021 CouponAPI: bug fixes and new method doesCouponCodeExist
3.0.62 01/19/2021 Added retry ability when rate limit is triggered (PHP SDK only) only) Other sdk to follow.
3.0.60 01/14/2021 Working with Ruby SDK
3.0.57 12/17/2020 CouponAPI: Added Buy one get one free coupon
3.0.53 12/14/2020 StoreFrontAPI: added a duplicate method to load the pricing tiers on the StoreFront
3.0.51 12/09/2020 UserAPI: internal bug preventing proper usage of user group creation
3.0.45 12/03/2020 CouponAPI: added partial searches to getCoupon params, added deleteCoupons method, fixed bugs
3.0.44 12/03/2020 Code library updates, intended for internal use
3.0.43 12/02/2020 Added fields to code library to handle versions of published items
3.0.42 12/02/2020 Added display values to CouponApi.getEditorValues to make type dropdowns easy
3.0.41 11/17/2020 New modify cart step option for StoreFront communications
3.0.39 11/12/2020 Added Customer.tax_codes.taxjar_exemption_type
3.0.38 11/09/2020 Added TaxProviderTaxJar.configuration.send_outside_nexus flag
3.0.37 11/06/2020 Added transactional email screenshots for code library
3.0.36 11/03/2020 Added missing constant for pre-order stage
3.0.34 10/26/2020 UserAPI initial release
3.0.33 10/23/2020 Added library_item_oid to StoreFront Communications email object for upcoming code library
3.0.32 10/21/2020 Added new StoreFrontApi.search method that takes a POST instead of a GET
3.0.31 10/16/2020 more dev work on code library (internal)
3.0.30 10/08/2020 development work on code library (internal), first version of UserAPI. The UserAPI is not live yet.
3.0.29 09/29/2020 new boolean field on coupon: bug fix
3.0.28 09/29/2020 new boolean field on coupon: free item with purchase of another item
3.0.27 09/29/2020 Refactored the code library applyToStoreFront to provide support for marketing emails
3.0.26 09/25/2020 Expose actual shipping and fulfillment costs in the order summary object
3.0.25 09/16/2020 New method: OrderApi.adjustOrderTotal
3.0.24 09/10/2020 Bugfix: incorrect response type on CheckoutAPI.registerAffiliateClick
3.0.23 09/02/2020 Added flag to email plan object. allow_tracking_emails
3.0.22 09/02/2020 Order object - added tracking details
3.0.21 09/01/2020 break fix in php sdk due to bad namespace
3.0.20 09/01/2020 Added OrderApi.processPayment method
3.0.19 08/28/2020 Code Library development: added kraken parameters for thumbnail image generation.
3.0.17 08/26/2020 cont. development work on Code Library
3.0.14 08/19/2020 development work on Code Library
3.0.13 08/18/2020 development work on Code Library
3.0.12 08/13/2020 screenshot urls for campaigns and flows (storefront communications)
3.0.11 08/12/2020 Refactoring and development for Code Library (not released yet)
3.0.10 08/10/2020 Method for registering an affliate click via the SDK, found within CheckoutAPI
3.0.8 08/05/2020 stub for code library 'getLibraryFilterValues' for populating drop down lists
3.0.4 08/05/2020 fixed misspell of 'version' in LibraryItem object.
3.0.3 08/04/2020 added description to addToLibrary call to allow for initial description
3.0.2 08/03/2020 added option on email render step config to allow override of subject, added flow/campaign flag to end once customer purchases
3.0.1 07/27/2020 added init_json to storefront communication email objects
3.0.0 07/01/2020 upgraded our swagger-codegen fork to the latest swagger source code. this was a major changes so we jumped version numbers. please test all code.

Some changes jump version numbers due to multiple commits for bug fixes, omissions, and errors. At UltraCart, we eat our own dog food, and we increment the version number for every commit in order to generate a new javascript npm. For this reason, version gaps will be found in the change log above.

About

UltraCart REST API V2 SDK for JavaScript

Resources

License

Packages

No packages published