Reference
This section contains older UltraCart API and integration references. Use it only if you’re maintaining an existing/legacy integration. For all new development or modern API usage, please use our current API site instead.
Over time, UltraCart’s APIs have evolved. The content in this Reference area primarily documents:
Legacy REST APIs
The Advanced JavaScript Checkout API
SOAP / Web Service integrations
Older channel partner formats, XML exports, and other historic integration methods
These resources are still available so merchants and developers can support existing integrations that rely on older APIs.
Note, if you’re:
New to the UltraCart API, or
Building a new integration, or
Already using our modern REST API
Do not start here.
Instead, go directly to our current API documentation:
UltraCart Modern API Docs: https://www.ultracart.com/api/
That site contains our latest, fully supported API references, examples, and tools.
Quickstart / TL;DR
If you’re building something new
Use the modern API docs for all new projects.
Only come back to this page if you discover your system is on an older API.
If you’re maintaining an older integration
Use the sections below to find details for:
Legacy REST & JavaScript Checkout API
SOAP / Web Services
Channel Partner / transport formats
XML export and other historic formats
Legacy REST & JavaScript Checkout
What’s here
Original REST API (v1) documentation
Advanced JavaScript Checkout API reference
Older examples and troubleshooting notes for custom front-end checkouts
When to use it
Your site already uses the JavaScript Checkout API or older REST v1 calls
You need to fix a bug or make a small change to an existing integration\
SOAP & Web Service Integrations
What’s here
Original REST API (v1) documentation
Advanced JavaScript Checkout API reference
Older examples and troubleshooting notes for custom front-end checkouts
When to use it
Your site already uses the JavaScript Checkout API or older REST v1 calls
You need to fix a bug or make a small change to an existing integration\
Channel Partner & Other Legacy Integrations
What’s here
Channel Partner API references and older import methods
Transport formats for external call centers, marketplaces, and other legacy sales channels
When to use it
You have an existing channel partner feed that posts data to UltraCart using these older formats
You’re diagnosing issues or making a minor change to that feed
Export Formats & Miscellaneous References
What’s here
XML export format and related data-structure references
Older utility references (email header forwarding, older “Advanced Links – JavaScript,” legacy screens, etc.)
When to use it
You’re supporting a reporting or accounting pipeline that depends on the historical XML export
Support has asked you to provide full email headers or reference a specific legacy screen\
Not Sure Which API You’re Using?
If you are modifying a current integration and you’re unsure if you are on the older integration, examine the following:
The request URL
The host / path
Any auth headers or query parameters
Modern REST API (Version 2) → Use ultracart.com/api docs
URLs look like:
https://secure.ultracart.com/rest/v2/order/orders
https://secure.ultracart.com/rest/v2/customer/customers
https://secure.ultracart.com/rest/v2/item/digital_library
https://secure.ultracart.com/rest/v2/oauth/authorize
``` :contentReference[oaicite:0]{index=0} If you see /rest/v2/ in the path, you should always be using the modern docs at https://www.ultracart.com/api/.
Headers similar to:
Accept: application/json
Content-Type: application/json
X-UltraCart-Api-Version: 2017-03-01
x-ultracart-simple-key: <some-long-key>or an OAuth 2.0 Authorization: Bearer <token> header.
REST Checkout API v1 (legacy REST) → Use “UltraCart REST Checkout API” docs
URLs look like:
https://secure.ultracart.com/rest/cart
https://secure.ultracart.com/rest/cart/checkout
https://secure.ultracart.com/rest/cart/finalizeOrderNote: notice: /rest/cart... with no /v2 in the path).