API

API

UltraCart Rest Version 2

This is the most recent UltraCart API and should be used for all new development.

The current API for UltraCart consists of a REST API and Webhooks.

API Reference:  https://www.ultracart.com/api/



API Topics

Authentication

Creating an API Simple Key

Creating a Browser Key for a JavaScript checkout

Auto Order

Understanding Auto Order State

Debugging

Troubleshooting API Errors



Sample Code and Tutorials

The sample code listed below is a collection of scripts that UltraCart developers have provided for merchants and developers.   Most samples are contained within the documentation links above, but this is a collection of scripts that didn't fit a particular category in the documentation, so it's listed here.  If you cannot find what you need in the official reference (https://www.ultracart.com/api/) or below, please email support and ask for help.



Description

JavaScript

Java

Ruby

Description

JavaScript

Java

Ruby

Webhooks













Order Webhook









Creating a Simple Webhook













Auto Order













Cancel auto order











Update auto order









Update auto order item options











Query auto order by email











Query auto order by oid











Query all auto orders











Update credit card number on auto order associated with customer profile.











Audit simple schedules











Coupon













Download Coupons











Download Orders and Match Up Coupons











Customer













Create customer











Add/Edit credit cards

























Fulfillment (Shipping)













Full life cycle























Item













Get all items









Restrict Payment Method











Change Item Attribute Name











Adding Package Requirements to Perishable Items











Retrieve Avalara Item Settings









Update Avalara Item Settings











Checkout













Full Checkout











Add Item to Cart











Upsell via API













Order













Add item to order











Delete item from order











Add externally created order











Create a replacement order











Partial refund order











Download orders









Download specific order batch











Download specific order











Custom Receipt