Checkout
Register affiliate click
Register an affiliate click. Used by custom checkouts that are completely API based and do not perform checkout handoff.
Allowed countries
Lookup the allowed countries for this merchant id
Setup Browser Application
Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.
Get cart
If the cookie is set on the browser making the request then it will return their active cart. Otherwise it will create a new cart.
Update cart
Update the cart.
Finalize Order
Finalize the cart into an order. This method can not be called with browser key authentication. It is ONLY meant for server side code to call.
Handoff cart
Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal, transfer to Affirm, transfer to Sezzle or finalization of the order (including upsell processing).
Profile login
Login in to the customer profile specified by cart.billing.email and password
Profile logout
Log the cart out of the current profile. No error will occur if they are not logged in.
Profile registration
Register a new customer profile. Requires the cart.billing object to be populated along with the password.
Validate
Validate the cart for errors. Specific checks can be passed and multiple validations can occur throughout your checkout flow.
Get cart (by cart id)
Get a cart specified by the cart_id parameter.
Get affirm checkout (by cart id)
Get a Affirm checkout object for the specified cart_id parameter.
City/State for Zip
Look up the city and state for the shipping zip code. Useful for building an auto complete for parts of the shipping address
Related items (specific item)
Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
Related items
Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.
Get cart (by return code)
Get a cart specified by the return code parameter.
Get cart (by return token)
Get a cart specified by the encrypted return token parameter.
Get state/province list for a country code
Lookup a state/province list for a given country code
Webhooks
The following webhook events are available for this resource. See Webhooks for how delivery, retries, and versioning work.
| Event | Description | Reflow | Expandable |
|---|---|---|---|
checkout_cart_abandon | Fired when a cart is abandoned | — | Yes |
checkout_cart_send_return_email | Fired when a return email should be sent to a customer | — | Yes |