Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

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

ultracart_rest_sdk

UltraCart REST API Version 2

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

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/UltraCart/rest_api_v2_sdk_python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/UltraCart/rest_api_v2_sdk_python.git)

Then import the package:

import ultracart 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ultracart

Getting Started

Please follow the installation procedure and then run the following:

# retrieve an auto order
import ultracart
from ultracart.rest import ApiException
from ultracart import ApiClient
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.AutoorderApi.fromApiKey(simple_key, False, True)

auto_order_oid = 3268342  # int | The auto order oid to retrieve.
expand = 'items'  # str | Expansion determines how much of the object to return.  See documentation for examples (optional)

try:

    auto_order_response = api_instance.get_auto_order(auto_order_oid, expand=expand)
    auto_order = auto_order_response.auto_order

    pprint(auto_order)
except ApiException as e:
    print ("Exception when calling AutoorderApi->get_auto_order: %s\n" % e)

Retrieve all distribution centers

import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.FulfillmentApi.fromApiKey(simple_key, False, True)

try:
    # Retrieve distribution centers
    api_response = api_instance.get_distribution_centers()
    pprint(api_response)
except ApiException as e:
    print ("Exception when calling FulfillmentApi->get_distribution_centers: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AffiliateApi get_clicks_by_query POST /affiliate/clicks/query Retrieve clicks
AffiliateApi get_ledgers_by_query POST /affiliate/ledgers/query Retrieve ledger entries
AutoOrderApi get_auto_order GET /auto_order/auto_orders/{auto_order_oid} Retrieve an auto order by oid
AutoOrderApi get_auto_order_by_code GET /auto_order/auto_orders/code/{auto_order_code} Retrieve an auto order by code
AutoOrderApi get_auto_order_by_reference_order_id GET /auto_order/auto_orders/reference_order_id/{reference_order_id} Retrieve an auto order by order id
AutoOrderApi get_auto_orders GET /auto_order/auto_orders Retrieve auto orders
AutoOrderApi get_auto_orders_batch POST /auto_order/auto_orders/batch Retrieve auto order batch
AutoOrderApi get_auto_orders_by_query POST /auto_order/auto_orders/query Retrieve auto orders by query
AutoOrderApi update_auto_order PUT /auto_order/auto_orders/{auto_order_oid} Update an auto order
AutoOrderApi update_auto_orders_batch PUT /auto_order/auto_orders/batch Update multiple auto orders
ChargebackApi delete_chargeback DELETE /chargeback/chargebacks/{chargeback_dispute_oid} Delete a chargeback
ChargebackApi get_chargeback_dispute GET /chargeback/chargebacks/{chargeback_dispute_oid} Retrieve a chargeback
ChargebackApi get_chargeback_disputes GET /chargeback/chargebacks Retrieve chargebacks
ChargebackApi insert_chargeback POST /chargeback/chargebacks Insert a chargeback
ChargebackApi update_chargeback PUT /chargeback/chargebacks/{chargeback_dispute_oid} Update a chargeback
CheckoutApi city_state POST /checkout/city_state City/State for Zip
CheckoutApi finalize_order POST /checkout/cart/finalizeOrder Finalize Order
CheckoutApi get_affirm_checkout GET /checkout/cart/{cart_id}/affirmCheckout Get affirm checkout (by cart id)
CheckoutApi get_allowed_countries POST /checkout/allowedCountries Allowed countries
CheckoutApi get_cart GET /checkout/cart Get cart
CheckoutApi get_cart_by_cart_id GET /checkout/cart/{cart_id} Get cart (by cart id)
CheckoutApi get_cart_by_return_code GET /checkout/return/{return_code} Get cart (by return code)
CheckoutApi get_cart_by_return_token GET /checkout/return_token Get cart (by return token)
CheckoutApi get_state_provinces_for_country POST /checkout/stateProvincesForCountry/{country_code} Get state/province list for a country code
CheckoutApi handoff_cart 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 register_affiliate_click POST /checkout/affiliateClick/register Register affiliate click
CheckoutApi related_items_for_cart POST /checkout/related_items Related items
CheckoutApi related_items_for_item POST /checkout/relatedItems/{item_id} Related items (specific item)
CheckoutApi setup_browser_key PUT /checkout/browser_key Setup Browser Application
CheckoutApi update_cart PUT /checkout/cart Update cart
CheckoutApi validate_cart POST /checkout/cart/validate Validate
CouponApi delete_coupon DELETE /coupon/coupons/{coupon_oid} Delete a coupon
CouponApi delete_coupons_by_code DELETE /coupon/coupons/by_code Deletes multiple coupons
CouponApi delete_coupons_by_oid DELETE /coupon/coupons/by_oid Deletes multiple coupons
CouponApi does_coupon_code_exist GET /coupon/coupons/merchant_code/{merchant_code}/exists Determines if a coupon merchant code already exists
CouponApi generate_coupon_codes POST /coupon/coupons/{coupon_oid}/generate_codes Generates one time codes for a coupon
CouponApi generate_one_time_codes_by_merchant_code POST /coupon/coupons/merchant_code/{merchant_code}/generate_codes Generates one time codes by merchant code
CouponApi get_auto_apply GET /coupon/auto_apply Retrieve auto apply rules and conditions
CouponApi get_coupon GET /coupon/coupons/{coupon_oid} Retrieve a coupon
CouponApi get_coupon_by_merchant_code GET /coupon/coupons/merchant_code/{merchant_code} Retrieve a coupon by merchant code
CouponApi get_coupons GET /coupon/coupons Retrieve coupons
CouponApi get_coupons_by_query GET /coupon/coupons/query Retrieve coupons by query
CouponApi get_editor_values GET /coupon/editor_values Retrieve values needed for a coupon editor
CouponApi insert_coupon POST /coupon/coupons Insert a coupon
CouponApi insert_coupons POST /coupon/coupons/batch Insert multiple coupons
CouponApi search_items GET /coupon/searchItems Searches for items to display within a coupon editor and assign to coupons
CouponApi update_auto_apply POST /coupon/auto_apply Update auto apply rules and conditions
CouponApi update_coupon PUT /coupon/coupons/{coupon_oid} Update a coupon
CouponApi update_coupons PUT /coupon/coupons/batch Update multiple coupons
CouponApi upload_coupon_codes POST /coupon/coupons/{coupon_oid}/upload_codes Upload one-time codes for a coupon
CustomerApi delete_customer DELETE /customer/customers/{customer_profile_oid} Delete a customer
CustomerApi get_customer GET /customer/customers/{customer_profile_oid} Retrieve a customer
CustomerApi get_customer_by_email GET /customer/customers/by_email/{email} Retrieve a customer by Email
CustomerApi get_customers GET /customer/customers Retrieve customers
CustomerApi get_customers_by_query POST /customer/customers/query Retrieve customers by query
CustomerApi get_customers_for_data_tables POST /customer/customers/dataTables Retrieve customers for DataTables plugin
CustomerApi get_editor_values GET /customer/editor_values Retrieve values needed for a customer profile editor
CustomerApi get_email_lists GET /customer/email_lists Retrieve all email lists across all storefronts
CustomerApi get_email_verification_token POST /customer/customers/email_verify/get_token Create a token that can be used to verify a customer email address
CustomerApi insert_customer POST /customer/customers Insert a customer
CustomerApi update_customer PUT /customer/customers/{customer_profile_oid} Update a customer
CustomerApi update_customer_email_lists POST /customer/customers/{customer_profile_oid}/email_lists Update email list subscriptions for a customer
CustomerApi validate_email_verification_token POST /customer/customers/email_verify/validate_token Validate a token that can be used to verify a customer email address
FulfillmentApi acknowledge_orders PUT /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements Acknowledge receipt of orders.
FulfillmentApi get_distribution_center_orders GET /fulfillment/distribution_centers/{distribution_center_code}/orders Retrieve orders queued up for this distribution center.
FulfillmentApi get_distribution_centers GET /fulfillment/distribution_centers Retrieve distribution centers
FulfillmentApi ship_orders POST /fulfillment/distribution_centers/{distribution_center_code}/shipments Mark orders as shipped
FulfillmentApi update_inventory POST /fulfillment/distribution_centers/{distribution_center_code}/inventory Update inventory
ItemApi delete_item DELETE /item/items/{merchant_item_oid} Delete an item
ItemApi get_item GET /item/items/{merchant_item_oid} Retrieve an item
ItemApi get_item_by_merchant_item_id GET /item/items/merchant_item_id/{merchant_item_id} Retrieve an item by item id
ItemApi get_items GET /item/items Retrieve items
ItemApi get_pricing_tiers GET /item/pricing_tiers Retrieve pricing tiers
ItemApi insert_item POST /item/items Create an item
ItemApi update_item PUT /item/items/{merchant_item_oid} Update an item
ItemApi update_items PUT /item/items/batch Update multiple items
ItemApi upload_temporary_multimedia POST /item/temp_multimedia Upload an image to the temporary multimedia.
OauthApi oauth_access_token POST /oauth/token Exchange authorization code for access token.
OauthApi oauth_revoke POST /oauth/revoke Revoke this OAuth application.
OrderApi adjust_order_total POST /order/orders/{order_id}/adjust_order_total/{desired_total} Adjusts an order total
OrderApi cancel_order POST /order/orders/{order_id}/cancel Cancel an order
OrderApi delete_order DELETE /order/orders/{order_id} Delete an order
OrderApi format POST /order/orders/{order_id}/format Format order
OrderApi generate_order_token GET /order/orders/token/{order_id} Generate an order token for a given order id
OrderApi get_accounts_receivable_retry_config GET /order/accountsReceivableRetryConfig Retrieve A/R Retry Configuration
OrderApi get_accounts_receivable_retry_stats GET /order/accountsReceivableRetryConfig/stats Retrieve A/R Retry Statistics
OrderApi get_order GET /order/orders/{order_id} Retrieve an order
OrderApi get_order_by_token POST /order/orders/token Retrieve an order using a token
OrderApi get_orders GET /order/orders Retrieve orders
OrderApi get_orders_batch POST /order/orders/batch Retrieve order batch
OrderApi get_orders_by_query POST /order/orders/query Retrieve orders by query
OrderApi insert_order POST /order/orders Insert an order
OrderApi process_payment POST /order/orders/{order_id}/process_payment Process payment
OrderApi refund_order PUT /order/orders/{order_id}/refund Refund an order
OrderApi replacement POST /order/orders/{order_id}/replacement Replacement order
OrderApi resend_receipt POST /order/orders/{order_id}/resend_receipt Resend receipt
OrderApi resend_shipment_confirmation POST /order/orders/{order_id}/resend_shipment_confirmation Resend shipment confirmation
OrderApi update_accounts_receivable_retry_config POST /order/accountsReceivableRetryConfig Update A/R Retry Configuration
OrderApi update_order PUT /order/orders/{order_id} Update an order
StorefrontApi add_to_library POST /storefront/code_library Add to library
StorefrontApi apply_to_store_front POST /storefront/code_library/apply Apply library item to storefront.
StorefrontApi archive_email_list POST /storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive Archive email list
StorefrontApi archive_email_segment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/archive Archive email segment
StorefrontApi back_populate_email_flow POST /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/backfill Back populate email flow
StorefrontApi check_download_email_segment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid} Check download of email segment
StorefrontApi clone_email_campaign POST /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone Clone email campaign
StorefrontApi clone_email_flow POST /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone Clone email flow
StorefrontApi create_email_sending_domain POST /storefront/email/sending_domains/{domain}/create Create email campaign
StorefrontApi delete_email_campaign_folder DELETE /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Delete email campaignFolder
StorefrontApi delete_email_commseq_stat DELETE /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat Delete communication sequence stats
StorefrontApi delete_email_email DELETE /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Delete email email
StorefrontApi delete_email_flow_folder DELETE /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Delete email flowFolder
StorefrontApi delete_email_list_customer DELETE /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid} Delete email list customer
StorefrontApi delete_email_postcard DELETE /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Delete email postcard
StorefrontApi delete_email_sending_domain DELETE /storefront/email/sending_domains/{domain} delete email campaign
StorefrontApi delete_experiment DELETE /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} Delete experiment
StorefrontApi delete_library_item DELETE /storefront/code_library/{library_item_oid} Delete library item
StorefrontApi delete_library_item_published_versions DELETE /storefront/code_library/{library_item_oid}/published_versions Delete all published versions for a library item, including anything in review.
StorefrontApi delete_screen_recording_segment DELETE /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Delete screen recording segment
StorefrontApi duplicate_library_item POST /storefront/code_library/{library_item_oid}/duplicate Duplicate library item.
StorefrontApi favorite_screen_recording POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite Update favorite flag on screen recording
StorefrontApi geocode_address POST /storefront/{storefront_oid}/email/geocode Obtain lat/long for an address
StorefrontApi get_countries GET /storefront/{storefront_oid}/email/countries Get countries
StorefrontApi get_editor_token GET /storefront/{storefront_oid}/editor_token Gets editor token
StorefrontApi get_email_base_templates GET /storefront/{storefront_oid}/email/baseTemplates Get email communication base templates
StorefrontApi get_email_campaign GET /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} Get email campaign
StorefrontApi get_email_campaign_folder GET /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Get email campaign folder
StorefrontApi get_email_campaign_folders GET /storefront/{storefront_oid}/email/campaign_folders Get email campaign folders
StorefrontApi get_email_campaign_screenshots GET /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/screenshots Get email campaign screenshots
StorefrontApi get_email_campaigns GET /storefront/{storefront_oid}/email/campaigns Get email campaigns
StorefrontApi get_email_campaigns_with_stats GET /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} Get email campaigns with stats
StorefrontApi get_email_commseq GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} Get email commseq
StorefrontApi get_email_commseq_email_stats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats Get email communication sequence emails stats
StorefrontApi get_email_commseq_postcard_stats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats Get email communication sequence postcard stats
StorefrontApi get_email_commseq_stat_overall GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat Get communication sequence stats overall
StorefrontApi get_email_commseq_step_stats POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats Get email communication sequence step stats
StorefrontApi get_email_commseq_step_waiting POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting Get email communication sequence customers waiting at each requested step
StorefrontApi get_email_commseqs GET /storefront/{storefront_oid}/email/commseqs Get email commseqs
StorefrontApi get_email_customer_editor_url GET /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url Get customers editor URL
StorefrontApi get_email_customers GET /storefront/{storefront_oid}/email/customers Get email customers
StorefrontApi get_email_dashboard_activity GET /storefront/{storefront_oid}/email/dashboard_activity Get email dashboard activity
StorefrontApi get_email_dashboard_stats GET /storefront/{storefront_oid}/email/dashboard_stats Get dashboard stats
StorefrontApi get_email_email GET /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Get email email
StorefrontApi get_email_email_clicks GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks Get email email clicks
StorefrontApi get_email_email_customer_editor_url GET /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url Get email order customer editor url
StorefrontApi get_email_email_orders GET /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/orders Get email email orders
StorefrontApi get_email_emails GET /storefront/{storefront_oid}/email/emails Get email emails
StorefrontApi get_email_emails_multiple POST /storefront/{storefront_oid}/email/emails/multiple Get email emails multiple
StorefrontApi get_email_flow GET /storefront/{storefront_oid}/email/flows/{email_flow_uuid} Get email flow
StorefrontApi get_email_flow_folder GET /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Get email flow folder
StorefrontApi get_email_flow_folders GET /storefront/{storefront_oid}/email/flow_folders Get email flow folders
StorefrontApi get_email_flow_screenshots GET /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/screenshots Get email flow screenshots
StorefrontApi get_email_flows GET /storefront/{storefront_oid}/email/flows Get email flows
StorefrontApi get_email_global_settings GET /storefront/email/global_settings Get email globalsettings
StorefrontApi get_email_list GET /storefront/{storefront_oid}/email/lists/{email_list_uuid} Get email list
StorefrontApi get_email_list_customer_editor_url GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url Get email list customer editor url
StorefrontApi get_email_list_customers GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers Get email list customers
StorefrontApi get_email_lists GET /storefront/{storefront_oid}/email/lists Get email lists
StorefrontApi get_email_performance GET /storefront/{storefront_oid}/email/performance Get email performance
StorefrontApi get_email_plan GET /storefront/{storefront_oid}/email/plan Get email plan
StorefrontApi get_email_postcard GET /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Get email postcard
StorefrontApi get_email_postcards GET /storefront/{storefront_oid}/email/postcards Get email postcards
StorefrontApi get_email_postcards_multiple POST /storefront/{storefront_oid}/email/postcards/multiple Get email postcards multiple
StorefrontApi get_email_segment GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid} Get email segment
StorefrontApi get_email_segment_customer_editor_url GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url Get email segment customers editor URL
StorefrontApi get_email_segment_customers GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers Get email segment customers
StorefrontApi get_email_segments GET /storefront/{storefront_oid}/email/segments Get email segments
StorefrontApi get_email_sending_domain GET /storefront/email/sending_domain/{domain} Get email sending domain
StorefrontApi get_email_sending_domain_status POST /storefront/email/sending_domains/{domain}/status Get email sending domain status
StorefrontApi get_email_sending_domains GET /storefront/email/sending_domains Get email sending domains
StorefrontApi get_email_settings GET /storefront/{storefront_oid}/email/settings Get email settings
StorefrontApi get_email_template GET /storefront/{storefront_oid}/email/templates/{email_template_oid} Get email template
StorefrontApi get_email_templates GET /storefront/{storefront_oid}/email/templates Get email templates
StorefrontApi get_email_third_party_providers GET /storefront/{storefront_oid}/email/third_party_providers Get a list of third party email providers
StorefrontApi get_experiments GET /storefront/{storefront_oid}/experiments Get experiments
StorefrontApi get_histogram_property_names GET /storefront/{storefront_oid}/email/histogram/property_names Get histogram property names
StorefrontApi get_histogram_property_values GET /storefront/{storefront_oid}/email/histogram/property_values Get histogram property values
StorefrontApi get_library_filter_values GET /storefront/code_library/filter_values Get library values used to populate drop down boxes for filtering.
StorefrontApi get_library_item GET /storefront/code_library/{library_item_oid} Get library item.
StorefrontApi get_library_item_published_versions GET /storefront/code_library/{library_item_oid}/published_versions Get all published versions for a library item.
StorefrontApi get_pricing_tiers GET /storefront/pricing_tiers Retrieve pricing tiers
StorefrontApi get_screen_recording GET /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid} Get screen recording
StorefrontApi get_screen_recording_page_view_data GET /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/page_view_data/{screen_recording_page_view_uuid} Get screen recording page view data
StorefrontApi get_screen_recording_segment GET /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Get screen recording segment
StorefrontApi get_screen_recording_segments GET /storefront/{storefront_oid}/screen_recordings/segments Get screen recording segments
StorefrontApi get_screen_recording_settings GET /storefront/{storefront_oid}/screen_recordings/settings Get screen recording settings
StorefrontApi get_screen_recording_tags POST /storefront/{storefront_oid}/screen_recordings/tags Get tags used by screen recording
StorefrontApi get_screen_recordings_by_query POST /storefront/{storefront_oid}/screen_recordings/query Query screen recordings
StorefrontApi get_screen_recordings_by_segment POST /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query Get screen recordings by segment
StorefrontApi get_thumbnail_parameters POST /storefront/thumbnailParameters Get thumbnail parameters
StorefrontApi get_transaction_email GET /storefront/{storefront_oid}/transaction_email/list/{email_id} Gets a transaction email object
StorefrontApi get_transaction_email_list GET /storefront/{storefront_oid}/transaction_email/list Gets a list of transaction email names
StorefrontApi get_transaction_email_screenshots GET /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots Get transactional email screenshots
StorefrontApi global_unsubscribe POST /storefront/{storefront_oid}/email/globalUnsubscribe Globally unsubscribe a customer
StorefrontApi import_email_third_party_provider_list POST /storefront/{storefront_oid}/email/third_party_providers/import Import a third party provider list
StorefrontApi insert_email_campaign POST /storefront/{storefront_oid}/email/campaigns Insert email campaign
StorefrontApi insert_email_campaign_folder POST /storefront/{storefront_oid}/email/campaign_folders Insert email campaign folder
StorefrontApi insert_email_commseq POST /storefront/{storefront_oid}/email/commseqs Insert email commseq
StorefrontApi insert_email_email POST /storefront/{storefront_oid}/email/emails Insert email email
StorefrontApi insert_email_flow POST /storefront/{storefront_oid}/email/flows Insert email flow
StorefrontApi insert_email_flow_folder POST /storefront/{storefront_oid}/email/flow_folders Insert email flow folder
StorefrontApi insert_email_list POST /storefront/{storefront_oid}/email/lists Insert email list
StorefrontApi insert_email_postcard POST /storefront/{storefront_oid}/email/postcards Insert email postcard
StorefrontApi insert_email_segment POST /storefront/{storefront_oid}/email/segments Insert email segment
StorefrontApi insert_screen_recording_segment POST /storefront/{storefront_oid}/screen_recordings/segments Insert screen recording segment
StorefrontApi prepare_download_email_segment POST /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare Prepare download of email segment
StorefrontApi publish_library_item POST /storefront/code_library/{library_item_oid}/publish Publish library item.
StorefrontApi purchase_library_item 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 release_email_commseq_step_waiting POST /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid} Release email communication sequence customers waiting at the specified step
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 search_email_list_customers GET /storefront/{storefront_oid}/email/lists/{email_list_uuid}/search Search email list customers
StorefrontApi search_email_segment_customers GET /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/search Search email segment customers
StorefrontApi search_library_items POST /storefront/code_library/search Retrieve library items
StorefrontApi search_published_items POST /storefront/code_library/search_published Retrieve library items
StorefrontApi search_review_items POST /storefront/code_library/search_review Retrieve library items needing review or rejected
StorefrontApi search_shared_items POST /storefront/code_library/search_shared Retrieve library items
StorefrontApi send_email_test POST /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test Send email test
StorefrontApi send_postcard_test POST /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test Send postcard test
StorefrontApi start_email_campaign PUT /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start Start email campaign
StorefrontApi subscribe_to_email_list POST /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe Subscribe customers to email list
StorefrontApi unfavorite_screen_recording DELETE /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite Remove favorite flag on screen recording
StorefrontApi update_email_campaign PUT /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid} Update email campaign
StorefrontApi update_email_campaign_folder PUT /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} Update email campaign folder
StorefrontApi update_email_commseq PUT /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} Update email commseq
StorefrontApi update_email_customer PUT /storefront/{storefront_oid}/email/customers/{email_customer_uuid} Update email customer
StorefrontApi update_email_email PUT /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} Update email email
StorefrontApi update_email_flow PUT /storefront/{storefront_oid}/email/flows/{email_flow_uuid} Update email flow
StorefrontApi update_email_flow_folder PUT /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} Update email flow folder
StorefrontApi update_email_global_settings POST /storefront/email/global_settings Update email global settings
StorefrontApi update_email_list PUT /storefront/{storefront_oid}/email/lists/{email_list_uuid} Update email list
StorefrontApi update_email_plan POST /storefront/{storefront_oid}/email/plan Update email plan
StorefrontApi update_email_postcard PUT /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} Update email postcard
StorefrontApi update_email_segment PUT /storefront/{storefront_oid}/email/segments/{email_segment_uuid} Update email segment
StorefrontApi update_email_settings POST /storefront/{storefront_oid}/email/settings Update email settings
StorefrontApi update_experiment PUT /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} Update experiment
StorefrontApi update_library_item PUT /storefront/code_library/{library_item_oid} Update library item. Note that only certain fields may be updated via this method.
StorefrontApi update_screen_recording_merchant_notes POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes Update merchant notes on a screen recording
StorefrontApi update_screen_recording_segment POST /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} Update screen recording segment
StorefrontApi update_screen_recording_settings POST /storefront/{storefront_oid}/screen_recordings/settings Update screen recording settings
StorefrontApi update_screen_recording_tags POST /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags Update tags on a screen recording
StorefrontApi update_transaction_email PUT /storefront/{storefront_oid}/transaction_email/list/{email_id} Updates a transaction email object
TaxApi delete_tax_provider_self_city DELETE /tax/providers/self/city/{city} Deletes a Self tax provider city
TaxApi delete_tax_provider_self_country DELETE /tax/providers/self/country/{countryCode} Deletes a Self tax provider country
TaxApi delete_tax_provider_self_county DELETE /tax/providers/self/county/{county} Deletes a Self tax provider county
TaxApi delete_tax_provider_self_postal_code DELETE /tax/providers/self/postalCode/{postal_code} Deletes a Self tax provider postalCode
TaxApi delete_tax_provider_self_state DELETE /tax/providers/self/state/{stateCode} Deletes a Self tax provider state
TaxApi get_tax_provider_avalara GET /tax/providers/avalara Retrieve the Avalara tax provider
TaxApi get_tax_provider_avalara_companies POST /tax/providers/avalara/companies Returns Avalara Tax companies configured by the merchant
TaxApi get_tax_provider_avalara_test GET /tax/providers/avalara/test Attempts to connect to Avalara and returns back the response
TaxApi get_tax_provider_self GET /tax/providers/self Retrieve the Self tax provider
TaxApi get_tax_provider_self_countries GET /tax/providers/self/countries Retrieve the Self tax provider countries
TaxApi get_tax_provider_self_regions_by_country_code GET /tax/providers/self/regions/{countryCode} Retrieve the Self tax provider regions for a given country code
TaxApi get_tax_provider_sovos GET /tax/providers/sovos Retrieve the Sovos tax provider
TaxApi get_tax_provider_sovos_test GET /tax/providers/sovos/test Attempts to connect to Sovos and returns back the response
TaxApi get_tax_provider_tax_jar GET /tax/providers/taxjar Retrieve the TaxJar tax provider
TaxApi get_tax_provider_tax_jar_test GET /tax/providers/taxjar/test Attempts to connect to TaxJar and returns back the response
TaxApi get_tax_provider_ultra_cart GET /tax/providers/ultracart Retrieve the UltraCart tax provider
TaxApi get_tax_providers GET /tax/providers Retrieve tax methods
TaxApi set_active_tax_provider POST /tax/providers/setActive/{providerName} Toggle a tax provider to active
TaxApi update_tax_provider_avalara POST /tax/providers/avalara Update the Avalara tax provider
TaxApi update_tax_provider_self POST /tax/providers/self Update the Self tax provider
TaxApi update_tax_provider_self_city POST /tax/providers/self/city/{city} Updates a Self tax provider city
TaxApi update_tax_provider_self_country POST /tax/providers/self/country/{countryCode} Updates a Self tax provider country
TaxApi update_tax_provider_self_county POST /tax/providers/self/county/{county} Updates a Self tax provider county
TaxApi update_tax_provider_self_postal_code POST /tax/providers/self/postalCode/{postal_code} Updates a Self tax provider postalCode
TaxApi update_tax_provider_self_state POST /tax/providers/self/state/{stateCode} Updates a Self tax provider state
TaxApi update_tax_provider_sovos POST /tax/providers/sovos Update the Sovos tax provider
TaxApi update_tax_provider_tax_jar POST /tax/providers/taxjar Update the TaxJar tax provider
TaxApi update_tax_provider_ultra_cart POST /tax/providers/ultracart Update the UltraCart tax provider
UserApi delete_group DELETE /user/groups/{group_oid} Delete a group
UserApi delete_user DELETE /user/users/{user_id} Delete a user
UserApi get_group GET /user/groups/{group_oid} Retrieve a group
UserApi get_groups GET /user/groups Get groups
UserApi get_user GET /user/users/{user_id} Retrieve a user
UserApi get_user_logins GET /user/users/{user_id}/logins Retrieve a user's login history
UserApi get_users GET /user/users Get users
UserApi insert_group POST /user/groups Insert a group
UserApi insert_user POST /user/users Insert a user
UserApi update_group PUT /user/groups/{group_oid} Update a group
UserApi update_user PUT /user/users/{user_id} Update a user
WebhookApi delete_webhook DELETE /webhook/webhooks/{webhookOid} Delete a webhook
WebhookApi delete_webhook_by_url DELETE /webhook/webhooks Delete a webhook by URL
WebhookApi get_webhook_log GET /webhook/webhooks/{webhookOid}/logs/{requestId} Retrieve an individual log
WebhookApi get_webhook_log_summaries GET /webhook/webhooks/{webhookOid}/logs Retrieve the log summaries
WebhookApi get_webhooks GET /webhook/webhooks Retrieve webhooks
WebhookApi insert_webhook POST /webhook/webhooks Add a webhook
WebhookApi resend_event POST /webhook/webhooks/{webhookOid}/reflow/{eventName} Resend events to the webhook endpoint.
WebhookApi update_webhook 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

Author

support@ultracart.com

CHANGE LOG

Not every change is committed to every SDK.

Version Date Comments
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.