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.


DescriptionPHPC#PythonJavaScript
Java
Ruby
Webhooks





Order WebhookSample
Sample


Creating a Simple Webhook





Auto Order





Cancel auto orderSample




Update auto orderSampleSample



Update auto order item options
Sample



Query auto order by email
Sample



Query auto order by oid

Sample


Query all auto ordersSample




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




Audit simple schedulesSample




Coupon





Download CouponsSample




Download Orders and Match Up CouponsSample




Customer





Create customer
Sample



Add/Edit credit cards
Sample










Fulfillment (Shipping)





Full life cycleSample
Sample









Item





Get all itemsSample
Sample


Restrict Payment MethodSample




Change Item Attribute Name



Sample
Adding Package Requirements to Perishable ItemsSample




Retrieve Avalara Item SettingsSampleSample



Update Avalara Item SettingsSample




Checkout





Full Checkout




Add Item to CartSample




Upsell via API





Order





Add item to orderSample




Delete item from orderSample




Add externally created orderSample




Create a replacement orderSample




Partial refund orderSample




Download ordersSampleSample



Download specific order batchSample




Download specific orderSample




Custom ReceiptSample






Legacy APIs

UltraCart REST API