ultracart_api
UltracartClient - the Ruby gem for the UltraCart 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.8.2
- Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit http://www.ultracart.com
Installation
Build a gem
To build the Ruby code into a gem:
“ell gem build ultracart_api.gemspec
“
Then either install the gem locally:
“ell gem install ./ultracart_api-3.8.2.gem
“for development, run gem install --dev ./ultracart_api-3.8.2.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'ultracart_api', '~> 3.8.2'Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/UltraCart/rest_api_v2_sdk_ruby, then add the following in the Gemfile:
gem 'ultracart_api', :git => 'https://github.com/UltraCart/rest_api_v2_sdk_ruby.git'Include the Ruby code directly
Include the Ruby code directly using -I as follows:
“ell ruby -Ilib script.rb
“
Getting Started
Please follow the installation procedure and then run the following code:
“by
Load the gem
require ‘ultracart_api’
Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = ‘109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00’ api_instance = UltracartClient::AffiliateApi.new_using_api_key(simple_key, false, false)
api_instance = UltracartClient::AffiliateApi.new
click_query = UltracartClient::AffiliateClickQuery.new # AffiliateClickQuery | Click query
opts = { limit: 10000, # Integer | The maximum number of records to return on this one API call. (Maximum 10000)offset: 0, # Integer | 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. }
begin #Retrieve clicks result = api_instance.get_clicks_by_query(click_query, opts) p result rescue UltracartClient::ApiError => e puts “Exception when calling AffiliateApi->get_clicks_by_query: #e” end
“
Documentation for API Endpoints
All URIs are relative to https://secure.ultracart.com/rest/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| UltracartClient::AffiliateApi | get_clicks_by_query | POST /affiliate/clicks/query | Retrieve clicks |
| UltracartClient::AffiliateApi | get_ledgers_by_query | POST /affiliate/ledgers/query | Retrieve ledger entries |
| UltracartClient::AutoOrderApi | get_auto_order | GET /auto_order/auto_orders/auto_order_oid | Retrieve an auto order by oid |
| UltracartClient::AutoOrderApi | get_auto_order_by_code | GET /auto_order/auto_orders/code/auto_order_code | Retrieve an auto order by code |
| UltracartClient::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 |
| UltracartClient::AutoOrderApi | get_auto_orders | GET /auto_order/auto_orders | Retrieve auto orders |
| UltracartClient::AutoOrderApi | get_auto_orders_batch | POST /auto_order/auto_orders/batch | Retrieve auto order batch |
| UltracartClient::AutoOrderApi | get_auto_orders_by_query | POST /auto_order/auto_orders/query | Retrieve auto orders by query |
| UltracartClient::AutoOrderApi | update_auto_order | PUT /auto_order/auto_orders/auto_order_oid | Update an auto order |
| UltracartClient::AutoOrderApi | update_auto_orders_batch | PUT /auto_order/auto_orders/batch | Update multiple auto orders |
| UltracartClient::ChargebackApi | delete_chargeback | DELETE /chargeback/chargebacks/chargeback_dispute_oid | Delete a chargeback |
| UltracartClient::ChargebackApi | get_chargeback_dispute | GET /chargeback/chargebacks/chargeback_dispute_oid | Retrieve a chargeback |
| UltracartClient::ChargebackApi | get_chargeback_disputes | GET /chargeback/chargebacks | Retrieve chargebacks |
| UltracartClient::ChargebackApi | insert_chargeback | POST /chargeback/chargebacks | Insert a chargeback |
| UltracartClient::ChargebackApi | update_chargeback | PUT /chargeback/chargebacks/chargeback_dispute_oid | Update a chargeback |
| UltracartClient::CheckoutApi | city_state | POST /checkout/city_state | City/State for Zip |
| UltracartClient::CheckoutApi | finalize_order | POST /checkout/cart/finalizeOrder | Finalize Order |
| UltracartClient::CheckoutApi | get_affirm_checkout | GET /checkout/cart/cart_id/affirmCheckout | Get affirm checkout (by cart id) |
| UltracartClient::CheckoutApi | get_allowed_countries | POST /checkout/allowedCountries | Allowed countries |
| UltracartClient::CheckoutApi | get_cart | GET /checkout/cart | Get cart |
| UltracartClient::CheckoutApi | get_cart_by_cart_id | GET /checkout/cart/cart_id | Get cart (by cart id) |
| UltracartClient::CheckoutApi | get_cart_by_return_code | GET /checkout/return/return_code | Get cart (by return code) |
| UltracartClient::CheckoutApi | get_cart_by_return_token | GET /checkout/return_token | Get cart (by return token) |
| UltracartClient::CheckoutApi | get_state_provinces_for_country | POST /checkout/stateProvincesForCountry/country_code | Get state/province list for a country code |
| UltracartClient::CheckoutApi | handoff_cart | POST /checkout/cart/handoff | Handoff cart |
| UltracartClient::CheckoutApi | login | POST /checkout/cart/profile/login | Profile login |
| UltracartClient::CheckoutApi | logout | POST /checkout/cart/profile/logout | Profile logout |
| UltracartClient::CheckoutApi | register | POST /checkout/cart/profile/register | Profile registration |
| UltracartClient::CheckoutApi | register_affiliate_click | POST /checkout/affiliateClick/register | Register affiliate click |
| UltracartClient::CheckoutApi | related_items_for_cart | POST /checkout/related_items | Related items |
| UltracartClient::CheckoutApi | related_items_for_item | POST /checkout/relatedItems/item_id | Related items (specific item) |
| UltracartClient::CheckoutApi | setup_browser_key | PUT /checkout/browser_key | Setup Browser Application |
| UltracartClient::CheckoutApi | update_cart | PUT /checkout/cart | Update cart |
| UltracartClient::CheckoutApi | validate_cart | POST /checkout/cart/validate | Validate |
| UltracartClient::ConfigurationApi | delay_auto_orders | POST /configuration/checkout/payments/rtg/rtg_oid/delayAutoOrders | Delay auto order processing for a day for this rotating transaction gateway |
| UltracartClient::ConfigurationApi | delete_rotating_transaction_gateway | DELETE /configuration/checkout/payments/rtg/rtg_oid | Delete a rotating transaction gateway |
| UltracartClient::ConfigurationApi | get_payments_configuration | GET /configuration/checkout/payments | Retrieve payments configuration |
| UltracartClient::ConfigurationApi | get_payments_rotating_gateway | GET /configuration/checkout/payments/rtg/rtg_oid | Retrieve a rotating transaction gateway |
| UltracartClient::ConfigurationApi | get_payments_rotating_gateway_by_code | GET /configuration/checkout/payments/rtg/byCode/code | Retrieve a rotating transaction gateway by code |
| UltracartClient::ConfigurationApi | get_payments_rotating_transaction_gateways | GET /configuration/checkout/payments/rtg | Retrieve a list of rotating transaction gateways |
| UltracartClient::ConfigurationApi | get_payments_rtg_summaries | GET /configuration/checkout/payments/rtg/summaries | Retrieve a summary of rotating transaction gateways |
| UltracartClient::ConfigurationApi | get_payments_transaction_gateways | GET /configuration/checkout/payments/tg | Retrieve a list of transaction gateways |
| UltracartClient::ConfigurationApi | insert_rotating_transaction_gateway | POST /configuration/checkout/payments/rtg/ | Insert a rotating transaction gateway |
| UltracartClient::ConfigurationApi | migrate_to_rotating_transaction_gateway | POST /configuration/checkout/payments/tg/migrateToRtgWithCodeOf/code | Migrate a normal transaction gateway to a rotating transaction gateway |
| UltracartClient::ConfigurationApi | stripe_connect | POST /configuration/checkout/payments/rtg/rtg_oid/stripeConnect | Begin the processing of connecting with Stripe |
| UltracartClient::ConfigurationApi | update_payments_configuration | PUT /configuration/checkout/payments | Updates payments configuration |
| UltracartClient::ConfigurationApi | update_payments_transaction_gateway | PUT /configuration/checkout/payments/tg | Updates payments transaction gateway |
| UltracartClient::ConfigurationApi | update_rotating_transaction_gateway | PUT /configuration/checkout/payments/rtg/rtg_oid | Update a rotating transaction gateway |
| UltracartClient::ConfigurationApi | wepay_enroll | PUT /configuration/checkout/wepayEnroll | Enroll with WePay |
| UltracartClient::CouponApi | delete_coupon | DELETE /coupon/coupons/coupon_oid | Delete a coupon |
| UltracartClient::CouponApi | delete_coupons_by_code | DELETE /coupon/coupons/by_code | Deletes multiple coupons |
| UltracartClient::CouponApi | delete_coupons_by_oid | DELETE /coupon/coupons/by_oid | Deletes multiple coupons |
| UltracartClient::CouponApi | does_coupon_code_exist | GET /coupon/coupons/merchant_code/merchant_code/exists | Determines if a coupon merchant code already exists |
| UltracartClient::CouponApi | generate_coupon_codes | POST /coupon/coupons/coupon_oid/generate_codes | Generates one time codes for a coupon |
| UltracartClient::CouponApi | generate_one_time_codes_by_merchant_code | POST /coupon/coupons/merchant_code/merchant_code/generate_codes | Generates one time codes by merchant code |
| UltracartClient::CouponApi | get_auto_apply | GET /coupon/auto_apply | Retrieve auto apply rules and conditions |
| UltracartClient::CouponApi | get_coupon | GET /coupon/coupons/coupon_oid | Retrieve a coupon |
| UltracartClient::CouponApi | get_coupon_by_merchant_code | GET /coupon/coupons/merchant_code/merchant_code | Retrieve a coupon by merchant code |
| UltracartClient::CouponApi | get_coupons | GET /coupon/coupons | Retrieve coupons |
| UltracartClient::CouponApi | get_coupons_by_query | POST /coupon/coupons/query | Retrieve coupons by query |
| UltracartClient::CouponApi | get_editor_values | GET /coupon/editor_values | Retrieve values needed for a coupon editor |
| UltracartClient::CouponApi | insert_coupon | POST /coupon/coupons | Insert a coupon |
| UltracartClient::CouponApi | insert_coupons | POST /coupon/coupons/batch | Insert multiple coupons |
| UltracartClient::CouponApi | search_items | GET /coupon/searchItems | Searches for items to display within a coupon editor and assign to coupons |
| UltracartClient::CouponApi | update_auto_apply | POST /coupon/auto_apply | Update auto apply rules and conditions |
| UltracartClient::CouponApi | update_coupon | PUT /coupon/coupons/coupon_oid | Update a coupon |
| UltracartClient::CouponApi | update_coupons | PUT /coupon/coupons/batch | Update multiple coupons |
| UltracartClient::CouponApi | upload_coupon_codes | POST /coupon/coupons/coupon_oid/upload_codes | Upload one-time codes for a coupon |
| UltracartClient::CustomerApi | delete_customer | DELETE /customer/customers/customer_profile_oid | Delete a customer |
| UltracartClient::CustomerApi | get_customer | GET /customer/customers/customer_profile_oid | Retrieve a customer |
| UltracartClient::CustomerApi | get_customer_by_email | GET /customer/customers/by_email/email | Retrieve a customer by Email |
| UltracartClient::CustomerApi | get_customer_editor_values | GET /customer/editor_values | Retrieve values needed for a customer profile editor |
| UltracartClient::CustomerApi | get_customer_email_lists | GET /customer/email_lists | Retrieve all email lists across all storefronts |
| UltracartClient::CustomerApi | get_customers | GET /customer/customers | Retrieve customers |
| UltracartClient::CustomerApi | get_customers_by_query | POST /customer/customers/query | Retrieve customers by query |
| UltracartClient::CustomerApi | get_customers_for_data_tables | POST /customer/customers/dataTables | Retrieve customers for DataTables plugin |
| UltracartClient::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 |
| UltracartClient::CustomerApi | insert_customer | POST /customer/customers | Insert a customer |
| UltracartClient::CustomerApi | update_customer | PUT /customer/customers/customer_profile_oid | Update a customer |
| UltracartClient::CustomerApi | update_customer_email_lists | POST /customer/customers/customer_profile_oid/email_lists | Update email list subscriptions for a customer |
| UltracartClient::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 |
| UltracartClient::FulfillmentApi | acknowledge_orders | PUT /fulfillment/distribution_centers/distribution_center_code/acknowledgements | Acknowledge receipt of orders. |
| UltracartClient::FulfillmentApi | generate_packing_slip | GET /fulfillment/distribution_centers/distribution_center_code/orders/order_id | Generate a packing slip for this order for the given distribution center. |
| UltracartClient::FulfillmentApi | get_distribution_center_orders | GET /fulfillment/distribution_centers/distribution_center_code/orders | Retrieve orders queued up for this distribution center. |
| UltracartClient::FulfillmentApi | get_distribution_centers | GET /fulfillment/distribution_centers | Retrieve distribution centers |
| UltracartClient::FulfillmentApi | ship_orders | POST /fulfillment/distribution_centers/distribution_center_code/shipments | Mark orders as shipped |
| UltracartClient::FulfillmentApi | update_inventory | POST /fulfillment/distribution_centers/distribution_center_code/inventory | Update inventory |
| UltracartClient::GiftCertificateApi | add_gift_certificate_ledger_entry | POST /gift_certificate/gift_certificates/gift_certificate_oid/ledger_entry | Add a gift certificate ledger entry |
| UltracartClient::GiftCertificateApi | create_gift_certificate | POST /gift_certificate/gift_certificates | Create a gift certificate |
| UltracartClient::GiftCertificateApi | delete_gift_certificate | DELETE /gift_certificate/gift_certificates/gift_certificate_oid | Delete a gift certificate |
| UltracartClient::GiftCertificateApi | get_gift_certificate_by_code | POST /gift_certificate/gift_certificates/by_code/code | Retrieve gift certificate by code |
| UltracartClient::GiftCertificateApi | get_gift_certificate_by_oid | POST /gift_certificate/gift_certificates/gift_certificate_oid | Retrieve gift certificate by oid |
| UltracartClient::GiftCertificateApi | get_gift_certificates_by_email | POST /gift_certificate/gift_certificates/by_email/email | Retrieve gift certificate by email |
| UltracartClient::GiftCertificateApi | get_gift_certificates_by_query | POST /gift_certificate/gift_certificates/query | Retrieve gift certificates by query |
| UltracartClient::GiftCertificateApi | update_gift_certificate | PUT /gift_certificate/gift_certificates/gift_certificate_oid | Update a gift certificate |
| UltracartClient::IntegrationLogApi | get_integration_log | GET /integration_log/query/pk/sk | Retrieve an integration log |
| UltracartClient::IntegrationLogApi | get_integration_log_file | GET /integration_log/query/pk/sk/uuid | Retrieve an integration log file |
| UltracartClient::IntegrationLogApi | get_integration_log_summaries_query | POST /integration_log/summary/query | Retrieve integration log summaries |
| UltracartClient::IntegrationLogApi | get_integration_logs_query | POST /integration_log/query | Retrieve integration logs |
| UltracartClient::ItemApi | delete_item | DELETE /item/items/merchant_item_oid | Delete an item |
| UltracartClient::ItemApi | get_item | GET /item/items/merchant_item_oid | Retrieve an item |
| UltracartClient::ItemApi | get_item_by_merchant_item_id | GET /item/items/merchant_item_id/merchant_item_id | Retrieve an item by item id |
| UltracartClient::ItemApi | get_items | GET /item/items | Retrieve items |
| UltracartClient::ItemApi | get_pricing_tiers | GET /item/pricing_tiers | Retrieve pricing tiers |
| UltracartClient::ItemApi | insert_item | POST /item/items | Create an item |
| UltracartClient::ItemApi | update_item | PUT /item/items/merchant_item_oid | Update an item |
| UltracartClient::ItemApi | update_items | PUT /item/items/batch | Update multiple items |
| UltracartClient::ItemApi | upload_temporary_multimedia | POST /item/temp_multimedia | Upload an image to the temporary multimedia. |
| UltracartClient::OauthApi | oauth_access_token | POST /oauth/token | Exchange authorization code for access token. |
| UltracartClient::OauthApi | oauth_revoke | POST /oauth/revoke | Revoke this OAuth application. |
| UltracartClient::OrderApi | adjust_order_total | POST /order/orders/order_id/adjust_order_total/desired_total | Adjusts an order total |
| UltracartClient::OrderApi | cancel_order | POST /order/orders/order_id/cancel | Cancel an order |
| UltracartClient::OrderApi | delete_order | DELETE /order/orders/order_id | Delete an order |
| UltracartClient::OrderApi | format | POST /order/orders/order_id/format | Format order |
| UltracartClient::OrderApi | generate_order_token | GET /order/orders/token/order_id | Generate an order token for a given order id |
| UltracartClient::OrderApi | generate_packing_slip_all_dc | GET /order/orders/order_id/packing_slip | Generate a packing slip for this order across all distribution centers. |
| UltracartClient::OrderApi | generate_packing_slip_specific_dc | GET /order/orders/order_id/packing_slip/distribution_center_code | Generate a packing slip for this order for the given distribution center. |
| UltracartClient::OrderApi | get_accounts_receivable_retry_config | GET /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration |
| UltracartClient::OrderApi | get_accounts_receivable_retry_stats | GET /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics |
| UltracartClient::OrderApi | get_order | GET /order/orders/order_id | Retrieve an order |
| UltracartClient::OrderApi | get_order_by_token | POST /order/orders/token | Retrieve an order using a token |
| UltracartClient::OrderApi | get_orders | GET /order/orders | Retrieve orders |
| UltracartClient::OrderApi | get_orders_batch | POST /order/orders/batch | Retrieve order batch |
| UltracartClient::OrderApi | get_orders_by_query | POST /order/orders/query | Retrieve orders by query |
| UltracartClient::OrderApi | insert_order | POST /order/orders | Insert an order |
| UltracartClient::OrderApi | process_payment | POST /order/orders/order_id/process_payment | Process payment |
| UltracartClient::OrderApi | refund_order | PUT /order/orders/order_id/refund | Refund an order |
| UltracartClient::OrderApi | replacement | POST /order/orders/order_id/replacement | Replacement order |
| UltracartClient::OrderApi | resend_receipt | POST /order/orders/order_id/resend_receipt | Resend receipt |
| UltracartClient::OrderApi | resend_shipment_confirmation | POST /order/orders/order_id/resend_shipment_confirmation | Resend shipment confirmation |
| UltracartClient::OrderApi | update_accounts_receivable_retry_config | POST /order/accountsReceivableRetryConfig | Update A/R Retry Configuration |
| UltracartClient::OrderApi | update_order | PUT /order/orders/order_id | Update an order |
| UltracartClient::SsoApi | get_sso_session_user | GET /sso/session/user | Get single sign on session user |
| UltracartClient::SsoApi | sso_authorize | PUT /sso/authorize | Authorize a single sign on session |
| UltracartClient::SsoApi | sso_session_revoke | DELETE /sso/session/revoke | Revoke single sign on session |
| UltracartClient::SsoApi | sso_token | PUT /sso/token | Exchange a single sign on code for a simple key token |
| UltracartClient::StorefrontApi | add_to_library | POST /storefront/code_library | Add to library |
| UltracartClient::StorefrontApi | apply_to_store_front | POST /storefront/code_library/apply | Apply library item to storefront. |
| UltracartClient::StorefrontApi | archive_email_list | POST /storefront/storefront_oid/email/lists/email_list_uuid/archive | Archive email list |
| UltracartClient::StorefrontApi | archive_email_segment | POST /storefront/storefront_oid/email/segments/email_segment_uuid/archive | Archive email segment |
| UltracartClient::StorefrontApi | back_populate_email_flow | POST /storefront/storefront_oid/email/flows/email_flow_uuid/backfill | Back populate email flow |
| UltracartClient::StorefrontApi | check_download_email_segment | POST /storefront/storefront_oid/email/segments/email_segment_uuid/downloadPrepare/email_segment_rebuild_uuid | Check download of email segment |
| UltracartClient::StorefrontApi | clone_email_campaign | POST /storefront/storefront_oid/email/campaigns/email_campaign_uuid/clone | Clone email campaign |
| UltracartClient::StorefrontApi | clone_email_flow | POST /storefront/storefront_oid/email/flows/email_flow_uuid/clone | Clone email flow |
| UltracartClient::StorefrontApi | create_email_sending_domain | POST /storefront/email/sending_domains/domain/create | Create email campaign |
| UltracartClient::StorefrontApi | create_twilio_account | POST /storefront/twilio/accounts | Create Twilio account |
| UltracartClient::StorefrontApi | delete_email_campaign_folder | DELETE /storefront/storefront_oid/email/campaign_folders/email_campaign_folder_uuid | Delete email campaignFolder |
| UltracartClient::StorefrontApi | delete_email_commseq_stat | DELETE /storefront/storefront_oid/email/commseqs/commseq_uuid/stat | Delete communication sequence stats |
| UltracartClient::StorefrontApi | delete_email_email | DELETE /storefront/storefront_oid/email/emails/commseq_email_uuid | Delete email email |
| UltracartClient::StorefrontApi | delete_email_flow_folder | DELETE /storefront/storefront_oid/email/flow_folders/email_flow_folder_uuid | Delete email flowFolder |
| UltracartClient::StorefrontApi | delete_email_list_customer | DELETE /storefront/storefront_oid/email/lists/email_list_uuid/customers/email_customer_uuid | Delete email list customer |
| UltracartClient::StorefrontApi | delete_email_list_segment_folder | DELETE /storefront/storefront_oid/email/list_segment_folders/email_list_segment_folder_uuid | Delete email ListSegmentFolder |
| UltracartClient::StorefrontApi | delete_email_postcard | DELETE /storefront/storefront_oid/email/postcards/commseq_postcard_uuid | Delete email postcard |
| UltracartClient::StorefrontApi | delete_email_sending_domain | DELETE /storefront/email/sending_domains/domain | delete email campaign |
| UltracartClient::StorefrontApi | delete_experiment | DELETE /storefront/storefront_oid/experiments/storefront_experiment_oid | Delete experiment |
| UltracartClient::StorefrontApi | delete_heatmap | DELETE /storefront/storefront_oid/screen_recordings/heatmap | Delete screen recording heatmap |
| UltracartClient::StorefrontApi | delete_library_item | DELETE /storefront/code_library/library_item_oid | Delete library item |
| UltracartClient::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. |
| UltracartClient::StorefrontApi | delete_screen_recording_segment | DELETE /storefront/storefront_oid/screen_recordings/segments/screen_recording_segment_oid | Delete screen recording segment |
| UltracartClient::StorefrontApi | delete_twilio_account | DELETE /storefront/twilio/accounts/esp_twilio_uuid | delete Twilio account |
| UltracartClient::StorefrontApi | duplicate_library_item | POST /storefront/code_library/library_item_oid/duplicate | Duplicate library item. |
| UltracartClient::StorefrontApi | favorite_screen_recording | POST /storefront/storefront_oid/screen_recordings/screen_recording_uuid/favorite | Update favorite flag on screen recording |
| UltracartClient::StorefrontApi | geocode_address | POST /storefront/storefront_oid/email/geocode | Obtain lat/long for an address |
| UltracartClient::StorefrontApi | get_countries | GET /storefront/storefront_oid/email/countries | Get countries |
| UltracartClient::StorefrontApi | get_editor_token | GET /storefront/storefront_oid/editor_token | Gets editor token |
| UltracartClient::StorefrontApi | get_email_base_templates | GET /storefront/storefront_oid/email/baseTemplates | Get email communication base templates |
| UltracartClient::StorefrontApi | get_email_campaign | GET /storefront/storefront_oid/email/campaigns/email_campaign_uuid | Get email campaign |
| UltracartClient::StorefrontApi | get_email_campaign_folder | GET /storefront/storefront_oid/email/campaign_folders/email_campaign_folder_uuid | Get email campaign folder |
| UltracartClient::StorefrontApi | get_email_campaign_folders | GET /storefront/storefront_oid/email/campaign_folders | Get email campaign folders |
| UltracartClient::StorefrontApi | get_email_campaign_screenshots | GET /storefront/storefront_oid/email/campaigns/email_campaign_uuid/screenshots | Get email campaign screenshots |
| UltracartClient::StorefrontApi | get_email_campaigns | GET /storefront/storefront_oid/email/campaigns | Get email campaigns |
| UltracartClient::StorefrontApi | get_email_campaigns_with_stats | GET /storefront/storefront_oid/email/campaignsWithStats/stat_days | Get email campaigns with stats |
| UltracartClient::StorefrontApi | get_email_commseq | GET /storefront/storefront_oid/email/commseqs/commseq_uuid | Get email commseq |
| UltracartClient::StorefrontApi | get_email_commseq_email_stats | POST /storefront/storefront_oid/email/commseqs/commseq_uuid/emailStats | Get email communication sequence emails stats |
| UltracartClient::StorefrontApi | get_email_commseq_postcard_stats | POST /storefront/storefront_oid/email/commseqs/commseq_uuid/postcardStats | Get email communication sequence postcard stats |
| UltracartClient::StorefrontApi | get_email_commseq_stat_overall | GET /storefront/storefront_oid/email/commseqs/commseq_uuid/stat | Get communication sequence stats overall |
| UltracartClient::StorefrontApi | get_email_commseq_step_stats | POST /storefront/storefront_oid/email/commseqs/commseq_uuid/stepStats | Get email communication sequence step stats |
| UltracartClient::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 |
| UltracartClient::StorefrontApi | get_email_commseq_webhook_editor_values | GET /storefront/storefront_oid/email/commseqs/commseq_uuid/webhookEditorValues | Get email webhook editor values |
| UltracartClient::StorefrontApi | get_email_commseqs | GET /storefront/storefront_oid/email/commseqs | Get email commseqs |
| UltracartClient::StorefrontApi | get_email_customer_editor_url | GET /storefront/storefront_oid/email/customers/email_customer_uuid/editor_url | Get customers editor URL |
| UltracartClient::StorefrontApi | get_email_customers | GET /storefront/storefront_oid/email/customers | Get email customers |
| UltracartClient::StorefrontApi | get_email_dashboard_activity | GET /storefront/storefront_oid/email/dashboard_activity | Get email dashboard activity |
| UltracartClient::StorefrontApi | get_email_dashboard_stats | GET /storefront/storefront_oid/email/dashboard_stats | Get dashboard stats |
| UltracartClient::StorefrontApi | get_email_dispatch_logs | GET /storefront/storefront_oid/email/commseqs/commseq_uuid/steps/commseq_step_uuid/logs | Get email dispatch logs |
| UltracartClient::StorefrontApi | get_email_email | GET /storefront/storefront_oid/email/emails/commseq_email_uuid | Get email email |
| UltracartClient::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 |
| UltracartClient::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 |
| UltracartClient::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 |
| UltracartClient::StorefrontApi | get_email_emails | GET /storefront/storefront_oid/email/emails | Get email emails |
| UltracartClient::StorefrontApi | get_email_emails_multiple | POST /storefront/storefront_oid/email/emails/multiple | Get email emails multiple |
| UltracartClient::StorefrontApi | get_email_flow | GET /storefront/storefront_oid/email/flows/email_flow_uuid | Get email flow |
| UltracartClient::StorefrontApi | get_email_flow_folder | GET /storefront/storefront_oid/email/flow_folders/email_flow_folder_uuid | Get email flow folder |
| UltracartClient::StorefrontApi | get_email_flow_folders | GET /storefront/storefront_oid/email/flow_folders | Get email flow folders |
| UltracartClient::StorefrontApi | get_email_flow_screenshots | GET /storefront/storefront_oid/email/flows/email_flow_uuid/screenshots | Get email flow screenshots |
| UltracartClient::StorefrontApi | get_email_flows | GET /storefront/storefront_oid/email/flows | Get email flows |
| UltracartClient::StorefrontApi | get_email_global_settings | GET /storefront/email/global_settings | Get email globalsettings |
| UltracartClient::StorefrontApi | get_email_list | GET /storefront/storefront_oid/email/lists/email_list_uuid | Get email list |
| UltracartClient::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 |
| UltracartClient::StorefrontApi | get_email_list_customers | GET /storefront/storefront_oid/email/lists/email_list_uuid/customers | Get email list customers |
| UltracartClient::StorefrontApi | get_email_list_segment_folder | GET /storefront/storefront_oid/email/list_segment_folders/email_list_segment_folder_uuid | Get email campaign folder |
| UltracartClient::StorefrontApi | get_email_list_segment_folders | GET /storefront/storefront_oid/email/list_segment_folders | Get email campaign folders |
| UltracartClient::StorefrontApi | get_email_lists | GET /storefront/storefront_oid/email/lists | Get email lists |
| UltracartClient::StorefrontApi | get_email_performance | GET /storefront/storefront_oid/email/performance | Get email performance |
| UltracartClient::StorefrontApi | get_email_plan | GET /storefront/storefront_oid/email/plan | Get email plan |
| UltracartClient::StorefrontApi | get_email_postcard | GET /storefront/storefront_oid/email/postcards/commseq_postcard_uuid | Get email postcard |
| UltracartClient::StorefrontApi | get_email_postcards | GET /storefront/storefront_oid/email/postcards | Get email postcards |
| UltracartClient::StorefrontApi | get_email_postcards_multiple | POST /storefront/storefront_oid/email/postcards/multiple | Get email postcards multiple |
| UltracartClient::StorefrontApi | get_email_segment | GET /storefront/storefront_oid/email/segments/email_segment_uuid | Get email segment |
| UltracartClient::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 |
| UltracartClient::StorefrontApi | get_email_segment_customers | GET /storefront/storefront_oid/email/segments/email_segment_uuid/customers | Get email segment customers |
| UltracartClient::StorefrontApi | get_email_segments | GET /storefront/storefront_oid/email/segments | Get email segments |
| UltracartClient::StorefrontApi | get_email_sending_domain | GET /storefront/email/sending_domain/domain | Get email sending domain |
| UltracartClient::StorefrontApi | get_email_sending_domain_status | POST /storefront/email/sending_domains/domain/status | Get email sending domain status |
| UltracartClient::StorefrontApi | get_email_sending_domains | GET /storefront/email/sending_domains | Get email sending domains |
| UltracartClient::StorefrontApi | get_email_settings | GET /storefront/storefront_oid/email/settings | Get email settings |
| UltracartClient::StorefrontApi | get_email_template | GET /storefront/storefront_oid/email/templates/email_template_oid | Get email template |
| UltracartClient::StorefrontApi | get_email_templates | GET /storefront/storefront_oid/email/templates | Get email templates |
| UltracartClient::StorefrontApi | get_email_third_party_providers | GET /storefront/storefront_oid/email/third_party_providers | Get a list of third party email providers |
| UltracartClient::StorefrontApi | get_experiments | GET /storefront/storefront_oid/experiments | Get experiments |
| UltracartClient::StorefrontApi | get_heatmap | POST /storefront/storefront_oid/screen_recordings/heatmap | Get screen recording heatmap |
| UltracartClient::StorefrontApi | get_heatmap_index | POST /storefront/storefront_oid/screen_recordings/heatmap/index | Get screen recording heatmap index |
| UltracartClient::StorefrontApi | get_histogram_property_names | GET /storefront/storefront_oid/email/histogram/property_names | Get histogram property names |
| UltracartClient::StorefrontApi | get_histogram_property_values | GET /storefront/storefront_oid/email/histogram/property_values | Get histogram property values |
| UltracartClient::StorefrontApi | get_library_filter_values | GET /storefront/code_library/filter_values | Get library values used to populate drop down boxes for filtering. |
| UltracartClient::StorefrontApi | get_library_item | GET /storefront/code_library/library_item_oid | Get library item. |
| UltracartClient::StorefrontApi | get_library_item_published_versions | GET /storefront/code_library/library_item_oid/published_versions | Get all published versions for a library item. |
| UltracartClient::StorefrontApi | get_screen_recording | GET /storefront/storefront_oid/screen_recordings/screen_recording_uuid | Get screen recording |
| UltracartClient::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 |
| UltracartClient::StorefrontApi | get_screen_recording_segment | GET /storefront/storefront_oid/screen_recordings/segments/screen_recording_segment_oid | Get screen recording segment |
| UltracartClient::StorefrontApi | get_screen_recording_segments | GET /storefront/storefront_oid/screen_recordings/segments | Get screen recording segments |
| UltracartClient::StorefrontApi | get_screen_recording_settings | GET /storefront/storefront_oid/screen_recordings/settings | Get screen recording settings |
| UltracartClient::StorefrontApi | get_screen_recording_tags | POST /storefront/storefront_oid/screen_recordings/tags | Get tags used by screen recording |
| UltracartClient::StorefrontApi | get_screen_recordings_by_query | POST /storefront/storefront_oid/screen_recordings/query | Query screen recordings |
| UltracartClient::StorefrontApi | get_screen_recordings_by_segment | POST /storefront/storefront_oid/screen_recordings/segments/screen_recording_segment_oid/query | Get screen recordings by segment |
| UltracartClient::StorefrontApi | get_store_front_pricing_tiers | GET /storefront/pricing_tiers | Retrieve pricing tiers |
| UltracartClient::StorefrontApi | get_thumbnail_parameters | POST /storefront/thumbnailParameters | Get thumbnail parameters |
| UltracartClient::StorefrontApi | get_transaction_email | GET /storefront/storefront_oid/transaction_email/list/email_id | Gets a transaction email object |
| UltracartClient::StorefrontApi | get_transaction_email_list | GET /storefront/storefront_oid/transaction_email/list | Gets a list of transaction email names |
| UltracartClient::StorefrontApi | get_transaction_email_screenshots | GET /storefront/storefront_oid/transaction_email/list/email_id/screenshots | Get transactional email screenshots |
| UltracartClient::StorefrontApi | get_twilio_account | GET /storefront/twilio/accounts/esp_twilio_uuid | Get Twilio account |
| UltracartClient::StorefrontApi | get_twilio_accounts | GET /storefront/twilio/accounts | Get all Twilio accounts |
| UltracartClient::StorefrontApi | global_unsubscribe | POST /storefront/storefront_oid/email/globalUnsubscribe | Globally unsubscribe a customer |
| UltracartClient::StorefrontApi | import_email_third_party_provider_list | POST /storefront/storefront_oid/email/third_party_providers/import | Import a third party provider list |
| UltracartClient::StorefrontApi | insert_email_campaign | POST /storefront/storefront_oid/email/campaigns | Insert email campaign |
| UltracartClient::StorefrontApi | insert_email_campaign_folder | POST /storefront/storefront_oid/email/campaign_folders | Insert email campaign folder |
| UltracartClient::StorefrontApi | insert_email_commseq | POST /storefront/storefront_oid/email/commseqs | Insert email commseq |
| UltracartClient::StorefrontApi | insert_email_email | POST /storefront/storefront_oid/email/emails | Insert email email |
| UltracartClient::StorefrontApi | insert_email_flow | POST /storefront/storefront_oid/email/flows | Insert email flow |
| UltracartClient::StorefrontApi | insert_email_flow_folder | POST /storefront/storefront_oid/email/flow_folders | Insert email flow folder |
| UltracartClient::StorefrontApi | insert_email_list | POST /storefront/storefront_oid/email/lists | Insert email list |
| UltracartClient::StorefrontApi | insert_email_list_segment_folder | POST /storefront/storefront_oid/email/list_segment_folders | Insert email campaign folder |
| UltracartClient::StorefrontApi | insert_email_postcard | POST /storefront/storefront_oid/email/postcards | Insert email postcard |
| UltracartClient::StorefrontApi | insert_email_segment | POST /storefront/storefront_oid/email/segments | Insert email segment |
| UltracartClient::StorefrontApi | insert_screen_recording_segment | POST /storefront/storefront_oid/screen_recordings/segments | Insert screen recording segment |
| UltracartClient::StorefrontApi | prepare_download_email_segment | POST /storefront/storefront_oid/email/segments/email_segment_uuid/downloadPrepare | Prepare download of email segment |
| UltracartClient::StorefrontApi | publish_library_item | POST /storefront/code_library/library_item_oid/publish | Publish library item. |
| UltracartClient::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 |
| UltracartClient::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 |
| UltracartClient::StorefrontApi | review | POST /storefront/storefront_oid/email/emails/commseq_email_uuid/review | Request a review of an email |
| UltracartClient::StorefrontApi | search | GET /storefront/search | Searches for all matching values |
| UltracartClient::StorefrontApi | search2 | POST /storefront/search | Searches for all matching values (using POST) |
| UltracartClient::StorefrontApi | search_email_list_customers | GET /storefront/storefront_oid/email/lists/email_list_uuid/search | Search email list customers |
| UltracartClient::StorefrontApi | search_email_segment_customers | GET /storefront/storefront_oid/email/segments/email_segment_uuid/search | Search email segment customers |
| UltracartClient::StorefrontApi | search_library_items | POST /storefront/code_library/search | Retrieve library items |
| UltracartClient::StorefrontApi | search_published_items | POST /storefront/code_library/search_published | Retrieve library items |
| UltracartClient::StorefrontApi | search_review_items | POST /storefront/code_library/search_review | Retrieve library items needing review or rejected |
| UltracartClient::StorefrontApi | search_shared_items | POST /storefront/code_library/search_shared | Retrieve library items |
| UltracartClient::StorefrontApi | send_email_test | POST /storefront/storefront_oid/email/emails/commseq_email_uuid/test | Send email test |
| UltracartClient::StorefrontApi | send_postcard_test | POST /storefront/storefront_oid/email/postcards/commseq_postcard_uuid/test | Send postcard test |
| UltracartClient::StorefrontApi | send_webhook_test | POST /storefront/storefront_oid/email/webhooks/test | Send webhook test |
| UltracartClient::StorefrontApi | start_email_campaign | PUT /storefront/storefront_oid/email/campaigns/email_campaign_uuid/start | Start email campaign |
| UltracartClient::StorefrontApi | subscribe_to_email_list | POST /storefront/storefront_oid/email/lists/email_list_uuid/subscribe | Subscribe customers to email list |
| UltracartClient::StorefrontApi | unfavorite_screen_recording | DELETE /storefront/storefront_oid/screen_recordings/screen_recording_uuid/favorite | Remove favorite flag on screen recording |
| UltracartClient::StorefrontApi | update_email_campaign | PUT /storefront/storefront_oid/email/campaigns/email_campaign_uuid | Update email campaign |
| UltracartClient::StorefrontApi | update_email_campaign_folder | PUT /storefront/storefront_oid/email/campaign_folders/email_campaign_folder_uuid | Update email campaign folder |
| UltracartClient::StorefrontApi | update_email_commseq | PUT /storefront/storefront_oid/email/commseqs/commseq_uuid | Update email commseq |
| UltracartClient::StorefrontApi | update_email_customer | PUT /storefront/storefront_oid/email/customers/email_customer_uuid | Update email customer |
| UltracartClient::StorefrontApi | update_email_email | PUT /storefront/storefront_oid/email/emails/commseq_email_uuid | Update email email |
| UltracartClient::StorefrontApi | update_email_flow | PUT /storefront/storefront_oid/email/flows/email_flow_uuid | Update email flow |
| UltracartClient::StorefrontApi | update_email_flow_folder | PUT /storefront/storefront_oid/email/flow_folders/email_flow_folder_uuid | Update email flow folder |
| UltracartClient::StorefrontApi | update_email_global_settings | POST /storefront/email/global_settings | Update email global settings |
| UltracartClient::StorefrontApi | update_email_list | PUT /storefront/storefront_oid/email/lists/email_list_uuid | Update email list |
| UltracartClient::StorefrontApi | update_email_list_segment_folder | PUT /storefront/storefront_oid/email/list_segment_folders/email_list_segment_folder_uuid | Update email campaign folder |
| UltracartClient::StorefrontApi | update_email_plan | POST /storefront/storefront_oid/email/plan | Update email plan |
| UltracartClient::StorefrontApi | update_email_postcard | PUT /storefront/storefront_oid/email/postcards/commseq_postcard_uuid | Update email postcard |
| UltracartClient::StorefrontApi | update_email_segment | PUT /storefront/storefront_oid/email/segments/email_segment_uuid | Update email segment |
| UltracartClient::StorefrontApi | update_email_settings | POST /storefront/storefront_oid/email/settings | Update email settings |
| UltracartClient::StorefrontApi | update_experiment | PUT /storefront/storefront_oid/experiments/storefront_experiment_oid | Update experiment |
| UltracartClient::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. |
| UltracartClient::StorefrontApi | update_screen_recording_merchant_notes | POST /storefront/storefront_oid/screen_recordings/screen_recording_uuid/merchant_notes | Update merchant notes on a screen recording |
| UltracartClient::StorefrontApi | update_screen_recording_segment | POST /storefront/storefront_oid/screen_recordings/segments/screen_recording_segment_oid | Update screen recording segment |
| UltracartClient::StorefrontApi | update_screen_recording_settings | POST /storefront/storefront_oid/screen_recordings/settings | Update screen recording settings |
| UltracartClient::StorefrontApi | update_screen_recording_tags | POST /storefront/storefront_oid/screen_recordings/screen_recording_uuid/tags | Update tags on a screen recording |
| UltracartClient::StorefrontApi | update_transaction_email | PUT /storefront/storefront_oid/transaction_email/list/email_id | Updates a transaction email object |
| UltracartClient::StorefrontApi | update_twilio_account | PUT /storefront/twilio/accounts/esp_twilio_uuid | Update Twilio account |
| UltracartClient::TaxApi | delete_tax_provider_self_city | DELETE /tax/providers/self/city/city | Deletes a Self tax provider city |
| UltracartClient::TaxApi | delete_tax_provider_self_country | DELETE /tax/providers/self/country/countryCode | Deletes a Self tax provider country |
| UltracartClient::TaxApi | delete_tax_provider_self_county | DELETE /tax/providers/self/county/county | Deletes a Self tax provider county |
| UltracartClient::TaxApi | delete_tax_provider_self_postal_code | DELETE /tax/providers/self/postalCode/postal_code | Deletes a Self tax provider postalCode |
| UltracartClient::TaxApi | delete_tax_provider_self_state | DELETE /tax/providers/self/state/stateCode | Deletes a Self tax provider state |
| UltracartClient::TaxApi | get_tax_provider_avalara | GET /tax/providers/avalara | Retrieve the Avalara tax provider |
| UltracartClient::TaxApi | get_tax_provider_avalara_companies | POST /tax/providers/avalara/companies | Returns Avalara Tax companies configured by the merchant |
| UltracartClient::TaxApi | get_tax_provider_avalara_test | GET /tax/providers/avalara/test | Attempts to connect to Avalara and returns back the response |
| UltracartClient::TaxApi | get_tax_provider_self | GET /tax/providers/self | Retrieve the Self tax provider |
| UltracartClient::TaxApi | get_tax_provider_self_countries | GET /tax/providers/self/countries | Retrieve the Self tax provider countries |
| UltracartClient::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 |
| UltracartClient::TaxApi | get_tax_provider_sovos | GET /tax/providers/sovos | Retrieve the Sovos tax provider |
| UltracartClient::TaxApi | get_tax_provider_sovos_test | GET /tax/providers/sovos/test | Attempts to connect to Sovos and returns back the response |
| UltracartClient::TaxApi | get_tax_provider_tax_jar | GET /tax/providers/taxjar | Retrieve the TaxJar tax provider |
| UltracartClient::TaxApi | get_tax_provider_tax_jar_test | GET /tax/providers/taxjar/test | Attempts to connect to TaxJar and returns back the response |
| UltracartClient::TaxApi | get_tax_provider_ultra_cart | GET /tax/providers/ultracart | Retrieve the UltraCart tax provider |
| UltracartClient::TaxApi | get_tax_providers | GET /tax/providers | Retrieve tax methods |
| UltracartClient::TaxApi | set_active_tax_provider | POST /tax/providers/setActive/providerName | Toggle a tax provider to active |
| UltracartClient::TaxApi | update_tax_provider_avalara | POST /tax/providers/avalara | Update the Avalara tax provider |
| UltracartClient::TaxApi | update_tax_provider_self | POST /tax/providers/self | Update the Self tax provider |
| UltracartClient::TaxApi | update_tax_provider_self_city | POST /tax/providers/self/city/city | Updates a Self tax provider city |
| UltracartClient::TaxApi | update_tax_provider_self_country | POST /tax/providers/self/country/countryCode | Updates a Self tax provider country |
| UltracartClient::TaxApi | update_tax_provider_self_county | POST /tax/providers/self/county/county | Updates a Self tax provider county |
| UltracartClient::TaxApi | update_tax_provider_self_postal_code | POST /tax/providers/self/postalCode/postal_code | Updates a Self tax provider postalCode |
| UltracartClient::TaxApi | update_tax_provider_self_state | POST /tax/providers/self/state/stateCode | Updates a Self tax provider state |
| UltracartClient::TaxApi | update_tax_provider_sovos | POST /tax/providers/sovos | Update the Sovos tax provider |
| UltracartClient::TaxApi | update_tax_provider_tax_jar | POST /tax/providers/taxjar | Update the TaxJar tax provider |
| UltracartClient::TaxApi | update_tax_provider_ultra_cart | POST /tax/providers/ultracart | Update the UltraCart tax provider |
| UltracartClient::UserApi | delete_group | DELETE /user/groups/group_oid | Delete a group |
| UltracartClient::UserApi | delete_user | DELETE /user/users/user_id | Delete a user |
| UltracartClient::UserApi | get_group | GET /user/groups/group_oid | Retrieve a group |
| UltracartClient::UserApi | get_groups | GET /user/groups | Get groups |
| UltracartClient::UserApi | get_user | GET /user/users/user_id | Retrieve a user |
| UltracartClient::UserApi | get_user_logins | GET /user/users/user_id/logins | Retrieve a user’s login history |
| UltracartClient::UserApi | get_users | GET /user/users | Get users |
| UltracartClient::UserApi | insert_group | POST /user/groups | Insert a group |
| UltracartClient::UserApi | insert_user | POST /user/users | Insert a user |
| UltracartClient::UserApi | update_group | PUT /user/groups/group_oid | Update a group |
| UltracartClient::UserApi | update_user | PUT /user/users/user_id | Update a user |
| UltracartClient::WebhookApi | delete_webhook | DELETE /webhook/webhooks/webhookOid | Delete a webhook |
| UltracartClient::WebhookApi | delete_webhook_by_url | DELETE /webhook/webhooks | Delete a webhook by URL |
| UltracartClient::WebhookApi | get_webhook_log | GET /webhook/webhooks/webhookOid/logs/requestId | Retrieve an individual log |
| UltracartClient::WebhookApi | get_webhook_log_summaries | GET /webhook/webhooks/webhookOid/logs | Retrieve the log summaries |
| UltracartClient::WebhookApi | get_webhooks | GET /webhook/webhooks | Retrieve webhooks |
| UltracartClient::WebhookApi | insert_webhook | POST /webhook/webhooks | Add a webhook |
| UltracartClient::WebhookApi | resend_event | POST /webhook/webhooks/webhookOid/reflow/eventName | Resend events to the webhook endpoint. |
| UltracartClient::WebhookApi | update_webhook | PUT /webhook/webhooks/webhookOid | Update a webhook |
Documentation for Models
- UltracartClient::AccountsReceivableRetryConfig
- UltracartClient::AccountsReceivableRetryConfigResponse
- UltracartClient::AccountsReceivableRetryDayActivity
- UltracartClient::AccountsReceivableRetryStatAccount
- UltracartClient::AccountsReceivableRetryStatMetrics
- UltracartClient::AccountsReceivableRetryStatRevenue
- UltracartClient::AccountsReceivableRetryStatsResponse
- UltracartClient::Activity
- UltracartClient::AddLibraryItemRequest
- UltracartClient::AffiliateClick
- UltracartClient::AffiliateClickQuery
- UltracartClient::AffiliateClicksResponse
- UltracartClient::AffiliateLedger
- UltracartClient::AffiliateLedgerQuery
- UltracartClient::AffiliateLedgersResponse
- UltracartClient::AffiliateLink
- UltracartClient::ApiUserApplicationProfile
- UltracartClient::ApplyLibraryItemRequest
- UltracartClient::ApplyLibraryItemResponse
- UltracartClient::AutoOrder
- UltracartClient::AutoOrderItem
- UltracartClient::AutoOrderItemFutureSchedule
- UltracartClient::AutoOrderItemOption
- UltracartClient::AutoOrderItemSimpleSchedule
- UltracartClient::AutoOrderLog
- UltracartClient::AutoOrderQuery
- UltracartClient::AutoOrderQueryBatch
- UltracartClient::AutoOrderResponse
- UltracartClient::AutoOrdersRequest
- UltracartClient::AutoOrdersResponse
- UltracartClient::AvalaraConfig
- UltracartClient::BaseResponse
- UltracartClient::Cart
- UltracartClient::CartAffiliate
- UltracartClient::CartAffirmCheckoutResponse
- UltracartClient::CartBilling
- UltracartClient::CartBuysafe
- UltracartClient::CartCheckout
- UltracartClient::CartCoupon
- UltracartClient::CartCurrencyConversion
- UltracartClient::CartCustomerProfile
- UltracartClient::CartCustomerProfileAddress
- UltracartClient::CartCustomerProfileCreditCard
- UltracartClient::CartFinalizeOrderRequest
- UltracartClient::CartFinalizeOrderRequestOptions
- UltracartClient::CartFinalizeOrderResponse
- UltracartClient::CartGift
- UltracartClient::CartGiftCertificate
- UltracartClient::CartItem
- UltracartClient::CartItemAttribute
- UltracartClient::CartItemMultimedia
- UltracartClient::CartItemMultimediaThumbnail
- UltracartClient::CartItemOption
- UltracartClient::CartItemOptionValue
- UltracartClient::CartItemPhysical
- UltracartClient::CartItemVariationSelection
- UltracartClient::CartKitComponentOption
- UltracartClient::CartMarketing
- UltracartClient::CartPayment
- UltracartClient::CartPaymentAffirm
- UltracartClient::CartPaymentAmazon
- UltracartClient::CartPaymentCheck
- UltracartClient::CartPaymentCreditCard
- UltracartClient::CartPaymentPurchaseOrder
- UltracartClient::CartProfileLoginRequest
- UltracartClient::CartProfileLoginResponse
- UltracartClient::CartProfileRegisterRequest
- UltracartClient::CartProfileRegisterResponse
- UltracartClient::CartProperty
- UltracartClient::CartResponse
- UltracartClient::CartSettings
- UltracartClient::CartSettingsBilling
- UltracartClient::CartSettingsGift
- UltracartClient::CartSettingsGiftWrap
- UltracartClient::CartSettingsPayment
- UltracartClient::CartSettingsPaymentAmazon
- UltracartClient::CartSettingsPaymentCreditCard
- UltracartClient::CartSettingsPaymentPayPal
- UltracartClient::CartSettingsProvince
- UltracartClient::CartSettingsShipping
- UltracartClient::CartSettingsShippingCalendar
- UltracartClient::CartSettingsShippingEstimate
- UltracartClient::CartSettingsTaxes
- UltracartClient::CartSettingsTerms
- UltracartClient::CartShipping
- UltracartClient::CartSummary
- UltracartClient::CartTaxes
- UltracartClient::CartUpsellAfter
- UltracartClient::CartValidationRequest
- UltracartClient::CartValidationResponse
- UltracartClient::ChargebackDispute
- UltracartClient::ChargebackDisputeResponse
- UltracartClient::ChargebackDisputesResponse
- UltracartClient::CheckoutAllowedCountriesResponse
- UltracartClient::CheckoutHandoffRequest
- UltracartClient::CheckoutHandoffResponse
- UltracartClient::CheckoutSetupBrowserKeyRequest
- UltracartClient::CheckoutSetupBrowserKeyResponse
- UltracartClient::CheckoutStateProvinceResponse
- UltracartClient::CityStateZip
- UltracartClient::CountriesResponse
- UltracartClient::Country
- UltracartClient::Coupon
- UltracartClient::CouponAmountOffItems
- UltracartClient::CouponAmountOffShipping
- UltracartClient::CouponAmountOffShippingWithItemsPurchase
- UltracartClient::CouponAmountOffSubtotal
- UltracartClient::CouponAmountOffSubtotalAndShipping
- UltracartClient::CouponAmountOffSubtotalFreeShippingWithPurchase
- UltracartClient::CouponAmountOffSubtotalWithBlockPurchase
- UltracartClient::CouponAmountOffSubtotalWithItemsPurchase
- UltracartClient::CouponAmountOffSubtotalWithPurchase
- UltracartClient::CouponAutoApplyCondition
- UltracartClient::CouponAutoApplyConditions
- UltracartClient::CouponAutomaticallyApplyCouponCodes
- UltracartClient::CouponBuyOneGetOneLimit
- UltracartClient::CouponCodesRequest
- UltracartClient::CouponCodesResponse
- UltracartClient::CouponDeletesRequest
- UltracartClient::CouponDiscountItemWithItemPurchase
- UltracartClient::CouponDiscountItems
- UltracartClient::CouponEditorValues
- UltracartClient::CouponExistsResponse
- UltracartClient::CouponFreeItemAndShippingWithSubtotal
- UltracartClient::CouponFreeItemWithItemPurchase
- UltracartClient::CouponFreeItemWithSubtotal
- UltracartClient::CouponFreeItemsWithItemPurchase
- UltracartClient::CouponFreeItemsWithMixMatchPurchase
- UltracartClient::CouponFreeShipping
- UltracartClient::CouponFreeShippingSpecificItems
- UltracartClient::CouponFreeShippingWithItemsPurchase
- UltracartClient::CouponFreeShippingWithSubtotal
- UltracartClient::CouponItemSearchResult
- UltracartClient::CouponItemSearchResultsResponse
- UltracartClient::CouponMultipleAmountsOffItems
- UltracartClient::CouponNoDiscount
- UltracartClient::CouponPercentOffItemWithItemsQuantityPurchase
- UltracartClient::CouponPercentOffItems
- UltracartClient::CouponPercentOffItemsAndFreeShipping
- UltracartClient::CouponPercentOffItemsWithItemsPurchase
- UltracartClient::CouponPercentOffMsrpItems
- UltracartClient::CouponPercentOffRetailPriceItems
- UltracartClient::CouponPercentOffShipping
- UltracartClient::CouponPercentOffSubtotal
- UltracartClient::CouponPercentOffSubtotalAndFreeShipping
- UltracartClient::CouponPercentOffSubtotalLimit
- UltracartClient::CouponPercentOffSubtotalWithItemsPurchase
- UltracartClient::CouponPercentOffSubtotalWithSubtotal
- UltracartClient::CouponQuery
- UltracartClient::CouponResponse
- UltracartClient::CouponRestriction
- UltracartClient::CouponTierAmount
- UltracartClient::CouponTierItemDiscount
- UltracartClient::CouponTierPercent
- UltracartClient::CouponTierQuantityAmount
- UltracartClient::CouponTierQuantityPercent
- UltracartClient::CouponTieredAmountOffItems
- UltracartClient::CouponTieredAmountOffSubtotal
- UltracartClient::CouponTieredPercentOffItems
- UltracartClient::CouponTieredPercentOffShipping
- UltracartClient::CouponTieredPercentOffSubtotal
- UltracartClient::CouponType
- UltracartClient::CouponsRequest
- UltracartClient::CouponsResponse
- UltracartClient::Currency
- UltracartClient::Customer
- UltracartClient::CustomerActivity
- UltracartClient::CustomerAffiliate
- UltracartClient::CustomerAttachment
- UltracartClient::CustomerBilling
- UltracartClient::CustomerCard
- UltracartClient::CustomerEditorValues
- UltracartClient::CustomerEmail
- UltracartClient::CustomerEmailListChanges
- UltracartClient::CustomerLoyalty
- UltracartClient::CustomerLoyaltyLedger
- UltracartClient::CustomerLoyaltyRedemption
- UltracartClient::CustomerOrdersSummary
- UltracartClient::CustomerPricingTier
- UltracartClient::CustomerPrivacy
- UltracartClient::CustomerQuery
- UltracartClient::CustomerQuotesSummary
- UltracartClient::CustomerResponse
- UltracartClient::CustomerReviewer
- UltracartClient::CustomerShipping
- UltracartClient::CustomerSoftwareEntitlement
- UltracartClient::CustomerTag
- UltracartClient::CustomerTaxCodes
- UltracartClient::CustomersResponse
- UltracartClient::DataTablesServerSideResponse
- UltracartClient::DelayAutoOrdersResponse
- UltracartClient::Distance
- UltracartClient::DistributionCenter
- UltracartClient::DistributionCentersResponse
- UltracartClient::EmailBaseTemplateListResponse
- UltracartClient::EmailCampaign
- UltracartClient::EmailCampaignFolder
- UltracartClient::EmailCampaignFolderResponse
- UltracartClient::EmailCampaignFoldersResponse
- UltracartClient::EmailCampaignResponse
- UltracartClient::EmailCampaignsResponse
- UltracartClient::EmailClick
- UltracartClient::EmailClicksResponse
- UltracartClient::EmailCommseq
- UltracartClient::EmailCommseqEmail
- UltracartClient::EmailCommseqEmailResponse
- UltracartClient::EmailCommseqEmailSendTestRequest
- UltracartClient::EmailCommseqEmailSendTestResponse
- UltracartClient::EmailCommseqEmailsRequest
- UltracartClient::EmailCommseqEmailsResponse
- UltracartClient::EmailCommseqPostcard
- UltracartClient::EmailCommseqPostcardResponse
- UltracartClient::EmailCommseqPostcardSendTestRequest
- UltracartClient::EmailCommseqPostcardSendTestResponse
- UltracartClient::EmailCommseqPostcardsRequest
- UltracartClient::EmailCommseqPostcardsResponse
- UltracartClient::EmailCommseqResponse
- UltracartClient::EmailCommseqStat
- UltracartClient::EmailCommseqStatResponse
- UltracartClient::EmailCommseqStep
- UltracartClient::EmailCommseqStepLog
- UltracartClient::EmailCommseqStepLogsResponse
- UltracartClient::EmailCommseqWebhookSendTestRequest
- UltracartClient::EmailCommseqsResponse
- UltracartClient::EmailCustomer
- UltracartClient::EmailCustomerEditorUrlResponse
- UltracartClient::EmailCustomersResponse
- UltracartClient::EmailDashboardActivity
- UltracartClient::EmailDashboardActivityResponse
- UltracartClient::EmailDashboardStatsResponse
- UltracartClient::EmailDomain
- UltracartClient::EmailEditorTokenResponse
- UltracartClient::EmailFlow
- UltracartClient::EmailFlowBackPopulateRequest
- UltracartClient::EmailFlowBackPopulateResponse
- UltracartClient::EmailFlowFolder
- UltracartClient::EmailFlowFolderResponse
- UltracartClient::EmailFlowFoldersResponse
- UltracartClient::EmailFlowResponse
- UltracartClient::EmailFlowsResponse
- UltracartClient::EmailGlobalSettings
- UltracartClient::EmailGlobalSettingsResponse
- UltracartClient::EmailGlobalUnsubscribeRequest
- UltracartClient::EmailGlobalUnsubscribeResponse
- UltracartClient::EmailHistogramPropertyNamesResponse
- UltracartClient::EmailHistogramPropertyValuesResponse
- UltracartClient::EmailList
- UltracartClient::EmailListArchiveResponse
- UltracartClient::EmailListCustomer
- UltracartClient::EmailListCustomersResponse
- UltracartClient::EmailListResponse
- UltracartClient::EmailListSegmentFolder
- UltracartClient::EmailListSegmentFolderResponse
- UltracartClient::EmailListSegmentFoldersResponse
- UltracartClient::EmailListSegmentMembership
- UltracartClient::EmailListSegmentUsedBy
- UltracartClient::EmailListSubscribeResponse
- UltracartClient::EmailListsResponse
- UltracartClient::EmailOrder
- UltracartClient::EmailOrdersResponse
- UltracartClient::EmailPerformance
- UltracartClient::EmailPerformanceCustomerHistogram
- UltracartClient::EmailPerformanceCustomerHistogramPeriod
- UltracartClient::EmailPerformanceDaily
- UltracartClient::EmailPerformanceResponse
- UltracartClient::EmailPlan
- UltracartClient::EmailPlanAdditional
- UltracartClient::EmailPlanResponse
- UltracartClient::EmailPostcardStat
- UltracartClient::EmailSegment
- UltracartClient::EmailSegmentArchiveResponse
- UltracartClient::EmailSegmentCustomer
- UltracartClient::EmailSegmentCustomersResponse
- UltracartClient::EmailSegmentDownloadPrepareResponse
- UltracartClient::EmailSegmentResponse
- UltracartClient::EmailSegmentsResponse
- UltracartClient::EmailSendingDomainResponse
- UltracartClient::EmailSendingDomainsResponse
- UltracartClient::EmailSettings
- UltracartClient::EmailSettingsResponse
- UltracartClient::EmailStat
- UltracartClient::EmailStatPostcardSummaryRequest
- UltracartClient::EmailStatPostcardSummaryResponse
- UltracartClient::EmailStatSummaryRequest
- UltracartClient::EmailStatSummaryResponse
- UltracartClient::EmailStepStat
- UltracartClient::EmailStepStatRequest
- UltracartClient::EmailStepStatResponse
- UltracartClient::EmailStepWaitingRequest
- UltracartClient::EmailStepWaitingResponse
- UltracartClient::EmailTemplate
- UltracartClient::EmailTemplatesResponse
- UltracartClient::EmailThirdPartyList
- UltracartClient::EmailThirdPartyListImportRequest
- UltracartClient::EmailThirdPartyProvider
- UltracartClient::EmailThirdPartyProvidersResponse
- UltracartClient::EmailVerifyTokenRequest
- UltracartClient::EmailVerifyTokenResponse
- UltracartClient::EmailVerifyTokenValidateRequest
- UltracartClient::EmailVerifyTokenValidateResponse
- UltracartClient::EmailWebhookEditorValuesResponse
- UltracartClient::Error
- UltracartClient::ErrorResponse
- UltracartClient::Experiment
- UltracartClient::ExperimentResponse
- UltracartClient::ExperimentVariation
- UltracartClient::ExperimentVariationStat
- UltracartClient::ExperimentsResponse
- UltracartClient::FulfillmentInventory
- UltracartClient::FulfillmentShipment
- UltracartClient::GeoPoint
- UltracartClient::GeocodeRequest
- UltracartClient::GeocodeResponse
- UltracartClient::GiftCertificate
- UltracartClient::GiftCertificateCreateRequest
- UltracartClient::GiftCertificateLedgerEntry
- UltracartClient::GiftCertificateQuery
- UltracartClient::GiftCertificateResponse
- UltracartClient::GiftCertificatesResponse
- UltracartClient::Group
- UltracartClient::GroupResponse
- UltracartClient::GroupUserMembership
- UltracartClient::GroupsResponse
- UltracartClient::HTTPHeader
- UltracartClient::IntegrationLog
- UltracartClient::IntegrationLogFile
- UltracartClient::IntegrationLogLog
- UltracartClient::IntegrationLogQueryFilterValues
- UltracartClient::IntegrationLogQueryRequest
- UltracartClient::IntegrationLogQueryResponse
- UltracartClient::IntegrationLogResponse
- UltracartClient::IntegrationLogSummary
- UltracartClient::IntegrationLogSummaryQueryRequest
- UltracartClient::IntegrationLogSummaryQueryResponse
- UltracartClient::Item
- UltracartClient::ItemAccounting
- UltracartClient::ItemAmember
- UltracartClient::ItemAutoOrder
- UltracartClient::ItemAutoOrderStep
- UltracartClient::ItemAutoOrderStepArbitraryUnitCostSchedule
- UltracartClient::ItemAutoOrderStepGrandfatherPricing
- UltracartClient::ItemCCBill
- UltracartClient::ItemChannelPartnerMapping
- UltracartClient::ItemChargeback
- UltracartClient::ItemChargebackAddendum
- UltracartClient::ItemChargebackAdjustmentRequest
- UltracartClient::ItemCheckout
- UltracartClient::ItemContent
- UltracartClient::ItemContentAssignment
- UltracartClient::ItemContentAttribute
- UltracartClient::ItemContentMultimedia
- UltracartClient::ItemContentMultimediaThumbnail
- UltracartClient::ItemDigitalDelivery
- UltracartClient::ItemDigitalItem
- UltracartClient::ItemEbay
- UltracartClient::ItemEbayCategorySpecific
- UltracartClient::ItemEbayMarketListing
- UltracartClient::ItemEbayMarketPlaceAnalysis
- UltracartClient::ItemEmailNotifications
- UltracartClient::ItemEnrollment123
- UltracartClient::ItemFulfillmentAddon
- UltracartClient::ItemGiftCertificate
- UltracartClient::ItemGoogleProductSearch
- UltracartClient::ItemIdentifiers
- UltracartClient::ItemInstantPaymentNotification
- UltracartClient::ItemInstantPaymentNotifications
- UltracartClient::ItemInternal
- UltracartClient::ItemKitComponent
- UltracartClient::ItemKitDefinition
- UltracartClient::ItemOption
- UltracartClient::ItemOptionValue
- UltracartClient::ItemOptionValueAdditionalItem
- UltracartClient::ItemOptionValueDigitalItem
- UltracartClient::ItemPaymentProcessing
- UltracartClient::ItemPhysical
- UltracartClient::ItemPricing
- UltracartClient::ItemPricingTier
- UltracartClient::ItemPricingTierDiscount
- UltracartClient::ItemPricingTierLimit
- UltracartClient::ItemProperty
- UltracartClient::ItemRealtimePricing
- UltracartClient::ItemRelated
- UltracartClient::ItemRelatedItem
- UltracartClient::ItemReporting
- UltracartClient::ItemResponse
- UltracartClient::ItemRestriction
- UltracartClient::ItemRestrictionItem
- UltracartClient::ItemRevguard
- UltracartClient::ItemReviews
- UltracartClient::ItemSalesforce
- UltracartClient::ItemShipping
- UltracartClient::ItemShippingCase
- UltracartClient::ItemShippingDestinationMarkup
- UltracartClient::ItemShippingDestinationRestriction
- UltracartClient::ItemShippingDistributionCenter
- UltracartClient::ItemShippingMethod
- UltracartClient::ItemShippingPackageRequirement
- UltracartClient::ItemTag
- UltracartClient::ItemTags
- UltracartClient::ItemTax
- UltracartClient::ItemTaxExemption
- UltracartClient::ItemThirdPartyEmailMarketing
- UltracartClient::ItemVariantItem
- UltracartClient::ItemVariation
- UltracartClient::ItemVariationOption
- UltracartClient::ItemWishlistMember
- UltracartClient::ItemsRequest
- UltracartClient::ItemsResponse
- UltracartClient::KeyValue
- UltracartClient::LibraryFilterValues
- UltracartClient::LibraryFilterValuesResponse
- UltracartClient::LibraryItem
- UltracartClient::LibraryItemAccount
- UltracartClient::LibraryItemAsset
- UltracartClient::LibraryItemAttribute
- UltracartClient::LibraryItemEmail
- UltracartClient::LibraryItemPublishedMeta
- UltracartClient::LibraryItemPurchasedMeta
- UltracartClient::LibraryItemQuery
- UltracartClient::LibraryItemResponse
- UltracartClient::LibraryItemScreenshot
- UltracartClient::LibraryItemsResponse
- UltracartClient::LinkedAccount
- UltracartClient::ListSegmentMembership
- UltracartClient::LookupRequest
- UltracartClient::LookupResponse
- UltracartClient::Metric
- UltracartClient::Notification
- UltracartClient::OauthRevokeSuccessResponse
- UltracartClient::OauthTokenResponse
- UltracartClient::Order
- UltracartClient::OrderAffiliate
- UltracartClient::OrderAffiliateLedger
- UltracartClient::OrderAutoOrder
- UltracartClient::OrderBilling
- UltracartClient::OrderBuysafe
- UltracartClient::OrderByTokenQuery
- UltracartClient::OrderChannelPartner
- UltracartClient::OrderCheckout
- UltracartClient::OrderCoupon
- UltracartClient::OrderDigitalItem
- UltracartClient::OrderDigitalOrder
- UltracartClient::OrderEdi
- UltracartClient::OrderFormat
- UltracartClient::OrderFormatResponse
- UltracartClient::OrderFraudScore
- UltracartClient::OrderGift
- UltracartClient::OrderGiftCertificate
- UltracartClient::OrderInternal
- UltracartClient::OrderItem
- UltracartClient::OrderItemEdi
- UltracartClient::OrderItemEdiIdentification
- UltracartClient::OrderItemEdiLot
- UltracartClient::OrderItemOption
- UltracartClient::OrderItemOptionFileAttachment
- UltracartClient::OrderItemProperty
- UltracartClient::OrderItemTag
- UltracartClient::OrderLinkedShipment
- UltracartClient::OrderMarketing
- UltracartClient::OrderPayment
- UltracartClient::OrderPaymentCheck
- UltracartClient::OrderPaymentCreditCard
- UltracartClient::OrderPaymentECheck
- UltracartClient::OrderPaymentInsurance
- UltracartClient::OrderPaymentPurchaseOrder
- UltracartClient::OrderPaymentTransaction
- UltracartClient::OrderPaymentTransactionDetail
- UltracartClient::OrderProcessPaymentRequest
- UltracartClient::OrderProcessPaymentResponse
- UltracartClient::OrderProperty
- UltracartClient::OrderQuery
- UltracartClient::OrderQueryBatch
- UltracartClient::OrderQuote
- UltracartClient::OrderReplacement
- UltracartClient::OrderReplacementItem
- UltracartClient::OrderReplacementResponse
- UltracartClient::OrderResponse
- UltracartClient::OrderSalesforce
- UltracartClient::OrderShipping
- UltracartClient::OrderSummary
- UltracartClient::OrderTag
- UltracartClient::OrderTaxes
- UltracartClient::OrderTokenResponse
- UltracartClient::OrderTrackingNumberDetail
- UltracartClient::OrderTrackingNumberDetails
- UltracartClient::OrdersResponse
- UltracartClient::PaymentsConfiguration
- UltracartClient::PaymentsConfigurationAffirm
- UltracartClient::PaymentsConfigurationAmazon
- UltracartClient::PaymentsConfigurationCOD
- UltracartClient::PaymentsConfigurationCash
- UltracartClient::PaymentsConfigurationCheck
- UltracartClient::PaymentsConfigurationCreditCard
- UltracartClient::PaymentsConfigurationCreditCardType
- UltracartClient::PaymentsConfigurationEcheck
- UltracartClient::PaymentsConfigurationInsurance
- UltracartClient::PaymentsConfigurationLoanHero
- UltracartClient::PaymentsConfigurationMoneyOrder
- UltracartClient::PaymentsConfigurationPayPal
- UltracartClient::PaymentsConfigurationPurchaseOrder
- UltracartClient::PaymentsConfigurationQuoteRequest
- UltracartClient::PaymentsConfigurationResponse
- UltracartClient::PaymentsConfigurationRestrictions
- UltracartClient::PaymentsConfigurationRestrictionsTheme
- UltracartClient::PaymentsConfigurationSezzle
- UltracartClient::PaymentsConfigurationTestMethod
- UltracartClient::PaymentsConfigurationWePay
- UltracartClient::PaymentsConfigurationWireTransfer
- UltracartClient::PaymentsThemeTransactionType
- UltracartClient::PaymentsWepayEnroll
- UltracartClient::Permission
- UltracartClient::PricingTier
- UltracartClient::PricingTierNotification
- UltracartClient::PricingTiersResponse
- UltracartClient::Property
- UltracartClient::PublishLibraryItemRequest
- UltracartClient::RegisterAffiliateClickRequest
- UltracartClient::RegisterAffiliateClickResponse
- UltracartClient::ResponseMetadata
- UltracartClient::ResultSet
- UltracartClient::RotatingTransactionGateway
- UltracartClient::RotatingTransactionGatewayResponse
- UltracartClient::RotatingTransactionGatewaysResponse
- UltracartClient::RtgCurrency
- UltracartClient::RtgDayOfMonthRestriction
- UltracartClient::RtgDayOfWeekRestriction
- UltracartClient::RtgSummaryGateway
- UltracartClient::RtgSummaryResponse
- UltracartClient::RtgThemeRestriction
- UltracartClient::ScreenRecording
- UltracartClient::ScreenRecordingAdPlatform
- UltracartClient::ScreenRecordingFilter
- UltracartClient::ScreenRecordingFilterGeoDistance
- UltracartClient::ScreenRecordingFilterIpSearch
- UltracartClient::ScreenRecordingFilterPageView
- UltracartClient::ScreenRecordingFilterPageViewEvent
- UltracartClient::ScreenRecordingFilterPageViewEventParam
- UltracartClient::ScreenRecordingFilterPageViewParam
- UltracartClient::ScreenRecordingFilterPageViewReferrerParam
- UltracartClient::ScreenRecordingFilterRangeBigDecimal
- UltracartClient::ScreenRecordingFilterRangeDate
- UltracartClient::ScreenRecordingFilterRangeInteger
- UltracartClient::ScreenRecordingFilterStringSearch
- UltracartClient::ScreenRecordingFilterValues
- UltracartClient::ScreenRecordingFilterValuesEvent
- UltracartClient::ScreenRecordingFilterValuesEventParams
- UltracartClient::ScreenRecordingFilterValuesPageParam
- UltracartClient::ScreenRecordingFilterValuesPageView
- UltracartClient::ScreenRecordingHeatmap
- UltracartClient::ScreenRecordingHeatmapIndexRequest
- UltracartClient::ScreenRecordingHeatmapIndexResponse
- UltracartClient::ScreenRecordingHeatmapRequest
- UltracartClient::ScreenRecordingHeatmapReset
- UltracartClient::ScreenRecordingHeatmapResponse
- UltracartClient::ScreenRecordingHeatmapUrl
- UltracartClient::ScreenRecordingMerchantNotesRequest
- UltracartClient::ScreenRecordingMultifield
- UltracartClient::ScreenRecordingPageView
- UltracartClient::ScreenRecordingPageViewDataResponse
- UltracartClient::ScreenRecordingPageViewEvent
- UltracartClient::ScreenRecordingPageViewEventParameter
- UltracartClient::ScreenRecordingPageViewParameter
- UltracartClient::ScreenRecordingQueryRequest
- UltracartClient::ScreenRecordingQueryResponse
- UltracartClient::ScreenRecordingResponse
- UltracartClient::ScreenRecordingSegment
- UltracartClient::ScreenRecordingSegmentResponse
- UltracartClient::ScreenRecordingSegmentsResponse
- UltracartClient::ScreenRecordingSettings
- UltracartClient::ScreenRecordingSettingsResponse
- UltracartClient::ScreenRecordingStoreFront
- UltracartClient::ScreenRecordingTagsRequest
- UltracartClient::ScreenRecordingTagsResponse
- UltracartClient::ScreenRecordingUserAgent
- UltracartClient::ScreenRecordingUserAgentDevice
- UltracartClient::ScreenRecordingUserAgentOS
- UltracartClient::ScreenRecordingUserProperty
- UltracartClient::ScreenshotsResponse
- UltracartClient::SelfConfig
- UltracartClient::SimpleValue
- UltracartClient::SingleSignOnAuthorizeRequest
- UltracartClient::SingleSignOnAuthorizeResponse
- UltracartClient::SingleSignOnTokenRequest
- UltracartClient::SingleSignOnTokenResponse
- UltracartClient::SovosConfig
- UltracartClient::StateProvince
- UltracartClient::StepWaiting
- UltracartClient::StripeConnectResponse
- UltracartClient::TaxCity
- UltracartClient::TaxCountry
- UltracartClient::TaxCountryCode
- UltracartClient::TaxCounty
- UltracartClient::TaxJarConfig
- UltracartClient::TaxPostalCode
- UltracartClient::TaxProviderActivateResult
- UltracartClient::TaxProviderAvalara
- UltracartClient::TaxProviderAvalaraCompaniesResult
- UltracartClient::TaxProviderAvalaraCompany
- UltracartClient::TaxProviderSelf
- UltracartClient::TaxProviderSelfCountriesResponse
- UltracartClient::TaxProviderSelfRegionsResponse
- UltracartClient::TaxProviderSovos
- UltracartClient::TaxProviderTaxJar
- UltracartClient::TaxProviderTestResult
- UltracartClient::TaxProviderUltraCart
- UltracartClient::TaxProviderUltraCartState
- UltracartClient::TaxProvidersResponse
- UltracartClient::TaxState
- UltracartClient::TaxStateCode
- UltracartClient::TempMultimedia
- UltracartClient::TempMultimediaResponse
- UltracartClient::ThumbnailParametersRequest
- UltracartClient::ThumbnailParametersResponse
- UltracartClient::TransactionEmail
- UltracartClient::TransactionEmailListResponse
- UltracartClient::TransactionEmailOption
- UltracartClient::TransactionEmailResponse
- UltracartClient::TransactionGateway
- UltracartClient::TransactionGatewaysRequest
- UltracartClient::TransactionGatewaysResponse
- UltracartClient::Twilio
- UltracartClient::TwilioResponse
- UltracartClient::TwiliosResponse
- UltracartClient::UltraCartConfig
- UltracartClient::UploadCouponCodesRequest
- UltracartClient::UploadCouponCodesResponse
- UltracartClient::User
- UltracartClient::UserGroupMembership
- UltracartClient::UserLogin
- UltracartClient::UserLoginsResponse
- UltracartClient::UserResponse
- UltracartClient::UsersResponse
- UltracartClient::VerificationRecord
- UltracartClient::Warning
- UltracartClient::Webhook
- UltracartClient::WebhookEventCategory
- UltracartClient::WebhookEventSubscription
- UltracartClient::WebhookLog
- UltracartClient::WebhookLogResponse
- UltracartClient::WebhookLogSummariesResponse
- UltracartClient::WebhookLogSummary
- UltracartClient::WebhookResponse
- UltracartClient::WebhookSampleRequest
- UltracartClient::WebhookSampleRequestResponse
- UltracartClient::WebhooksResponse
- UltracartClient::Weight
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.
- configuration_read: Allows you to read configuration information.
- configuration_write: Allows you to write configuration 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.
- gift_certificate_read: Allows you to read gift certificate information.
- gift_certificate_write: Allows you to write gift certificate information.
- integration_log_read: Allows you to read integration log information.
- integration_log_write: Allows you to write integration log 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.8.2 | 02/16/2022 | create gift certificate method was missing email |
| 3.8.1 | 02/16/2022 | auto order item level pause flag |
| 3.8.0 | 02/16/2022 | gift certificate api (testing) |
| 3.7.38 | 02/15/2022 | gift certificate api (currently in testing) |
| 3.6.38 | 02/07/2022 | Exposed auto order logs |
| 3.6.37 | 02/04/2022 | insurance type for insurance payments |
| 3.6.36 | 12/29/2021 | Mail actual post card flag added to test method |
| 3.6.35 | 12/14/2021 | Add cancel_auto_order option to the accounts receivable retry configuration |
| 3.6.34 | 12/14/2021 | add evening phone E.164 fields to order billing/shipping objects |
| 3.6.33 | 12/13/2021 | automation testing |
| 3.6.32 | 12/10/2021 | testing automation - message 4 |
| 3.6.25 | 12/06/2021 | sdk automation testing. no changes to actual sdk |
| 3.6.24 | 11/30/2021 | return items_invalid_for_coupons for CouponResponse object to drive UI warnings |
| 3.6.23 | 11/29/2021 | Item auto order prohibit cards that expire in months setting. |
| 3.6.22 | 11/23/2021 | new storefront methods for twilio configuration |
| 3.6.21 | 11/08/2021 | item shipping distribution center level CostOfGoodsSold |
| 3.6.20 | 11/05/2021 | additional item auto order step types |
| 3.6.19 | 10/05/2021 | item fulfillment add ons |
| 3.6.18 | 09/30/2021 | terms if auto order flag added |
| 3.6.16 | 09/30/2021 | item exclude from sitemap field |
| 3.6.15 | 09/28/2021 | added refund_claim_id to insurance object |
| 3.6.14 | 09/21/2021 | configuration api fix. the echeck test methods were attached to the paper check object |
| 3.6.13 | 09/20/2021 | expose EasyPost tracker id if available on shipment tracking details |
| 3.6.12 | 09/20/2021 | fix method for getCouponsByQuery to be POST instead of GET since it uses a JSON body |
| 3.6.11 | 09/13/2021 | fix for CouponApi, broke due to inadvertent parameter inclusion |
| 3.6.10 | 09/09/2021 | added constants for Google Shopping payment method (still in development) |
| 3.6.9 | 09/07/2021 | customer profile editor values have new list of state optional countries |
| 3.6.8 | 08/31/2021 | coupon query field to allow merchant code and description to be searched |
| 3.6.7 | 08/27/2021 | customer profile affiliate information now contains affiliate first and last name |
| 3.6.6 | 08/26/2021 | configuration api - more field changes for UI |
| 3.6.5 | 08/25/2021 | configuration api - removed some internal fields from sdk |
| 3.6.4 | 08/24/2021 | configuration api - new payment method named insurance |
| 3.6.1 | 08/23/2021 | configuration api - enum problems, also added order.item.tracking_number to support line item tracking numbers |
| 3.6.0 | 08/19/2021 | coupon api - changed tieredAmountOffItem to support mulitple items |
| 3.5.3 | 08/18/2021 | configuration api - added credit card rate to UltraCart Payments object |
| 3.5.1 | 08/11/2021 | email webhook test method |
| 3.5.0 | 08/11/2021 | RestOrderChannelPartner.store_completed was incorrectly defaulting to true |
| 3.4.13 | 08/10/2021 | configuration api - changed some field types form string to number |
| 3.4.12 | 08/10/2021 | email engine - added webhook editor values for internal ui |
| 3.4.9 | 08/05/2021 | configuration api - updated annotations for method names |
| 3.4.8 | 08/04/2021 | configuration api - payments config refactoring |
| 3.4.7 | 08/04/2021 | esp folders for lists/segments |
| 3.4.5 | 08/03/2021 | configuration api bug fix for a bad response object on updateRotatingTransactionGateway |
| 3.4.3 | 08/03/2021 | package tracking - add event_iso_date and event_timezone_id |
| 3.4.2 | 07/29/2021 | bug fixes for new configuration api |
| 3.4.1 | 07/29/2021 | bug fixes for new configuration api |
| 3.4.0 | 07/29/2021 | added new configuration api (not live yet. sdk only works against development presently) |
| 3.3.2 | 07/16/2021 | sso bug fixes |
| 3.3.1 | 07/16/2021 | screen recording - event sub text used for assisting in UX rendering |
| 3.3.0 | 07/16/2021 | new endpoint SingleSignOn |
| 3.2.15 | 07/13/2021 | storefront communications - added methods to retrieve step dispatch logs |
| 3.2.14 | 07/12/2021 | fix documentation bug on packing slip methods for order api |
| 3.2.13 | 07/12/2021 | coupon api - added hideFromCustomer flag |
| 3.2.12 | 07/09/2021 | new fulfillment and order methods for generation of packing slips |
| 3.2.11 | 07/08/2021 | screen recording - missing external tracking flag added |
| 3.2.10 | 07/08/2021 | customer profile - allow drop shipping options |
| 3.2.9 | 07/07/2021 | screen recording - provide cost per thousand and retention interval |
| 3.2.8 | 07/06/2021 | intgeration logs - min max log date/time retured in filter values |
| 3.2.7 | 07/05/2021 | integration logger bug fixes |
| 3.2.6 | 06/25/2021 | integration log: added logger name |
| 3.2.2 | 06/24/2021 | integration log file mime type added |
| 3.2.0 | 06/23/2021 | Changed 4 methods due to naming conflicts revealed through swagger validator. All internal methods, so impact should be negligible |
| 3.1.50 | 06/23/2021 | Integrated Logging: returning back streamed files for log requests |
| 3.1.49 | 06/17/2021 | Integrated Logging: standardize the response object from getIntegrationLog method |
| 3.1.47 | 06/16/2021 | Integrated Logging Rest API |
| 3.1.46 | 06/14/2021 | Screen recording: server side paginated heat map index with url contains filters, Item: channel partner item mapping unit cost override |
| 3.1.44 | 06/02/2021 | new boolean flag on items object to allow sharing of reviews between items |
| 3.1.43 | 06/01/2021 | fix item serialized name of item serialized name for channel partner item mappings |
| 3.1.42 | 06/01/2021 | added quickbooks accounting codes at the tiered level for tiered coupons |
| 3.1.41 | 05/21/2021 | screen recording heatmap methods |
| 3.1.40 | 05/20/2021 | Order.summary.actual_payment_processing field added |
| 3.1.39 | 05/19/2021 | full deployment to ensure all language SDKs are up to date |
| 3.1.37 | 05/18/2021 | removed php sdk dependency on ext-mbstring by generating sdk with polyfill requirement. sdk is more portable now. |
| 3.1.35 | 05/14/2021 | screen recording histogram data |
| 3.1.34 | 05/12/2021 | screen recording preferred language, last x days filter, referrer domain |
| 3.1.33 | 05/11/2021 | creen recording filter for affiliate id and email |
| 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.