Skip to content

UltraCart/rest_api_v2_sdk_javascript

Repository files navigation

ultra_cart_rest_api_v2

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

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

Installation

npm

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

npm install ultra_cart_rest_api_v2 --save
Local development

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

npm install

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

npm link

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

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

git

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

    npm install UltraCart/rest_api_v2_sdk_javascript --save

For browser

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

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

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

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

Getting Started

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

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');



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

var api = new UltraCartRestApiV2.AffiliateApi()

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

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

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

Documentation for API Endpoints

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

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

Documentation for Models