Object Model

There are lots of simple objects that comprise the API. Below we will list out the names of each object and describe what it is. Then on subsequent pages we will detail all the fields on the object.

Class

Description

Cart

Represents a shopping cart.

CartChangeResult

Object returned after a cart change. Contains the cart plus any errors.

CartCoupon

Represents a coupon that has been applied to a shopping cart

CartItem

An item in the shopping cart.

CartItemAttribute

The attributes configure on the item that is in the shopping cart.

CartItemOption

The option that is associated with an item.

CartItemOptionValue

The values in a drop down list or radio button type option.

CartKitComponentOption

If an item is a kit and the component has an option then it's represented with this object.

CheckoutHandoffResult

The result object returned when you hand off the cart into the UltraCart checkout.

CustomerProfile

A customer profile that can be associated with a shopping cart.

CustomerProfileAddress

An address in the customer profile's billing or shipping address book.

Distance

A object to represent a distance. Used on the item dimensions.

GiftSettings

All the settings associated with gift giving on the store.

GiftWrap

A wrapping papers configuration details.

Item

Represents an item configure on the store.

ItemAttribute

The attributes configured on the item.

ItemMultimedia

The multimedia configured on the item.

ItemVariation

The variations configured on the item.

ItemMultimediaThumbnail

The thumbnail of a multimedia object.

ShippingEstimate

A shipping estimate returned from UltraCart for a shopping cart

Weight

An object to represent a weight. Used on the item weight.