php

checkout

/checkout

The checkout API provides all the necessary functionality to implement custom checkouts with UltraCart.

Software Development Kit (SDK)

To make working with our API easier, we package an SDK in the languages listed to the right. Select the language that you are interested in and sample code with additional commentary will be available. All of our APIs are available on GitHub at:

http://www.github.com/UltraCart/

By using an SDK you receive a number of important benefits.

Instantiating the API

There are four steps to instantiating the API.

  1. Include the SDK package
  2. Set the API credentials.
  3. Set the API version header.
  4. Instantiate the API Client.

To create OAuth or Simple Keys,

  • Login to UltraCart
  • Navigate to Home → Configuration → Back Office → Authorized Applications
  • Click the 'new application' button

Include the SDK package

require_once '/path/to/vendor/autoload.php';

Set the API credentials (for OAuth 2.0)

// Configure OAuth2 access token for authorization: ultraCartOauth
ultracart\admin\v2\Configuration::getDefaultConfiguration()->setAccessToken($access_token);

Set the API credentials (for Simple Key)

// Configure API key authorization: ultraCartSimpleApiKey
ultracart\admin\v2\Configuration::getDefaultConfiguration()->setApiKey('x-ultracart-simple-key', 'YOUR_API_KEY');

Set the API credentials (for Browser Key)

// Configure API key authorization: ultraCartBrowserApiKey
ultracart\admin\v2\Configuration::getDefaultConfiguration()->setApiKey('x-ultracart-browser-key', 'YOUR_API_KEY');

Set the API version header.

// Set the date of the API release we're using
ultracart\admin\v2\Configuration::getDefaultConfiguration()->addDefaultHeader("X-UltraCart-Api-Version", "2017-03-01");

Instantiate the API Client.

$checkout_api = new ultracart\admin\v2\Api\CheckoutApi();

Be sure to read the notes about expansions. You'll need an expansion for many calls.

Expansion

The checkout REST API has the capability to expand everything related to the cart. By default, when you read a cart, a limited object is returned. If you specify the _expand parameter, additional properties of the cart object are returned. We encourage you to limit the amount of information that you query for carts to the minimal amount possible to have optimal communication. The following expansion operations are available.

Comments

  • $expansion should contain all the objects that will be needed throughout the checkout. See the expansion section for a complete list.
  • This expansion list MUST be supplied for each get/put call or data may be lost on the return objects. For example, if you're using coupons, then coupons must be in the expansion list, or they will not be included in the return value and be lost in subsequent updates.
  • The $expansion variable below doesn't include much of the item objects because they're not needed. For example, we don't need the item multimedia because we're not showing this cart to an end customer like a javascript implementation would, so thumbnails and item images have to use to a backend solution.
$expansion = "billing,checkout,coupons,items,payment,settings.shipping.estimates,shipping,summary,taxes,coupons";
// pass the expansion during GETs
$get_response = $checkout_api->checkoutCartGet($expansion);
// and also during all POSTs and PUTs
$put_response = $checkout_api->checkoutCartPut($cart, $expansion);

Setup Browser Application

Permissions:
  • checkout_write

Produces: application/json
put
/checkout/browser_key

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 applicaiton, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.

Parameters
Parameter Description Location Data Type Required
browser_key_request Setup browser key request body CheckoutSetupBrowserKeyRequest required
Responses
Status Code Reason Response Model
200
Successful response CheckoutSetupBrowserKeyResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Get cart

Permissions:
  • checkout_read

Produces: application/json
get
/checkout/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.

Parameters
Parameter Description Location Data Type Required
UltraCartShoppingCartID Cart ID passed as a cookie (primary tracking method) cookie string optional
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CartResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Update cart

Permissions:
  • checkout_write

Produces: application/json
put
/checkout/cart

Update the cart.

Parameters
Parameter Description Location Data Type Required
cart Cart body Cart required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CartResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Finalize Order

Permissions:
  • checkout_write

Produces: application/json
post
/checkout/cart/finalizeOrder

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.

Parameters
Parameter Description Location Data Type Required
finalize_request Finalize request body CartFinalizeOrderRequest required
Responses
Status Code Reason Response Model
200
Successful response CartFinalizeOrderResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Handoff cart

Permissions:
  • checkout_write

Produces: application/json
post
/checkout/cart/handoff

Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal or finalization of the order (including upsell processing).

Parameters
Parameter Description Location Data Type Required
handoff_request Handoff request body CheckoutHandoffRequest required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CheckoutHandoffResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Profile login

Permissions:
  • checkout_write

Produces: application/json
post
/checkout/cart/profile/login

Login in to the customer profile specified by cart.billing.email and password

Parameters
Parameter Description Location Data Type Required
login_request Login request body CartProfileLoginRequest required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CartProfileLoginResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Profile logout

Permissions:
  • checkout_write

Produces: application/json
post
/checkout/cart/profile/logout

Log the cart out of the current profile. No error will occur if they are not logged in.

Parameters
Parameter Description Location Data Type Required
cart Cart body Cart required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CartResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Profile registration

Permissions:
  • checkout_write

Produces: application/json
post
/checkout/cart/profile/register

Register a new customer profile. Requires the cart.billing object to be populated along with the password.

Parameters
Parameter Description Location Data Type Required
register_request Register request body CartProfileRegisterRequest required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CartProfileRegisterResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Validate

Permissions:
  • checkout_write

Produces: application/json
post
/checkout/cart/validate

Validate the cart for errors. Specific checks can be passed and multiple validations can occur throughout your checkout flow.

Parameters
Parameter Description Location Data Type Required
validation_request Validation request body CartValidationRequest required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CartValidationResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Get cart (by cart id)

Permissions:
  • checkout_read

Produces: application/json
get
/checkout/cart/{cart_id}

Get a cart specified by the cart_id parameter.

Parameters
Parameter Description Location Data Type Required
cart_id Cart ID to retrieve path string required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CartResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

City/State for Zip

Permissions:
  • checkout_read

post
/checkout/city_state

Look up the city and state for the shipping zip code. Useful for building an auto complete for parts of the shipping address

Parameters
Parameter Description Location Data Type Required
cart Cart body Cart required
Responses
Status Code Reason Response Model
200
Successful response ItemsResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Related items (specific item)

Permissions:
  • checkout_read

post
/checkout/relatedItems/{item_id}

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.

Parameters
Parameter Description Location Data Type Required
item_id Item ID to retrieve related items for path string required
cart Cart body Cart required
_expand The object expansion to perform on the result. See item resource documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response ItemsResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Related items

Permissions:
  • checkout_read

Produces: application/json
post
/checkout/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.

Parameters
Parameter Description Location Data Type Required
cart Cart body Cart required
_expand The object expansion to perform on the result. See item resource documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response ItemsResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Get cart (by return code)

Permissions:
  • checkout_read

Produces: application/json
get
/checkout/return/{return_code}

Get a cart specified by the return code parameter.

Parameters
Parameter Description Location Data Type Required
return_code Return code to lookup cart ID by path string required
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response CartResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Webhooks

The following webhook events are generated for this resource.

Event Description Response Expansion
checkout_cart_abandon Fired when a cart is abandoned by the customer Cart Yes

Cart

Attributes
Name Data Type Description
affiliate CartAffiliate Affiliate
base_currency_code (read only) string(3) The ISO-4217 three letter base currency code of the account
billing CartBilling Billing
buysafe CartBuysafe buySAFE
cart_id (read only) string Unique identifier for this cart
checkout CartCheckout Checkout
coupons array of CartCoupon Coupons
currency_code string(3) The ISO-4217 three letter currency code the customer is viewing prices in
customer_profile CartCustomerProfile Customer profile if logged in
exchange_rate (read only) number The exchange rate if the customer is viewing a different currency than the base
gift CartGift Gift
gift_certificate CartGiftCertificate Gift certificate
items array of CartItem Items
language_iso_code string(3) The ISO-631 three letter code the customer would like to checkout with
logged_in boolean True if the customer is logged into their profile
marketing CartMarketing Marketing
merchant_id (read only) string Merchant ID this cart is associated with
payment CartPayment Payment
settings (read only) CartSettings Settings for options that should be available during the checkout
shipping CartShipping Shipping
summary CartSummary Summary
taxes CartTaxes Taxes
upsell_after CartUpsellAfter Upsell After

CartAffiliate

Attributes
Name Data Type Description
affiliate_id integer (int32) Affiliate id associated with the cart
affiliate_sub_id string(50) Affiliate sub id associated with the cart

CartBilling

Attributes
Name Data Type Description
address1 string(50) Address line 1
address2 string(50) Address line 2
cc_emails array of string CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters.
city string(32) City
company string(50) Company
country_code string(2) ISO-3166 two letter country code
day_phone string(25) Day phone
email string(100) Email
email_confirm string(100) Email entered for confirmation
evening_phone string(25) Evening phone
first_name string(30) First name
last_name string(30) Last name
postal_code string(20) Postal code
state_region string(32) State for United States otherwise region or province for other countries
title string(50) Title

CartBuysafe

Attributes
Name Data Type Description
bond_available (read only) boolean True if buySAFE is willing to bond the order
bond_cost (read only) Currency Cost of the bond if the customer wants to purchase it
bond_free (read only) boolean True if the bond is free (merchant paying for it)
bond_wanted boolean True if the customer wants the bond
cart_display_text (read only) string Recommend text to display to the customer
cart_display_url (read only) string URL associated with the recommended text

CartCheckout

Attributes
Name Data Type Description
comments string(2000) Comments from the customer. Rarely used on the single page checkout.
custom_field1 string(50) Custom field 1
custom_field2 string(50) Custom field 2
custom_field3 string(50) Custom field 3
custom_field4 string(50) Custom field 4
custom_field5 string(75) Custom field 5
custom_field6 string(50) Custom field 6
custom_field7 string(50) Custom field 7
ip_address (read only) string IP Address
screen_branding_theme_code string(10) Screen branding theme code

CartCoupon

Attributes
Name Data Type Description
coupon_code string Coupon code

CartCustomerProfile

Attributes
Name Data Type Description
allow_3rd_party_billing boolean True if profile is allowed to bill to their 3rd party shipping account
allow_cod boolean True if this profile is allowed to use a COD
allow_purchase_order boolean True if this profile is allowed to use a purchase order
billing_addresses array of CartCustomerProfileAddress Billing addresses on file for this profile
credit_cards array of CartCustomerProfileCreditCard Credit cards on file for this profile (masked)
customer_profile_oid integer (int32) Unique identifier
dhl_account_number string DHL account number on file
email string Email
fedex_account_number string FedEx account number on file
free_shipping boolean True if this profile always qualifies for free shipping
free_shipping_minimum number The minimum aount that this profile has to purchase to qualify for free shipping
maximum_item_count integer (int32) Maximum item count this profile can purchase
minimum_item_count integer (int32) Minimum item count this profile must purchase
minimum_subtotal number Minimum subtotal this profile must purchase
no_coupons boolean True if this profile is prevented from using coupons
no_free_shipping boolean True if this profile is never given free shipping
no_realtime_charge boolean True if this customers orders are not charged in real-time
pricing_tiers array of string Pricing tier names this profile qualifies for
shipping_addresses array of CartCustomerProfileAddress Shipping addresses on file for this profile
tax_exempt boolean True if this profile is exempt from sales tax
ups_account_number string UPS account number on file

CartCustomerProfileAddress

This object is read only.
Attributes
Name Data Type Description
address1 string Address 1
address2 string Address 2
city string City
company string Company
country_code string ISO-3166 Country code
day_phone string Day phone
evening_phone string Evening phone
first_name string First name
last_name string Last name
oid integer (int32) Unique identifier for this address
postal_code string Postal code
state_region string State for United States otherwise region or province for other countries
tax_county string Tax county if a billing address
title string Title

CartCustomerProfileCreditCard

This object is read only.
Attributes
Name Data Type Description
card_expiration_month integer (int32) Card expiration month (1-12)
card_expiration_year integer (int32) Card expiration year (four digit)
card_number string Card number (masked last 4 digits)
card_type string Card type
Allowed Values
  • AMEX
  • Diners Club
  • Discover
  • MasterCard
  • JCB
  • VISA
customer_profile_credit_card_id integer (int32) Unique identifier for this stored card
last_used_date string (dateTime) Last used

CartFinalizeOrderRequest

Attributes
Name Data Type Description
cart Cart Cart
options CartFinalizeOrderRequestOptions Options that control the finalize order operation

CartFinalizeOrderRequestOptions

Attributes
Name Data Type Description
auto_approve_purchase_order boolean Automatically approve the purchase order
channel_partner_code string Channel partner code to associate this order with
channel_partner_oid integer (int32) Channel partner oid to associate this order with
channel_partner_order_id string If channel_partner_oid or channel_partner_code specified
Channel partner order id for reference
consider_recurring boolean Consider this order a recurring order for the purposes of payment gateway recurring flag
credit_card_authorization_amount number If the order was authorized outside of UltraCart, this is the amount of the authorization
credit_card_authorization_date string (dateTime) If the order was authorized outside of UltraCart, this is the date/time of the authorization
credit_card_authorization_reference_number string(60) If the order was authorized outside of UltraCart, this is the authorization reference number
no_realtime_payment_processing boolean Prevents normal real-time processing of the payment and sends the order to Accounts Receivable
setup_next_cart boolean True if the system should create another cart automatically if the current cart was logged into a profile
skip_payment_processing boolean Skip payment processing and move the order on to shipping (or completed if no shipping required)
store_completed boolean True the order in the completed stage
store_if_payment_declines boolean Store the order in accounts receivable if the payment declines

CartFinalizeOrderResponse

Attributes
Name Data Type Description
errors array of string Error messages if the order could not be completed
next_cart Cart Next cart if options.setup_next_cart=true and order created successfully
order Order Order generated from the cart
order_id string Order ID assigned to the order
successful boolean True if the cart was converted successfully to an order

CartGift

Attributes
Name Data Type Description
gift boolean True if this order is a gift
gift_charge (read only) Currency Additional charge for making this order a gift
gift_email string(100) Email address of the gift recipient
gift_message string(10000) Message to the gift recipient
gift_wrap_cost (read only) Currency Cost of the gift wrap selected
gift_wrap_title string(30) Title of the selected gift wrap

CartGiftCertificate

Attributes
Name Data Type Description
gift_certificate_amount (read only) Currency The amount used on the gift certificate
gift_certificate_code string Gift certificate code
gift_certificate_remaining_balance_after_order (read only) Currency The amount of money left on the gift certificate after this order is completed

CartItem

Attributes
Name Data Type Description
arbitrary_unit_cost Currency If authentication type is not browser key
Arbitrary unit cost
attributes (read only) array of CartItemAttribute Attributes
auto_order_schedule string If schedules array is populated
Auto order schedule the customer selected
default_image_url (read only) string URL to the default multimedia image
default_thumbnail_url (read only) string URL to the default multimedia thumbnail
description (read only) string Description of the item
discount (read only) Currency The discount on this item provided by a coupon
extended_description (read only) string Extended description of the item
item_id string Item ID
item_oid integer (int32) Item object identifier
kit (read only) boolean True if this item is a kit
kit_component_options array of CartKitComponentOption Options associated with the kit components
manufacturer_suggested_retail_price (read only) Currency Manufacture suggested retail price
maximum_quantity (read only) number Maximum quantity the customer can purchase
minimum_quantity (read only) number Minimum quantity the customer can purchase
multimedia (read only) array of CartItemMultimedia Multimedia
options array of CartItemOption Options
phsyical CartItemPhysical Physical characteristcs
position (read only) integer (int32) Position of the item in the cart
preorder (read only) boolean True if this item is on pre-order
quantity number quantity
schedules (read only) array of string Customer selectable auto order schedules
total_cost (read only) Currency Total cost of item before discount
total_cost_with_discount (read only) Currency Total cost of this item after discount
unit_cost (read only) Currency Unit cost of the item
unit_cost_with_discount (read only) Currency Unit cost of the item after discounts
upsell boolean True if this item was added to the cart as part of an upsell
variations array of CartItemVariationSelection Variations
view_url (read only) string URL to view the product on the site

CartItemAttribute

This object is read only.
Attributes
Name Data Type Description
name string Name of the attribute
type string Type of attribute
Allowed Values
  • boolean
  • color
  • definitionlist
  • html
  • integer
  • mailinglist
  • multiline
  • rgba
  • simplelist
  • string
  • videolist
value string Value of the attribute

CartItemMultimedia

This object is read only.
Attributes
Name Data Type Description
code string Code assigned to the multimedia
description string Description
exclude_from_gallery boolean True if the image should be excluded from galleries
image_height integer (int32) If type = Image
Image height
image_width integer (int32) If type = Image
Image width
is_default boolean True if the multimedia is the default for this type
thumbnails array of CartItemMultimediaThumbnail Thumbnails of the images
type string Type of multimedia
Allowed Values
  • Image
  • PDF
  • Text
  • Unknown
  • Video
url string URL to view multimedia at

CartItemMultimediaThumbnail

This object is read only.
Attributes
Name Data Type Description
height integer (int32) Height in pixels
png boolean True if thumbnail is a PNG, otherwise its a JPEG
square boolean True if the thumbnail is square
url string URL for the thumbnail
width integer (int32) Width in pixels

CartItemOption

Attributes
Name Data Type Description
cost_if_specified (read only) Currency Cost if the option is specified
cost_per_letter (read only) Currency Cost per letter of text (single or multiline options)
cost_per_line (read only) Currency Cost per line of text (multiline options)
ignore_if_default (read only) boolean True if the default answer is ignored
label (read only) string Display label for the option
name (read only) string Name of the option
one_time_fee (read only) boolean Charge the fee a single time instead of multiplying by the quantity
option_oid (read only) integer (int32) Unique identifier for the option
required (read only) boolean True if the customer is required to select a value
selected_value string(1024) The value of the option specified by the customer
type (read only) string Type of option
Allowed Values
  • single
  • multiline
  • dropdown
  • hidden
  • radio
  • fixed
values (read only) array of CartItemOptionValue Values that the customer can select from for radio or select type options

CartItemOptionValue

This object is read only.
Attributes
Name Data Type Description
additional_cost Currency Additional cost of the item if this option value is selected
additional_weight Weight Additional weight of the item if this option is selected
default_value boolean True if this is the default value
display_order integer (int32) Display order of the option value
value string Value of the option the customer can select

CartItemPhysical

Attributes
Name Data Type Description
height (read only) Distance Height
length (read only) Distance Length
weight (read only) Weight Weight
width (read only) Distance Width

CartItemVariationSelection

Attributes
Name Data Type Description
variation_name string Variation name
variation_value string Variation value

CartKitComponentOption

Attributes
Name Data Type Description
cost_if_specified (read only) Currency Cost if the option is specified
cost_per_letter (read only) Currency Cost per letter of text (single or multi-line options)
cost_per_line (read only) Currency Cost per line of text (multiline options)
ignore_if_default (read only) boolean True if the default answer is ignored
item_id (read only) string Kit component item id
item_oid (read only) integer (int32) Unique identifier for the kit component item
label (read only) string Display label for the option
name (read only) string Name of the option
one_time_fee (read only) boolean Charge the fee a single time instead of multiplying by the quantity
option_oid (read only) integer (int32) Unique identifier for the option
required (read only) boolean True if the customer is required to select a value
selected_value string(1024) The value of the option specified by the customer
type (read only) string Type of option
Allowed Values
  • single
  • multiline
  • dropdown
  • hidden
  • radio
  • fixed
values (read only) array of CartItemOptionValue Values that the customer can select from for radio or select type options

CartMarketing

Attributes
Name Data Type Description
advertising_source string The advertising source the customer indicated
mailing_list_opt_in boolean True if the customer agrees to receiving marketing emails

CartPayment

Attributes
Name Data Type Description
amazon CartPaymentAmazon If payment_method = Amazon
Amazon
check CartPaymentCheck If payment_method = Check
Check
credit_card CartPaymentCreditCard If payment_method = Credit Card
Credit card
payment_method string Payment method
Allowed Values
  • Amazon
  • Check
  • COD
  • Credit Card
  • Money Order
  • PayPal
  • Purchase Order
  • Quote Request
  • Wire Transfer
purchase_order CartPaymentPurchaseOrder If payment_method = Purchase Order
Purchase order

CartPaymentAmazon

Attributes
Name Data Type Description
amazon_order_reference_id string Amazon order reference id

CartPaymentCheck

Attributes
Name Data Type Description
check_number integer (int32) Check number they are paying with

CartPaymentCreditCard

Attributes
Name Data Type Description
card_expiration_month integer (int32) Card expiration month (1-12)
card_expiration_year integer (int32) Card expiration year (four digit year)
card_number string Card number (masked to the last 4)
card_number_token string Hosted field token for the card number
card_type string Card type
card_verification_number string Card verification number (masked)
card_verification_number_token string Hosted field token for the card verification number
customer_profile_credit_card_id integer (int32) ID of the stored credit card to use
store_credit_card boolean True if the customer wants to store the card on their profile for future re-use

CartPaymentPurchaseOrder

Attributes
Name Data Type Description
purchase_order_number string Purchase order number

CartProfileLoginRequest

Attributes
Name Data Type Description
cart Cart Cart
password string Password for the profile

CartProfileLoginResponse

Attributes
Name Data Type Description
cart Cart Cart
errors array of string Errors to display to the customer if they failed any of the validations checked

CartProfileRegisterRequest

Attributes
Name Data Type Description
cart Cart Cart
password string Password for the profile

CartProfileRegisterResponse

Attributes
Name Data Type Description
cart Cart Cart
errors array of string Errors to display to the customer if they failed any of the validations checked

CartResponse

Attributes
Name Data Type Description
cart Cart Cart
errors array of string Errors that should be displayed to the customer

CartSettings

This object is read only.
Attributes
Name Data Type Description
billing CartSettingsBilling Billing settings for this cart
gift CartSettingsGift Gift giving settings
payment CartSettingsPayment Payment settings for this cart
shipping CartSettingsShipping Shipping settings for this cart
taxes CartSettingsTaxes Information on taxes for this cart
terms CartSettingsTerms Terms of the checkout the customer must agree to

CartSettingsBilling

Attributes
Name Data Type Description
provinces array of CartSettingsProvince If _expand=settings.billing.provinces specified
Provinces

CartSettingsGift

This object is read only.
Attributes
Name Data Type Description
allow_gifts boolean True if this checkout supports gift giving
gift_charge Currency The cost associated with sending a gift
gift_wraps array of CartSettingsGiftWrap The gift wraps available for the customer to select from
max_message_length integer (int32) The maximum length of the gift message the giver can enter

CartSettingsGiftWrap

This object is read only.
Attributes
Name Data Type Description
cost Currency Cost if this gift wrap is selected
title string Title of the gift wrap
url string URL for the sample of the gift wrap

CartSettingsPayment

This object is read only.
Attributes
Name Data Type Description
amazon CartSettingsPaymentAmazon If supports_amazon = true
Amazon Payments information
credit_card CartSettingsPaymentCreditCard If supports_credit_card = true
Credit card payment information
need_payment boolean True if this card requires a payment from the customer
paypal CartSettingsPaymentPayPal If supports_paypal = true
PayPal information
supports_amazon boolean True if Amazon payments are available on this order
supports_check boolean True if check payments are available on this order
supports_cod boolean True if COD payments are available on this order
supports_credit_card boolean True if credit card payments are available on this order
supports_money_order boolean True if money order payments are available on this order
supports_paypal boolean True if PayPal payments are available on this order
supports_purchase_order boolean True if purchase order payments are available on this order
supports_quote_request boolean True if quote requests payments are available on this order
supports_wire_transfer boolean True if wire transfer payments are available on this order

CartSettingsPaymentAmazon

This object is read only.
Attributes
Name Data Type Description
amazon_button_url string Amazon button URL
amazon_merchant_id string Amazon merchant ID
amazon_widget_url string Amazon widget URL

CartSettingsPaymentCreditCard

This object is read only.
Attributes
Name Data Type Description
collect_credit_card_verification_number boolean True if the credit card verification number should be collected
credit_card_types array of string Available credit card types
Allowed Values
  • AMEX
  • Diners Club
  • Discover
  • MasterCard
  • JCB
  • VISA
hosted_fields_shopping_cart_token string The shoppingCartToken needed for proper initialization of hosted fields collection

CartSettingsPaymentPayPal

This object is read only.
Attributes
Name Data Type Description
paypal_button_alt_text string PayPal button alt text
paypal_button_url string PayPal button URL
paypal_credit_button_url string PayPal Credit button URL
paypal_credit_legal_image_url string PayPal Credit legal image URL
paypal_credit_legal_url string PayPal Credit legal URL

CartSettingsProvince

This object is read only.
Attributes
Name Data Type Description
code string
province string

CartSettingsShipping

This object is read only.
Attributes
Name Data Type Description
deliver_on_date CartSettingsShippingCalendar If _expand=settings.shipping.deliver_on_date specified
Deliver on date calendar information
estimates array of CartSettingsShippingEstimate If _expand=settings.shipping.estimates specified
Estimates for this cart
need_shipping boolean True if this order needs shipping
provinces array of CartSettingsProvince If _expand=settings.shipping.provinces specified
Provinces
ship_on_date CartSettingsShippingCalendar If _expand=settings.shipping.ship_on_date specified
Ship on date calendar information

CartSettingsShippingCalendar

This object is read only.
Attributes
Name Data Type Description
blackouts string (dateTime) Specified dates that are blacked out on the calendar
days_of_week array of boolean Days of week that should be enabled on the calendar (0 - Sunday through 6 - Saturday)
earliest string The earliest date that can be selected on the calendar
require boolean True if the customer is required to select a date
show boolean True if this calendar should be shown to the customer

CartSettingsShippingEstimate

This object is read only.
Attributes
Name Data Type Description
allow_3rd_party_billing boolean True if this method allows the customer to use their own shipper account number
comment string Comment to display to the customer about this method
cost Currency Cost of this method
cost_before_discount Currency Cost before discount by coupon
default_method boolean True if this is the default method
discount Currency Amount discounted by a coupon
discounted boolean True if this method is discounted because of a coupon
display_name string The name to display to the customer
estimated_delivery string Date of the estimated delivery (or range)
lift_gate_option boolean True if a lift gate option for this method should be offered to the customer
name string Shipping method name
tax Currency Tax applied to this method if selected
total_tax Currency Total amount of tax on the order if this method is selected

CartSettingsTaxes

This object is read only.
Attributes
Name Data Type Description
counties array of string

CartSettingsTerms

This object is read only. Only one of the two versions will be populated based upon how the merchant entered them.
Attributes
Name Data Type Description
html string HTML version of the terms
text string Text version of the terms.

CartShipping

Attributes
Name Data Type Description
address1 string(50) Address line 1
address2 string(50) Address line 2
city string(32) City
company string(50) Company
country_code string(2) ISO-3166 two letter country code
day_phone string(25) Day time phone
delivery_date string (dateTime) Date the customer is requesting delivery on. Typically used for perishable product delivery.
evening_phone string(25) Evening phone
first_name string(30) First name
last_name string(30) Last name
lift_gate boolean Lift gate requested (LTL shipping methods only)
postal_code string(25) Postal code
ship_on_date string (dateTime) Date the customer is requesting that the order ship on. Typically used for perishable product delivery.
ship_to_residential boolean True if the shipping adress is residential. Effects the methods that are available to the customer as well as the price of the shipping method.
shipping_3rd_party_account_number string(20) 3rd party account number to ship against for UPS or FedEx
shipping_method string(40) Shipping method
special_instructions string(10000) Special instructions from the customer regarding shipping
state_region string(32) State/Region
title string(50) Title

CartSummary

Attributes
Name Data Type Description
arbitrary_shipping_handling_total Currency If API authentication is not browser key
Arbitrary shipping/handling totla
arbitrary_tax Currency If API authentication is not browser key
Arbitrary tax
arbitrary_tax_rate Currency If API authentication is not browser key
Arbitrary tax rate
arbitrary_taxable_subtotal Currency If API authentication is not browser key
Arbitrary taxable subtotal
shipping_handling Currency Shipping/handling
shipping_handling_discount Currency Shipping/handling discount
shipping_handling_with_discount Currency Shipping/handling with discount
subtotal (read only) Currency Subtotal
subtotal_discount (read only) Currency Subtotal discount
subtotal_with_discount (read only) Currency Subtotal with discount
surcharge (read only) Currency Surcharge associated with the payment method
tax (read only) Currency Tax
taxable_subtotal (read only) Currency Taxable subtotal
taxable_subtotal_discount (read only) Currency Taxable subttotal discount
taxable_subtotal_with_discount (read only) Currency Taxable subtotal with discount
total (read only) Currency Total

CartTaxes

Attributes
Name Data Type Description
county string(32) Tax county if the state requires it.
exempt (read only) boolean True if tax exempt
rate (read only) number Tax rate

CartUpsellAfter

Attributes
Name Data Type Description
finalize_after_dts string (dateTime) The date/time after which the cart will finalize into an order.
finalize_after_minutes integer (int32) The amount of inactivity in minutes after which the cart should be finalized into an order. This will calculate the finalize_after_dts field.
upsell_path_code string(5) Upsell path code

CartValidationRequest

Attributes
Name Data Type Description
cart Cart Cart
checks array of string Checks to perform
Allowed Values
  • All
  • Advertising Source Provided
  • Billing Address Provided
  • Billing Destination Restriction
  • Billing Phone Numbers Provided
  • Billing State Abbreviation Valid
  • Billing Validate City State Zip
  • Coupon Zip Code Restriction
  • Credit Card Shipping Method Conflict
  • Customer Profile Does Not Exist.
  • CVV2 Not Required
  • Electronic Check Confirm Account Number
  • Email confirmed
  • Email provided if required
  • Gift Message Length
  • Item Quantity Valid
  • Item Restrictions
  • Items Present
  • Merchant Specific Item Relationships
  • One per customer violations
  • Options Provided
  • Payment Information Validate
  • Payment Method Provided
  • Payment Method Restriction
  • Pricing Tier Limits
  • Quantity requirements met
  • Referral Code Provided
  • Shipping Address Provided
  • Shipping Destination Restriction
  • Shipping Method Provided
  • Shipping Needs Recalculation
  • Shipping State Abbreviation Valid
  • Shipping Validate City State Zip
  • Special Instructions Length
  • Tax County Specified
  • Valid Delivery Date
  • Valid Ship On Date

CartValidationResponse

Attributes
Name Data Type Description
cart Cart Cart
errors array of string Errors to display to the customer if they failed any of the validations checked

CheckoutHandoffRequest

Attributes
Name Data Type Description
cart Cart Cart
error_parameter_name string If any error happen during the processing on the UltraCart side, the browser will be redirected to your error_return_url with the error passed in this parameter name.
error_return_url string The URL to return the browser to if there are processing errors on the UltraCart side.
operation string The type of handoff operation to perform
Allowed Values
  • checkout
  • payPal
  • payPalCredit
  • view
paypal_maximum_upsell_revenue number If operation=payPal or payPalCredit
The maximum amount of revenue that you think the customer could add during a custom upsell after sequence on your checkout.
paypal_return_url string If operation=payPal or payPalCredit
The URl to return the customers browser to after they have completed the PayPal process.
secure_host_name string The desired secure host name to perform the handoff on. This should match the desired StoreFront.

CheckoutHandoffResponse

Attributes
Name Data Type Description
cart Cart Cart
errors array of string Errors that occurred which are preventing the handoff operation. Display these to the customer.
redirect_to_url string The URL that you should redirect the customers browser to

CheckoutSetupBrowserKeyRequest

Attributes
Name Data Type Description
allowed_referrers array of string Allowed referrers. If URLs are specified, automatic translation will convert them to proper allowed referrer maskes.

CheckoutSetupBrowserKeyResponse

Attributes
Name Data Type Description
browser_key string Browser key that is used to authenticate against the new linked application.

Currency

Attributes
Name Data Type Description
localized number Value localized to the customer
localized_formatted string Value localized and formatted for the customer
value number Value in base currency

Customer

Attributes
Name Data Type Description
affiliate_oid integer (int32) Affiliate oid
allow_3rd_party_billing boolean Allow 3rd party billing
allow_cod boolean Allow COD
allow_purchase_order boolean Allow purchase orders by this customer
allow_quote_request boolean Allow quote request
allow_selection_of_address_type boolean Allow selection of residential or business address type
auto_approve_cod boolean Auto approve COD
auto_approve_purchase_order boolean Auto approve purchase orders by this customer
automatic_merchant_notes string Automatic merchant notes are added to every order placed
billing array of CustomerBilling Billing addresses for this customer
business_notes string(2000) Business notes (internally visible only)
cards array of CustomerCard Credit Cards for this customer
customer_profile_oid (read only) integer (int32) Customer profile object identifier
dhl_account_number string(20) DHL account number
email string Email address of this customer profile
exempt_shipping_handling_charge boolean Exempt shipping handling charge
fedex_account_number string(20) FedEx account number
free_shipping boolean This customer always receives free shipping
free_shipping_minimum number If free_shipping is true, this is the minimum subtotal required for free shipping
last_modified_by (read only) string(100) Last modified by
last_modified_dts (read only) string(25) Last modified date
maximum_item_count integer (int32) Maximum item count
minimum_item_count integer (int32) Minimum item count
minimum_subtotal number Minimum subtotal
no_coupons boolean No coupons
no_free_shipping boolean No free shipping regardless of coupons or item level settings
no_realtime_charge boolean No realtime charge
password string(30) Password (may only be set, never read)
pricing_tiers array of CustomerPricingTier Pricing tiers for this customer
qb_class string QuickBooks class to import this customer as
qb_code string QuickBooks name to import this customer as
referral_source string(50) Referral Source
sales_rep_code string(10) Sales rep code
send_signup_notification boolean Send signup notification, if true during customer creation, will send a notification.
shipping array of CustomerShipping Shipping addresses for this customer
signup_dts (read only) string Signup date
suppress_buysafe boolean Suppress buySAFE
tax_exempt boolean True if the customer is tax exempt
tax_id string(15) Tax ID
terms string Terms for this customer
track_separately boolean True if the customer should be tracked separately in QuickBooks
unapproved boolean Unapproved
ups_account_number string(20) UPS account number
website_url string(100) Website url

CustomerBilling

Attributes
Name Data Type Description
address1 string(50) Address line 1
address2 string(50) Address line 2
city string(32) City
company string(50) Company
country_code string(2) ISO-3166 two letter country code
customer_billing_oid (read only) integer (int32) Customer profile billing object identifier
customer_profile_oid (read only) integer (int32) Customer profile object identifier
day_phone string(25) Day phone
default_billing boolean Default billing
evening_phone string(25) Evening phone
first_name string(30) First name
last_name string(30) Last name
last_used_dts string(25) Last used date
postal_code string(20) Postal code
state_region string(32) State for United States otherwise region or province for other countries
tax_county string(32) Tax County
title string(50) Title

CustomerCard

Attributes
Name Data Type Description
card_expiration_month integer (int32) Card expiration month (1-12)
card_expiration_year integer (int32) Card expiration year (four digit year)
card_number string Card number (masked to the last 4)
card_number_token string Hosted field token for the card number
card_type string Card type
customer_profile_credit_card_id integer (int32) ID of the stored credit card to use
customer_profile_oid (read only) integer (int32) Customer profile object identifier

CustomerPricingTier

Attributes
Name Data Type Description
name string(50) Name
pricing_tier_oid integer (int32) Pricing Tier Oid

CustomerShipping

Attributes
Name Data Type Description
address1 string(50) Address line 1
address2 string(50) Address line 2
city string(32) City
company string(50) Company
country_code string(2) ISO-3166 two letter country code
customer_profile_oid (read only) integer (int32) Customer profile object identifier
customer_shipping_oid (read only) integer (int32) Customer profile shipping object identifier
day_phone string(25) Day phone
default_shipping boolean Default shipping
evening_phone string(25) Evening phone
first_name string(30) First name
last_name string(30) Last name
last_used_dts string(25) Last used date
postal_code string(20) Postal code
state_region string(32) State for United States otherwise region or province for other countries
tax_county string(32) Tax County
title string(50) Title

Distance

Attributes
Name Data Type Description
uom string(2) Unit of measure
Allowed Values
  • IN
  • CM
value number The distance measured in UOM

Error

Attributes
Name Data Type Description
developer_message string A technical message meant to be read by a developer
error_code string HTTP status code
more_info string Additional information often a link to additional documentation
user_message string An end-user friendly message suitable for display to the customer

ErrorResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful

Item

Attributes
Name Data Type Description
accounting ItemAccounting Accounting such as QuickBooks codes
amember ItemAmember Amember configuration
auto_order ItemAutoOrder Auto Order
ccbill ItemCCBill CCBill.com
channelPartnerMappings array of ItemChannelPartnerMapping Channel Partner Item Mapping
chargeback ItemChargeback Chargeback
checkout ItemCheckout Checkout
content ItemContent Content such as multimedia and attributes
creation_dts (read only) string (dateTime) Date/time of creation
description string(512) Description of the item up to 500 characters.
description_translated_text_instance_oid (read only) integer (int32) Description translated text instance id
digital_delivery ItemDigitalDelivery Digital Delivery
ebay ItemEbay e-Bay
email_notifications ItemEmailNotifications Email notifications
enrollment123 ItemEnrollment123 Enrollment123.com
gift_certificate ItemGiftCertificate Gift Certificate
google_product_search ItemGoogleProductSearch Google Product Search
identifiers ItemIdentifiers Identifiers such as SKU, Barcode, etc.
inactive boolean True if this item is inactive and can not be purchased
instant_payment_notifications ItemInstantPaymentNotifications Instance Payment Notifications
internal ItemInternal Internal information such as memo
kit boolean True if this item is a kit
kit_definition ItemKitDefinition Kit Definition
last_modified_dts (read only) string (dateTime) Date/time of last modification
merchant_id string(5) UltraCart merchant ID owning item
merchant_item_id string(20) Unique item id assigned to this item
merchant_item_oid (read only) integer (int32) Unique object identifier for this item
options array of ItemOption Options
parent_category_id integer (int32) Parent category of the item. Zero indicates the root folder.
payment_processing ItemPaymentProcessing Payment Processing
physical ItemPhysical Physical characters like weight and measurements
pricing ItemPricing Pricing
realtime_pricing ItemRealtimePricing Real-time Pricing
related ItemRelated Related items
reporting ItemReporting Reporting
restriction ItemRestriction Restrictions
revguard ItemRevguard Revguard.com
reviews ItemReviews Reviews
salesforce ItemSalesforce Salesforce.com configuration
shipping ItemShipping Shipping
tax ItemTax Tax settings
third_party_email_marketing array of ItemThirdPartyEmailMarketing 3rd Party Email Marketing
variant_items array of ItemVariantItem Variant Items
variations array of ItemVariation Variations
wishlist_member ItemWishlistMember WishList Member

ItemAccounting

Attributes
Name Data Type Description
accounting_code string(50) QuickBooks item name if different than the item id
qb_class string(31) QuickBooks class if you are classifying items on your invoices/receipts

ItemAmember

Attributes
Name Data Type Description
amember_payment_duration_days integer (int32) The number of days that the customer should be given access to the item
amember_product_id string(10) A-member product id give customer access to when they purchase this item

ItemAutoOrder

Attributes
Name Data Type Description
auth_future_amount number Amount to try and authorize for the future rebill
auth_test_amount number Amount to try and test authorize
auto_order_cancel_item_id string(20) Item id to attempt charging the customer for if they cancel
auto_order_cancel_item_oid integer (int32) Item object identifier to attempt charging the customer for if they cancel
auto_order_downgrade_items array of string List of downgrade items presented to customer service representatives
auto_order_paused boolean True if the rebill processing of this item is paused
auto_order_schedules array of string The user selectable schedules that are available
Allowed Values
  • Weekly
  • Every 10 Days
  • Biweekly
  • Every 24 Days
  • Every 28 Days
  • Monthly
  • Every 45 Days
  • Every 2 Months
  • Every 3 Months
  • Every 4 Months
  • Every 6 Months
  • Yearly
auto_order_upgrade_items array of string List of upgrade items presented to customer service representatives
auto_order_upsell boolean True if this item uses a fixed upsell step schedule
auto_order_upsell_no_easy_cancel boolean Do not send the easy cancel email to the customer
auto_order_upsell_one_per_customer boolean Limit the purchase of this item to one per customer
auto_orderable boolean True if this item can be automatically ordered by the customer
cancel_other_auto_orders boolean True if other auto orders for this customer should be canceled when this item is ordered
free_shipping_auto_order boolean True if the customer should be given free shipping
steps array of ItemAutoOrderStep The rebill steps if this auto order is an upsell

ItemAutoOrderStep

Attributes
Name Data Type Description
arbitrary_schedule_days integer (int32) If the schedule is arbitrary, then this is the number of days
arbitrary_unit_cost number Arbitrary unit cost used to override the regular item cost
arbitrary_unit_cost_schedules array of ItemAutoOrderStepArbitraryUnitCostSchedule Arbitrary unit costs schedules for more advanced discounting by rebill attempt
grandfather_pricing array of ItemAutoOrderStepGrandfatherPricing Grand-father pricing configuration if the rebill schedule has changed over time
managed_by string Managed by (defaults to UltraCart)
Allowed Values
  • UltraCart
  • CCBill
pause_days integer (int32) Number of days to pause
pause_until_date string (dateTime) Wait for this step to happen until the specified date
preshipment_notice_days integer (int32) If set, a pre-shipment notice is sent to the customer this many days in advance
recurring_merchant_item_id string(20) Item id to rebill
recurring_merchant_item_oid integer (int32) Item object identifier to rebill
repeat_count integer (int32) Number of times to rebill. Last step can be null for infinite
schedule string Frequency of the rebill
Allowed Values
  • Weekly
  • Every...
  • Every 10 Days
  • Biweekly
  • Every 24 Days
  • Every 28 Days
  • Monthly
  • Every 45 Days
  • Every 2 Months
  • Every 3 Months
  • Every 4 Months
  • Every 6 Months
  • Yearly
subscribe_email_list_name string Email list name to subscribe the customer to when the rebill occurs
subscribe_email_list_oid integer (int32) Email list identifier to subscribe the customer to when this rebill occurs
type string Type of step (item or pause)
Allowed Values
  • item
  • pause

ItemAutoOrderStepArbitraryUnitCostSchedule

Attributes
Name Data Type Description
arbitrary_unit_cost number Arbitrary unit cost
retry_days integer (int32) Retry days

ItemAutoOrderStepGrandfatherPricing

Attributes
Name Data Type Description
on_or_before_date string (dateTime) On or before date
unit_cost number Unit cost

ItemCCBill

Attributes
Name Data Type Description
ccbill_allowed_currencies string Allowed currencies
ccbill_allowed_types string Allowed types
ccbill_currency_code string Currency code
ccbill_form_name string Form name
ccbill_subaccount_id string Sub-account id
ccbill_subscription_type_id string Subscription type id

ItemChannelPartnerMapping

Attributes
Name Data Type Description
barcode_ua string Barcode UA (EDI only)
barcode_uc string Barcode UC (EDI only)
barcode_ui string Barcode UI (EDI only)
barcode_uk string Barcode UK (EDI only)
buyer_dpci string Buyer DPCI (EDI only)
buyer_item_number string Buyer item number (EDI only)
channel_partner_code string Channel partner code
channel_partner_oid integer (int32) Channel partner object identifier
from_item_id string(30) From Item ID
from_sku string(50) From SKU
mutually_defined_number string Mutually defined number (EDI only)
quantity_ratio_cp integer (int32) Ratio (Channel Partner)
quantity_ratio_uc integer (int32) Ratio (UltraCart)
sku string(50) SKU
unit_of_measure string Unit of measure
vendor_number string Vendor number (EDI only)
vendor_style_number string Vendor style number (EDI only)

ItemChargeback

Attributes
Name Data Type Description
addendums array of ItemChargebackAddendum Addendums
adjustment_requests array of ItemChargebackAdjustmentRequest Adjustment requests

ItemChargebackAddendum

Attributes
Name Data Type Description
chargeback_addendum_oid integer (int32) Chargeback addendum object identifier
description string Description
file_size integer (int32) Size of the file
pages integer (int32) Number of pages

ItemChargebackAdjustmentRequest

Attributes
Name Data Type Description
chargeback_adjustment_request_oid integer (int32) Chargeback adjustment request object identifier
description string Description
reason_code string Reason code

ItemCheckout

Attributes
Name Data Type Description
suppress_buysafe boolean True to suppress buySAFE
terms string(10000) Terms for purchasing this item
terms_translated_text_instance_oid (read only) integer (int32) Terms translated text instance identifier

ItemContent

Attributes
Name Data Type Description
assignments array of ItemContentAssignment StoreFront assignments
attributes array of ItemContentAttribute StoreFront attributes
exclude_from_search boolean Exclude from search
exclude_from_top_sellers boolean Exclude from the top sellers list in the StoreFront
extended_description string(2000) Extended description (max 2000 characters)
extended_description_translated_text_instance_oid (read only) integer (int32) Extneded description text translation instance identifier
multimedia array of ItemContentMultimedia Multimedia
new_item boolean True if the item is new
new_item_end string (dateTime) The date the item should no longer be considered new
new_item_start string (dateTime) The date the item should start being considered new
view_url string Legacy view URL (not used by StoreFronts)

ItemContentAssignment

Attributes
Name Data Type Description
group_oid integer (int32) Page (group) object identifier
group_path string Page (group) path
host string StoreFront host name
sort_order integer (int32) Sort order (optional)
url_part string(150) URL part if the item id is not used

ItemContentAttribute

Attributes
Name Data Type Description
name string(400) Attribute name
translated_text_instance_oid (read only) integer (int32) Attribute translated text instance identifier
type string Attribute type
Allowed Values
  • boolean
  • color
  • definitionlist
  • html
  • integer
  • mailinglist
  • multiline
  • rgba
  • simplelist
  • string
  • videolist
value string(100000) Attribute value

ItemContentMultimedia

Attributes
Name Data Type Description
cloud_url (read only) string URL where the image can be downloaded from the cloud
cloud_url_expiration (read only) string (dateTime) Expiration date of the cloud URL
code string(20) Code assigned to the file
description string(50000) Description
exclude_from_gallery boolean True to exclude from multimedia gallery
file_name string(75) File name
height integer (int32) Height of the image
merchant_item_multimedia_oid integer (int32) Item multimedia object identifier
orphan boolean True if the multimedia is an orphan of the active StoreFront themes
placeholder boolean True if the object is a place holder that can be populated
temp_multimedia_oid integer (int32) Temporary multimedia object identifier assigned if uploading new multimedia
thumbnails array of ItemContentMultimediaThumbnail Thumbnails of this image
type string Type of file
Allowed Values
  • Image
  • PDF
  • Text
  • Unknown
  • Video
url (read only) string URL to download file
width integer (int32) Width of the image

ItemContentMultimediaThumbnail

Attributes
Name Data Type Description
height integer (int32) Height of the thumbnail
http_url string HTTP URL to view the thumbnail
https_url string HTTPS URL to view the thumbnail
png_format boolean True if PNG, false if JPEG
square boolean True if the thumbnail is square
width integer (int32) Width of the thumbnail

ItemDigitalDelivery

Attributes
Name Data Type Description
activation_code_description string(50) Description of the activation code
activation_code_low_warning integer (int32) The number of activation codes whcih should generate a warning email
activation_code_realtime_url string(350) The URL to retrieve activation codes from in real-time
activation_code_shared_secret string(20) Shared secret used when communicating with the real-time URL
activation_code_type string Type of activation code
Allowed Values
  • off
  • list
  • realtime
digital_items array of ItemDigitalItem Digital items that customer can download when this item is purchased

ItemDigitalItem

Attributes
Name Data Type Description
creation_dts (read only) string (dateTime) File creation date
description (read only) string(200) Description of the digital item
file_size (read only) integer (int64) File size
mime_type (read only) string(100) Mime type associated with the file
original_filename string(250) Original filename

ItemEbay

Attributes
Name Data Type Description
active boolean True if the item is active for listing
category_id integer (int32) e-Bay category ID
category_specifics array of ItemEbayCategorySpecific Answers to category specific questions
condition_description string Description of the condition (e-Bay constant)
Allowed Values
  • New
  • New other (see details)
  • New with defects
  • Manufacturer Refurbished
  • Seller Refurbished
  • Like New
  • Used
  • Very Good
  • Good
  • Acceptable
  • For parts or not working
condition_id integer (int32) Numerical ID of the condition (e-Bay constant)
consecutive_failures integer (int32) Number of consecutive failures trying to list this item
custom_category1 integer (int64) e-Bay Store category 1
custom_category2 integer (int64) e-Bay Store category 2
dispatch_time_max integer (int32) Maximum number of days it will take to ship the item
domestic_1_additional_cost number Domestic 1 method additional item cost
domestic_1_first_cost number Domestic 1 method first item cost
domestic_2_additional_cost number Domestic 2 method additional item cost
domestic_2_first_cost number Domestic 2 method first item cost
domestic_3_additional_cost number Domestic 3 method additional item cost
domestic_3_first_cost number Domestic 3 method first item cost
domestic_4_additional_cost number Domestic 4 method additional item cost
domestic_4_first_cost number Domestic 4 method first item cost
ebay_auction_id string If listed, this is the e-Bay auction id
ebay_specific_inventory integer (int32) e-Bay specific inventory
ebay_template_name string The template name to use hwen rendering the e-Bay listing
ebay_template_oid integer (int32) The template object identifier to use when rendering the e-Bay listing
end_time (read only) string (dateTime) Date/time of the auction end
free_shipping boolean True if item receives free shipping
free_shipping_method string The method that is free for free shipping
international_1_additional_cost number International 1 method additional item cost
international_1_first_cost number International 1 method first item cost
international_2_additional_cost number International 2 method additional item cost
international_2_first_cost number International 2 method first item cost
international_3_additional_cost number International 3 method additional item cost
international_3_first_cost number International 3 method first item cost
international_4_additional_cost number International 4 method additional item cost
international_4_first_cost number International 4 method first item cost
last_status_dts (read only) string (dateTime) Date/time of the last status check
listed_dispatch_time_max integer (int32) Current listing dispatch time maximum
listed_ebay_template_oid integer (int32) The template object identifier used for the listing
listing_dts (read only) string (dateTime) Date/time of the listing
listing_duration string The duration of the listing
Allowed Values
  • GTC
  • Days 1
  • Days 3
  • Days 5
  • Days 7
  • Days 10
  • Days 14
  • Days 21
  • Days 30
  • Days 60
  • Days 90
  • Days 120
  • End
listing_price number Price to list the item at
listing_price_override number The price to list the item at if different than the regular UltraCart item price
listing_type string The type of e-Bay listing
Allowed Values
  • Auction
  • Fixed
  • Store
marketplace_analysis (read only) ItemEbayMarketPlaceAnalysis Details of the marketplace analysis
marketplace_analysis_perform boolean True if marketplace analysis should be performed
marketplace_final_value_fee_percentage number Marketplace FVF percentage
marketplace_last_check_dts (read only) string (dateTime) Date/time of the marketplace analysis last check
marketplace_lowest (read only) boolean True if we are the lowest offer in the marketplace
marketplace_map_violation (read only) boolean True if another seller is violating MAP
marketplace_multiplier number Marketplace multiplier
marketplace_other_price (read only) number Marketplace other price
marketplace_other_seller (read only) string Marketplace other seller
marketplace_other_shipping (read only) number Marketplace other shipping
marketplace_other_total (read only) number Marketplace other total
marketplace_our_additional_profit_potential number Marketplace our additional profit potential
marketplace_our_price (read only) number Marketplace our price
marketplace_our_profit (read only) number Marketplace our profit
marketplace_our_shipping (read only) number Marketplace our shipping
marketplace_our_total (read only) number Marketplace our total
marketplace_overhead number Marketplace overhead
marketplace_profitable (read only) boolean True if our listing is profitable to sell
next_attempt_dts (read only) string (dateTime) Date/time for the next attempt to list
next_listing_duration string The next listing duration to use when the current listing ends.
Allowed Values
  • GTC
  • Days 1
  • Days 3
  • Days 5
  • Days 7
  • Days 10
  • Days 14
  • Days 21
  • Days 30
  • Days 60
  • Days 90
  • Days 120
  • End
no_promotional_shipping boolean True if the item should not qualify for promotional shipping
packaging_handling_costs number Packaging and handling costs
previous_ebay_auction_id (read only) string Previous e-Bay auction id
quantity integer (int32) Quantity available of the item
reserve_price number Reserve price
send_dimensions_and_weight string How to send the item dimensions and weights to e-Bay
Allowed Values
  • packedItem
  • itemOnly
start_time (read only) string Date/time of the auction start
status string Status of the item's listing
Allowed Values
  • Listed
  • To Be Listed
  • Success
  • Error
  • Expired
  • Inactive
  • Revise
  • To Be Delisted
  • To Be Deleted
  • Configuration Issue
  • Listed Other UC Account
target_dispatch_time_max integer (int32) Typical number of days it will take to ship the item

ItemEbayCategorySpecific

Attributes
Name Data Type Description
name string Name of the category specification field
value string Value

ItemEbayMarketListing

Attributes
Name Data Type Description
auction_id string Auction ID
price number Price
seller string Seller
shipping number Shipping
total number Total

ItemEbayMarketPlaceAnalysis

Attributes
Name Data Type Description
adjusted_price number Adjusted price
adjusted_shipping number Adjusted shipping
adjusted_total number Adjusted total
cogs number Cost of goods sold
final_value_fee number Final value fee
minimum_advertised_price number Minimum advertised price
other_listings array of ItemEbayMarketListing Other listings
our_listing ItemEbayMarketListing Our listing
overhead number Overhead
profit_potential number Profit potential

ItemEmailNotifications

Attributes
Name Data Type Description
skip_receipt boolean Skip receipt email to customer
skip_shipment_notification boolean Skip shipment notification to customer

ItemEnrollment123

Attributes
Name Data Type Description
enrollment123_product_code string Enrolment 123 product code

ItemGiftCertificate

Attributes
Name Data Type Description
gift_certificate boolean True if the purchase of this item generates a gift certificate
gift_certificate_expiration_days integer (int32) The number of days that the gift certificate is good for (optional)

ItemGoogleProductSearch

Attributes
Name Data Type Description
adwords_grouping string(50) Adwords grouping
adwords_label1 string(50) Adwords label 1
adwords_label2 string(50) Adwords label 2
adwords_label3 string(50) Adwords label 3
adwords_label4 string(50) Adwords label 4
adwords_label5 string(50) Adwords label 5
age_group string(5) Age group
available_at_physical_store boolean Available at physical store
book_author string(50) Book - author
book_format string(50) Book - format
book_isbn string(20) Bood - ISBN
book_publisher string(50) Book - publisher
category_description string(1000) Category description
color string(20) Color
condition string(15) Condition
custom_label0 string(50) Custom label 0
custom_label1 string(50) Custom label 1
custom_label2 string(50) Custom label 2
custom_label3 string(50) Custom label 3
custom_label4 string(50) Custom label 4
gender string(6) Gender
google_product_category string(250) Google product category
music_artist string(50) Music - artist
music_format string(5) Music - format
music_release_date string (dateTime) Music - release date
omit_from_feed boolean Omit from feed
product_type string(10) Product type
promotion_id1 string(30) Promotion ID 1
promotion_id10 string(30) Promotion ID 10
promotion_id2 string(30) Promotion ID 2
promotion_id3 string(30) Promotion ID 3
promotion_id4 string(30) Promotion ID 4
promotion_id5 string(30) Promotion ID 5
promotion_id6 string(30) Promotion ID 6
promotion_id7 string(30) Promotion ID 7
promotion_id8 string(30) Promotion ID 8
promotion_id9 string(30) Promotion ID 9
search_dts string (dateTime) Search date/time
search_lowest_price number Search lowest price
search_lowest_url string(250) Search lowest URL
search_position integer (int32) Search position
size string(20) Size
video_director string(50) Video - director
video_format string(5) Video - format
video_rating string(5) Video - rating
video_release_date string (dateTime) Video - release date
video_starring string(150) Video - starring

ItemIdentifiers

Attributes
Name Data Type Description
barcode string(30) Barcode
manufacturer_name string(50) Manufacturer Name
manufacturer_sku string(25) Manufacturer SKU
unspsc string(20) UNSPSC

ItemInstantPaymentNotification

Attributes
Name Data Type Description
post_operation boolean True for HTTP POST instead of GET
successful_response_text string(1024) Successful response text
url string(1024) URL

ItemInstantPaymentNotifications

Attributes
Name Data Type Description
notifications array of ItemInstantPaymentNotification Notifications

ItemInternal

Attributes
Name Data Type Description
memo string(250) Memo

ItemKitComponent

Attributes
Name Data Type Description
component_cost number Component item cost
component_description (read only) string Component item description
component_merchant_item_id string Component item ID
component_merchant_item_oid integer (int32) Component item object identifier
quantity integer (int32) Quantity

ItemKitDefinition

Attributes
Name Data Type Description
components array of ItemKitComponent Components

ItemOption

Attributes
Name Data Type Description
cost_if_specified number Cost if specified
cost_per_letter number Cost per letter
cost_per_line number Cost per line
ignore_if_default boolean Ignore this option on the order if the default value is selected
label string(50) Label
label_translated_text_instance_oid (read only) integer (int32) Label translated text instance ID
name string(50) Name
name_translated_text_instance_oid (read only) integer (int32) Name translated text instance ID
one_time_fee boolean One time fee
option_oid integer (int32) Option object identifier
required boolean True if the customer is required to specify an answer
system_option boolean True if this is a system option
type string Type of option
Allowed Values
  • dropdown
  • file attachment
  • fixed
  • hidden
  • multiline
  • radio
  • single
values array of ItemOptionValue Values

ItemOptionValue

Attributes
Name Data Type Description
additional_dimension_application string Additional dimensions application
Allowed Values
  • none
  • set item to
  • add item
additional_items array of ItemOptionValueAdditionalItem Additional items to add to the order if this value is selected
cost_change number Cost change
default_value boolean True if default value
digital_items array of ItemOptionValueDigitalItem Digital items to allow the customer to download if this option value is selected
height Distance If additional_dimension_application != none
Additional dimensions (height)
length Distance If additional_dimension_application != none
Additional dimensions (length)
merchant_item_multimedia_oid integer (int32) Multimedia object identifier associated with this option value
option_value_oid integer (int32) Option value object identifier
percent_cost_change number Percentage cost change
translated_text_instance_oid (read only) integer (int32) Translated text instance id
value string(1024) Value
weight_change Weight Weight change
weight_change_percent number Percentage weight change
width Distance If additional_dimension_application != none
Additional dimensions (width)

ItemOptionValueAdditionalItem

Attributes
Name Data Type Description
additional_merchant_item_id string Additional item id
additional_merchant_item_oid integer (int32) Additional item object identifier

ItemOptionValueDigitalItem

Attributes
Name Data Type Description
digital_item_oid integer (int32) Digital item object identifier
original_filename string Original filename

ItemPaymentProcessing

Attributes
Name Data Type Description
block_prepaid boolean True if prepaid cards should be blocked from buying this item
credit_card_transaction_type string Credit card transaction type
Allowed Values
  • auth and capture
  • auth then capture
  • auth only
no_realtime_charge boolean True if no real-time charge should be performed on this item.
payment_method_validity array of string Payment method validity
Allowed Values
  • +Affirm
  • -Affirm
  • +Amazon
  • -Amazon
  • +AMEX
  • -AMEX
  • +CASH
  • -CASH
  • +Check
  • -Check
  • +COD
  • -COD
  • +Diners Club
  • -Diners Club
  • +Discover
  • -Discover
  • +eCheck
  • -eCheck
  • +JCB
  • -JCB
  • +MasterCard
  • -MasterCard
  • +Money Order
  • -Money Order
  • +PayPal
  • -PayPal
  • +Purchase Order
  • -Purchase Order
  • +Quote Request
  • -Quote Request
  • +VISA
  • -VISA
  • -Wire Transfer
  • +Wire Transfer
rotating_transaction_gateway_codes array of string Rotating transaction gateway codes

ItemPhysical

Attributes
Name Data Type Description
height Distance Height
length Distance Length
weight Weight Weight
width Distance Width

ItemPricing

Attributes
Name Data Type Description
allow_arbitrary_cost boolean Allow arbitrary cost
arbitrary_cost_velocity_code string(10000) Arbitrary cost velocity code
automatic_pricing_tier_name string Automatic pricing tier name
automatic_pricing_tier_oid integer (int32) Automatic pricing tier object identifier
cogs number Cost of goods sold
cost number Cost
currency_code string(3) Currency code
Allowed Values
  • AUD
  • BRL
  • CAD
  • CHF
  • EUR
  • GBP
  • JPY
  • MXN
  • NOK
  • NZD
  • RUB
  • SEK
  • SGD
  • TRY
  • USD
manufacturer_suggested_retail_price number Manufacturer suggested retail price
maximum_arbitrary_cost number Maximum arbitrary cost
minimum_advertised_price number Minimum advertised price
minimum_arbitrary_cost number Minimum arbitrary cost
mix_and_match_group string Mix and match group
mix_and_match_group_oid integer (int32) Mix and match group object identifier
sale_cost number Sale cost
sale_end string (dateTime) If sale_cost specified
Sale end
sale_start string (dateTime) If sale_cost specified
Sale start
tiers array of ItemPricingTier Tiers

ItemPricingTier

Attributes
Name Data Type Description
default_tier (read only) boolean True if this is the default tier
discounts array of ItemPricingTierDiscount Discounts
limit ItemPricingTierLimit Limits
name (read only) string Pricing tier name
pricing_tier_oid (read only) integer (int32) Pricing tier object identifier

ItemPricingTierDiscount

Attributes
Name Data Type Description
cost number Cost
quantity integer (int32) Quantity

ItemPricingTierLimit

Attributes
Name Data Type Description
cumulative_order_limit integer (int32) Cumulative order limit
individual_order_limit integer (int32) Individual order limit
multiple_quantity integer (int32) Multiple quantity

ItemRealtimePricing

Attributes
Name Data Type Description
realtime_pricing_parameter string Real-time pricing provider parameters
realtime_pricing_provider string Real-time pricing provider name
realtime_pricing_provider_oid integer (int32) Real-time pricing provide object identifier

ItemRelated

Attributes
Name Data Type Description
no_system_calculated_related_items boolean True to suppress system calculated relationships
not_relatable boolean Not relatable
related_items array of ItemRelatedItem Related items

ItemRelatedItem

Attributes
Name Data Type Description
related_merchant_item_id string Related item id
related_merchant_item_oid integer (int32) Related item object identifier
type string Relationship type
Allowed Values
  • System
  • UserDefined

ItemReporting

Attributes
Name Data Type Description
report_as_upsell boolean Report as an upsell
report_pickable_quantities array of integer (int32) Report pickable quantities

ItemRestriction

Attributes
Name Data Type Description
exclude_coupon boolean Exclude coupons
exclude_from_free_promotion boolean Exclude from free promotion
items array of ItemRestrictionItem Items
maximum_quantity integer (int32) Maximum quantity
minimum_quantity integer (int32) Minimum quantity (defaults to 1)
multiple_quantity integer (int32) Multiple of quantity
one_per_customer boolean One per customer
purchase_separately boolean Purchase separately

ItemRestrictionItem

Attributes
Name Data Type Description
restrict_merchant_item_id string Restrict item id
restrict_merchant_item_oid integer (int32) Restrict item object identifier
type string Restriction type
Allowed Values
  • can not be purchased with
  • can only be purchased with
  • must be purchased with

ItemRevguard

Attributes
Name Data Type Description
revguard_canceled_csr_prompt_group integer (int64) Canceled CSR prompt group
revguard_canceled_ivr_prompt_group integer (int64) IVR prompt group
revguard_canceled_web_prompt_group integer (int64) Canceled web prompt group
revguard_client_brand integer (int64) Client brand
revguard_csr_prompt_group integer (int64) CSR prompt group
revguard_ivr_prompt_group integer (int64) IVR prompt group
revguard_web_prompt_group integer (int64) Web prompt group

ItemReviews

Attributes
Name Data Type Description
has_approved_review (read only) boolean True if the item has an approved review
has_review (read only) boolean True if the item has a review
review_count (read only) integer (int32) Number of approved reviews
review_overall (read only) number Overall score of reviews
review_template_name string Review template name
review_template_oid integer (int32) Review template object identifier
reviewable boolean True if the item is reviewable

ItemSalesforce

Attributes
Name Data Type Description
sfdc_pricebook_id string Salesforce.com pricebook id
sfdc_product_id string Salesforce.com product id

ItemShipping

Attributes
Name Data Type Description
allow_back_order boolean Allow back order
amazon_fba boolean Fulfillment by Amazon.com
case_inner_packs integer (int32) Case inner packs
case_units integer (int32) Case units
cases array of ItemShippingCase Cases
country_code_of_origin string(2) Country code of origin for customs forms. (ISO-3166 two letter code)
customs_description string Customs description
customs_value number Customs value
delivery_on_friday boolean Delivery on Friday
delivery_on_monday boolean Delivery on Monday
delivery_on_saturday boolean Delivery on Saturday
delivery_on_sunday boolean Delivery on Sunday
delivery_on_thursday boolean Delivery on Thursday
delivery_on_tuesday boolean Delivery on Tuesday
delivery_on_wednesday boolean Delivery on Wednesday
destination_markups array of ItemShippingDestinationMarkup Destination markups
destination_restrictions array of ItemShippingDestinationRestriction Destination restrictions
distribution_centers array of ItemShippingDistributionCenter Distribution centers
eta string (dateTime) Estimated time of arrival
free_shipping boolean Qualifies for free shipping
freight_class string Freight class
hazmat boolean Hazardous material
made_to_order boolean True if this item is made to order
made_to_order_lead_time integer (int32) Number of days lead time it takes to make the item before ite can ship
max_days_time_in_transit integer (int32) Maximum days allowed in transit
methods array of ItemShippingMethod Methods
no_shipping_discount boolean No shipping discounts
package_requirements array of ItemShippingPackageRequirement Package requirements
perishable_class_name string Perishable class name
perishable_class_oid integer (int32) Perishable class object identifier
preorder boolean This item is on pre-order
require_delivery_date boolean True to require customer to select a delivery date
restrict_shipment_on_friday boolean Restrict shipment on Friday
restrict_shipment_on_monday boolean Restrict shipment on Monday
restrict_shipment_on_saturday boolean Restrict shipment on Saturday
restrict_shipment_on_sunday boolean Restrict shipment on Sunday
restrict_shipment_on_thursday boolean Restrict shipment on Thursday
restrict_shipment_on_tuesday boolean Restrict shipment on Tuesday
restrict_shipment_on_wednesday boolean Restrict shipment on Wednesday
ship_separately boolean Ship this item in a separate box
ship_separately_additional_weight Weight Ship separately box weight
ship_separately_height Distance Ship separately box height
ship_separately_length Distance Ship separately box length
ship_separately_package_special_type string Ship separately package special type
Allowed Values
  • Crate
  • FedEx: Box
  • FedEx: Envelope
  • FedEx: Pak
  • FedEx: Tube
  • Pallet Other
  • Pallet 48 x 40
  • Pallet 48 x 48
  • Pallet 60 x 48
  • Pallet 120 x 80
  • Pallet 120 x 100
  • Pallet 120 x 120
  • UPS: Express Box
  • UPS: Letter
  • UPS: Pak
  • UPS: Tube
  • USPS: Express Mail Flat Rate Envelope
  • USPS: Express Mail Padded Flat Rate Envelope
  • USPS: Priority Mail Medium Flat Rate Box
  • USPS: Priority Mail Large Flat Rate Box
  • USPS: Priority Mail Small Flat Rate Box
  • USPS: Priority Mail Regional Rate A Box
  • USPS: Priority Mail Regional Rate B Box
  • USPS: Priority Mail Regional Rate C Box
  • USPS: Priority Mail Flat Rate Envelope
  • USPS: Priority Mail Padded Flat Rate Envelope
  • USPS: Priority Mail Legal Flat Rate Envelope
ship_separately_width Distance Ship separately box width
special_product_type string Special product type (USPS Media Mail)
Allowed Values
  • Book or Software
  • Music
  • Editorial
track_inventory boolean Track inventory

If all of the delivery_on_<day of week> flags are false, then delivery is allowed on all days of the week.

If all of the restrict_shipment_on<day of week> are false, then shipment is not restricted on any days of the week.

If all of the delivery_on_<day of week> flags are false, then delivery is allowed on all days of the week.

If all of the restrict_shipment_on<day of week> are false, then shipment is not restricted on any days of the week.

ItemShippingCase

Attributes
Name Data Type Description
case_label string(20) Case label
case_merchant_item_id string Case item id
case_merchant_item_oid integer (int32) Case item object identifier
quantity integer (int32) Case quantity

ItemShippingDestinationMarkup

Attributes
Name Data Type Description
country_code string(2) Country code (ISO-3166 two letter)
flat_fee number Flat fee
per_item number Per item
postal_code string(20) Postal code
shipping_method string Shipping method
state string(32) State

ItemShippingDestinationRestriction

Attributes
Name Data Type Description
country_code string(2) Country code (ISO-3166 two letter)
state string(32) State
validity string Validity
Allowed Values
  • valid only for
  • invalid for

ItemShippingDistributionCenter

Attributes
Name Data Type Description
allocated_to_placed_orders (read only) number Allocated to placed orders
allocated_to_shopping_carts (read only) number Allocated to shopping carts
available_to_allocate (read only) number Available to allocate
desired_inventory_level number Desired inventory level
distribution_center_code string Distribution center code
distribution_center_oid integer (int32) Distribution center object identifier
eta string (dateTime) Estimated time of arrival
handles boolean True if this distribution center handles this item
inventory_level number Inventory level
maximum_backorder integer (int32) Maximum back-order
reorder_inventory_level number Reorder inventory level (triggers notification)
sku string(50) SKU
stock_picking_location string(20) Stock picking location

ItemShippingMethod

Attributes
Name Data Type Description
cost number Cost
each_additional_item_markup number Each additional item markup
filter_to_if_available boolean Filter to this method if available
first_item_markup number First item markup
fixed_shipping_cost number Fixed shipping cost
flat_fee_markup number Flat fee markup
free_shipping boolean Free shipping
per_item_fee_markup number Per item fee markup
percentage_markup number Percentage markup
percentage_of_item_markup number Percentage of item markup
relax_restrictions_on_upsell boolean Relax restrictions on upsell
shipping_method string Shipping method name
shipping_method_oid integer (int32) Shipping method object identifier
shipping_method_validity string Shipping method validity
Allowed Values
  • invalid for
  • valid for
  • valid only for
signature_required boolean Signature required

ItemShippingPackageRequirement

Attributes
Name Data Type Description
package_name string Package name
package_oid integer (int32) Package object identifier

ItemsResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
items array of Item items
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful

ItemTax

Attributes
Name Data Type Description
exemptions array of ItemTaxExemption Exemptions
tax_free boolean True if tax free
taxable_cost number Taxable cost if different than regular cost

ItemTaxExemption

Attributes
Name Data Type Description
city string(32) City
country_code string(2) Country code (ISO-3166 two letter)
county string(32) County
postal_code string(20) Postal code
state_code string(32) State code

ItemThirdPartyEmailMarketing

Attributes
Name Data Type Description
add_tags array of string Add tags
provider_name string Provider name
Allowed Values
  • ActiveCampaign
  • AWeber
  • Campaign Monitor
  • ConstantContact
  • Emma
  • GetResponse
  • iContact
  • Klaviyo
  • Lyris
  • LyrisHQ
  • MailChimp
  • SilverPop
remove_tags array of string Remove tags
subscribe_lists array of string Subscribe to lists
unsubscribe_lists array of string Unsubscribe from lists

ItemVariantItem

Attributes
Name Data Type Description
description (read only) string(512) Description
merchant_item_multimedia_oid integer (int32) Multimedia object identifier
variant_merchant_item_id string Variant item id
variant_merchant_item_oid integer (int32) Variant item object identifier
variation_options array of string Variation options
variations array of string Variations

ItemVariation

Attributes
Name Data Type Description
default_text string(50) Default text
default_text_translated_text_instance_oid (read only) integer (int32) Default text translated text instance id
name string(50) Name
name_translated_text_instance_oid (read only) integer (int32) Name translated text instance id
options array of ItemVariationOption Options

ItemVariationOption

Attributes
Name Data Type Description
default_option boolean True if default option
merchant_item_multimedia_oid integer (int32) Multimedia object identifier
translated_text_instance_oid (read only) integer (int32) Translated text instance id
value string(50) Value

ItemWishlistMember

Attributes
Name Data Type Description
wishlist_member_instance_description string WishList Member instance description
wishlist_member_instance_oid integer (int32) WishList Member instance object identifier
wishlist_member_sku string(25) WishList Member SKU

Order

Attributes
Name Data Type Description
affiliates (read only) array of OrderAffiliate Affiliates if any were associated with the order. The first one in the array sent the order and each subsequent affiliate is the recruiter that earns a downline commission.
auto_order (read only) OrderAutoOrder Auto Order
billing OrderBilling Billing
buysafe OrderBuysafe buySAFE bond
channel_partner (read only) OrderChannelPartner Channel Partner if one is associated with the order
checkout OrderCheckout Checkout
coupons array of OrderCoupon Coupons
creation_dts (read only) string (dateTime) Date/time that the order was created
currency_code string(3) Currency code that the customer used if different than the merchant's base currency code
Allowed Values
  • AUD
  • BRL
  • CAD
  • CHF
  • EUR
  • GBP
  • JPY
  • MXN
  • NOK
  • NZD
  • RUB
  • SEK
  • SGD
  • TRY
  • USD
current_stage string Current stage that the order is in.
Allowed Values
  • Accounts Receivable
  • Pending Clearance
  • Fraud Review
  • Rejected
  • Shipping Department
  • Completed Order
  • Quote Request
  • Quote Sent
  • Least Cost Routing
customer_profile (read only) Customer Customer profile if one is associated with the order
digital_order OrderDigitalOrder Digital order details
edi OrderEdi EDI related information (only for orders received via EDI channel partner)
exchange_rate number Exchange rate at the time the order was placed if currency code is different than the base currency
fraud_score (read only) OrderFraudScore Fraud score if checked on the order
gift OrderGift Gift giving information
gift_certificate (read only) OrderGiftCertificate Gift certificate used on the order
internal OrderInternal Internal
items array of OrderItem Items
language_iso_code (read only) string(3) Three letter ISO-639 language code used by the customer during the checkout if different than the default language
linked_shipment (read only) OrderLinkedShipment Linked shipment information (CCBill orders only)
marketing OrderMarketing Marketing
merchant_id (read only) string UltraCart merchant ID owning this order
order_id (read only) string Order ID
payment OrderPayment Payment
quote (read only) OrderQuote Quote
refund_dts (read only) string (dateTime) If the order was refunded, the date/time that the last refund occurred
reject_dts (read only) string (dateTime) If the order was rejected, the date/time that the rejection occurred
salesforce (read only) OrderSalesforce Salesforce.com identifiers
shipping OrderShipping Shipping
summary OrderSummary Summary
taxes OrderTaxes Taxes

OrderAffiliate

This object is read only. Changing the affiliate association should be with via the user interface.
Attributes
Name Data Type Description
affiliate_oid integer (int32) Affiliate ID
ledger_entries array of OrderAffiliateLedger Ledger entries associated with all the commissions earned on this order
sub_id string Sub identifier provided by the affiliate on the click that generated this order

OrderAffiliateLedger

This object is read only.
Attributes
Name Data Type Description
assigned_by_user string UltraCart user name that assigned this commission if manually assigned
item_id string Item ID that this ledger record is associated with
tier_number integer (int32) Tier number of this affiliate in the commission calculation
transaction_amount number Amount of the transaction
transaction_amount_paid number The amount that has been paid so far on the transaction
transaction_dts string (dateTime) The date/time that the affiliate ledger was generated for the transaction
transaction_memo string Details of the transaction suitable for display to the affiliate
transaction_percentage number The percentage earned on the transaction
transaction_state string The state of the transaction
Allowed Values
  • Pending
  • Posted
  • Approved
  • Paid
  • Rejected
  • Partially Paid

OrderAutoOrder

Attributes
Name Data Type Description
auto_order_code string Unique identifier assigned to the auto order
original_order_id string Orignal order id that started this auto order sequence
status string The status of the auto order
Allowed Values
  • active
  • canceled
  • disabled

OrderBilling

Attributes
Name Data Type Description
address1 string(50) Address line 1
address2 string(50) Address line 2
cc_emails array of string CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters.
city string(32) City
company string(50) Company
country_code string(2) ISO-3166 two letter country code
day_phone string(25) Day time phone
email string(100) Email
evening_phone string(25) Evening phone
first_name string(30) First name
last_name string(30) Last name
postal_code string(20) Postal code
state_region string(32) State for United States otherwise region or province for other countries
title string(50) Title

OrderBuysafe

Attributes
Name Data Type Description
buysafe_bond_available (read only) boolean True if a buySAFE bond was available for purchase on this order
buysafe_bond_cost (read only) Currency Cost of the buySAFE bond
buysafe_bond_free (read only) boolean True if the buySAFE bond was free for this order
buysafe_bond_refunded (read only) Currency Amount of the buySAFE bond that was refunded
buysafe_bond_wanted boolean True if the buySAFE bond was wanted by the customer
buysafe_shopping_cart_id (read only) string Shopping cart ID associated with the buySAFE bond

OrderChannelPartner

This object is read only.
Attributes
Name Data Type Description
channel_partner_code string The code of the channel partner
channel_partner_data string Additional data provided by the channel partner
channel_partner_oid integer (int32) Channel partner object identifier
channel_partner_order_id string The order ID assigned by the channel partner for this order

OrderCheckout

Attributes
Name Data Type Description
comments string Comments from the customer. Rarely used on the single page checkout.
custom_field1 string(50) Custom field 1
custom_field2 string(50) Custom field 2
custom_field3 string(50) Custom field 3
custom_field4 string(50) Custom field 4
custom_field5 string(75) Custom field 5
custom_field6 string(50) Custom field 6
custom_field7 string(50) Custom field 7
customer_ip_address (read only) string IP address of the customer when placing the order
screen_branding_theme_code string(10) Screen branding theme code associated with the order (legacy checkout)
storefront_host_name string StoreFront host name associated with the order
upsell_path_code (read only) string Upsell path code assigned during the checkout that the customer went through

OrderCoupon

Attributes
Name Data Type Description
accounting_code (read only) string QuickBooks accounting code for this coupon
base_coupon_code string(20) Coupon code configured by the merchant. Will differ if the customer used a one time coupon code generated off this base coupon
coupon_code string(20) Coupon code entered by the customer

OrderDigitalItem

Attributes
Name Data Type Description
file_size (read only) integer (int64) File size
last_download (read only) string (dateTime) Last download
last_download_ip_address (read only) string IP address that performed the last download
original_filename (read only) string Original file name
product_code (read only) string Item id associated with this item
product_description (read only) string Item description associated with this item
remaining_downloads integer (int32) Remaining number of downloads
url (read only) string URL that the customer can click to download the specific digital item

OrderDigitalOrder

Attributes
Name Data Type Description
creation_dts (read only) string (dateTime) Date/time that the digital order was created
expiration_dts string (dateTime) Expiration date/time of the digital order
items array of OrderDigitalItem Digital items associated with the digital order
url (read only) string URL where the customer can go to and download their digital order content
url_id (read only) string URL ID is a unique code that is part of the URLs

OrderEdi

Attributes
Name Data Type Description
bill_to_edi_code string Billing address identification code from the EDI order. Typically DUNS or DUNS+4
edi_department string Department number associated with this EDI order
edi_internal_vendor_number string(50) Internal vendor number associated with this EDI order
ship_to_edi_code string Shipping address identification code from the EDI order. Typically DUNS or DUNS+4

OrderFraudScore

The fraud score for the order. This entire object is read only and the details are provided to help you make a more educated decision on whether the order should be approved or rejected if the score is above your threshold.
Attributes
Name Data Type Description
anonymous_proxy boolean True if the IP address is a known anonymous proxy server
bin_match string Whether the BIN (first six digits) matched the country
Allowed Values
  • NA
  • No
  • NotFound
  • Yes
carder_email boolean True if the email address belongs to a known credit card fraudster
country_code string Country code
country_match boolean Country code matches BIN country
customer_phone_in_billing_location string Whether the customer's phone number is located in the area of the billing address
Allowed Values
  • No
  • NotFound
  • Yes
distance_km integer (int32) Distance in kilometers between the IP address and the BIN
free_email boolean True if the email address is for a free service like gmail.com
high_risk_country boolean True if the customer is in a high risk country known for internet fraud
ip_city string City associated with the IP address
ip_isp string ISP that owns the IP address
ip_latitude string Approximate latitude associated with the IP address
ip_longitude string Approximate longitude associated with the IP address
ip_org string Organization that owns the IP address
ip_region string State/region associated with the IP address
proxy_score number Likelihood of the IP address being a proxy server
score number Overall score. This is the score that is compared to see if the order is rejected or held for review by the fraud filter rules.
ship_forwarder boolean True if the address is a known ship forwarding company
spam_score number Likelihood of the email address being associated with a spammer
transparent_proxy boolean True if the IP address that placed the order is a transparent proxy server

OrderGift

Attributes
Name Data Type Description
gift boolean True if the order is a gift
gift_charge Currency Charge associated with making this order a gift
gift_charge_accounting_code (read only) string QuickBooks code for the gift charge
gift_charge_refunded (read only) Currency Amount refunded of the gift charge
gift_email string(100) Email address of the gift recipient
gift_message string(10000) Message to the gift recipient
gift_wrap_accounting_code (read only) string QuickBooks code for the gift wrap charge
gift_wrap_cost Currency Cost of the gift wrap the customer selected
gift_wrap_refunded (read only) Currency Amount refunded of the gift wrap
gift_wrap_title string(30) Title of the gift wrap that the customer wants used

OrderGiftCertificate

Attributes
Name Data Type Description
gift_certificate_amount (read only) Currency Gift certificate amount applied to the order
gift_certificate_code (read only) string Gift certificate code used on the order
gift_certificate_oid (read only) integer (int32) Gift certificate object identifier

OrderInternal

Attributes
Name Data Type Description
exported_to_accounting boolean True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true
merchant_notes string Merchant notes
placed_by_user (read only) string If placed via the BEOE, this is the user that placed the order
refund_by_user (read only) string User that issued the refund
sales_rep_code string(10) Sales rep code associated with the order

OrderItem

Attributes
Name Data Type Description
accounting_code (read only) string QuickBooks code
activation_codes array of string Activation codes assigned to this item
barcode (read only) string Barcode
channel_partner_item_id string(30) Channel partner item id if this order came through a channel partner and the channel partner item id was mapped to an internal item id
cogs (read only) number Cost of goods sold
component_unit_value (read only) number Value of the kit component item
cost Currency Cost
country_code_of_origin (read only) string(2) Country of origin (ISO-3166 two letter code)
customs_description (read only) string Customs description
description string(2000) Description
discount (read only) Currency Discount
discount_quantity (read only) number Discount quantity
discount_shipping_weight (read only) Weight Discount shipping weight
distribution_center_code string Distribution center code responsible for shipping this item
edi OrderItemEdi EDI related item information
exclude_coupon boolean True if this item is excluded from coupons
free_shipping boolean True if the item receives free shipping
hazmat boolean Hazardous materials indicator
height Distance Height
item_reference_oid (read only) integer (int32) Item reference object identifier used to linked to auto order item record
kit boolean True if this item is a kit
kit_component boolean True if this item is a kit component
length Distance Length
manufacturer_sku (read only) string Manufacturer SKU
max_days_time_in_transit integer (int32) Maximum days that the item can be in transit before spoilage (perishable products)
merchant_item_id string(20) Item ID
mix_and_match_group_name string Mix and match group name
mix_and_match_group_oid integer (int32) Mix and match group object identifier
no_shipping_discount boolean True if this item is excluded from shipping discounts
options array of OrderItemOption Options
packed_by_user (read only) string Packed by user
perishable_class string(50) Perishable class of the item
pricing_tier_name string Pricing tier that granted the particular price for this item if the customer profile had pricing tiers assigned
quantity number Quantity
quantity_refunded (read only) number Quantity refunded on this item
quickbooks_class string(31) QuickBooks class
ship_separately boolean True if this item ships in a separate box
shipped_by_user (read only) string Shipped by user
shipped_dts string (dateTime) Date/time that this item was marked shipped
special_product_type string Special product type (USPS Media Mail)
Allowed Values
  • Book or Software
  • Music
  • Editorial
tax_free boolean True if the item is tax free
taxable_cost Currency The taxable cost of the item. Typically the same as the cost
total_cost_with_discount (read only) Currency Total cost with discount
total_refunded (read only) Currency Total refunded on this item
transmitted_to_distribution_center_dts string (dateTime) Date/time that this item was transmitted to the distribution center
unit_cost_with_discount (read only) Currency Unit cost with discount
upsell boolean True if this item was added to the order as part of an upsell
weight Weight Weight
width Distance Width

OrderItemEdi

This object is read only.
Attributes
Name Data Type Description
identifications (read only) array of OrderItemEdiIdentification Identification information receives on the EDI purchase order
lots (read only) array of OrderItemEdiLot Lot information

OrderItemEdiIdentification

This object is read only.
Attributes
Name Data Type Description
identification string Identification value
quantity integer (int32) Quantity associated with this identifier

OrderItemEdiLot

This object is read only.
Attributes
Name Data Type Description
lot_expiration string (dateTime) Log expiration
lot_number string Lot number
lot_quantity integer (int32) Lot quantity

OrderItemOption

Attributes
Name Data Type Description
additional_dimension_application string How the additional dimensions are applied to the item.
Allowed Values
  • none
  • set item to
  • add item
cost_change Currency The amount that this option changes the cost
file_attachment (read only) OrderItemOptionFileAttachment File attachment if option_type is file and attachment has not expired.
height Distance If additional_dimension_application != none
Height
hidden boolean True if this option is hidden from display on the order
label string(50) Label
length Distance If additional_dimension_application != none
Length
one_time_fee boolean True if the cost associated with this option is a one time fee or multiplied by the quantity of the item
value string(1024) Value
weight_change Weight The amount that this option changes the weight
width Distance If additional_dimension_application != none
Width

OrderItemOptionFileAttachment

This object is read only
Attributes
Name Data Type Description
expiration_dts string (dateTime) Expiration date/time
file_name string File name
mime_type string Mime type
size integer (int32) Size

OrderLinkedShipment

This object is read only.
Attributes
Name Data Type Description
has_linked_shipment boolean True if this order has child linked shipments
linked_shipment boolean True if this order is linked to another parent order
linked_shipment_channel_partner_order_ids array of string If has_linked_shipment=true
The child linked shipment channel partner order ids
linked_shipment_order_ids array of string If has_linked_shipment=true
The child linked shipment order ids
linked_shipment_to_order_id string If linked_shipment=true
The parent order id that this one is linked to

OrderMarketing

Attributes
Name Data Type Description
advertising_source string(50) Advertising source
mailing_list boolean True if the customer has opted into mailing list subscription
referral_code string(30) Referral code

OrderPayment

Attributes
Name Data Type Description
check OrderPaymentCheck If payment_method=Check
Check payment information
credit_card OrderPaymentCreditCard If payment_method=Credit Card
Credit card payment information
echeck OrderPaymentECheck If payment_method=eCheck
E-Check payment information
hold_for_fraud_review (read only) boolean True if order has been held for fraud review
payment_dts string (dateTime) Date/time that the payment was successfully processed
payment_method string Payment method
Allowed Values
  • Affirm
  • Amazon
  • Amazon SC
  • Cash
  • Check
  • COD
  • Coinbase
  • Credit Card
  • eCheck
  • Money Order
  • PayPal
  • Purchase Order
  • Quote Request
  • Unknown
  • Wire Transfer
payment_method_accounting_code (read only) string Payment method QuickBooks code
payment_method_deposit_to_account (read only) string Payment method QuickBooks deposit account
payment_status (read only) string Payment status
Allowed Values
  • Unprocessed
  • Authorized
  • Capture Failed
  • Processed
  • Declined
  • Voided
  • Refunded
  • Skipped
purchase_order OrderPaymentPurchaseOrder If payment_method=Purchase Order
Purchase order information
rotating_transaction_gateway_code (read only) string Rotating transaction gateway code used to process this order
surcharge (read only) Currency Surcharge amount calculated from surcahrge_transaction_fee and surcharge_transaction_percentage
surcharge_accounting_code (read only) string Surcharge accounting code
surcharge_transaction_fee number Surcharge transaction fee
surcharge_transaction_percentage number Surcharge transaction percentage
test_order boolean True if this is a test order
transactions (read only) array of OrderPaymentTransaction Transactions associated with processing this payment

OrderPaymentCheck

Attributes
Name Data Type Description
check_number string Check number

OrderPaymentCreditCard

Attributes
Name Data Type Description
card_auth_ticket (read only) string Card authorization ticket
card_authorization_amount (read only) number Card authorization amount
card_authorization_dts (read only) string (dateTime) Card authorization date/time
card_authorization_reference_number (read only) string Card authorization reference number
card_expiration_month integer (int32) Card expiration month (1-12)
card_expiration_year integer (int32) Card expiration year (Four digit year)
card_number (read only) string Card number (masked to last 4)
card_number_token string Card number token from hosted fields used to update the cart number
card_number_truncated (read only) boolean True if the card has been truncated
card_type string Card type
Allowed Values
  • AMEX
  • Diners Club
  • Discover
  • JCB
  • MasterCard
  • VISA

OrderPaymentECheck

Attributes
Name Data Type Description
bank_aba_code string(9) Bank routing code
bank_account_name string(50) Bank account name
bank_account_number string(50) Bank account number (masked to last 4)
bank_account_type string(8) Bank account type
Allowed Values
  • Checking
  • Savings
bank_name string(50) Bank name
bank_owner_type string(8) Bank owner type
Allowed Values
  • Personal
  • Business
customer_tax_id string(9) Customer tax id (masked to last 4)
drivers_license_dob string(10) Driver license date of birth
drivers_license_number string(50) Driver license number (masked to last 4)
drivers_license_state string(2) Driver license state

OrderPaymentPurchaseOrder

Attributes
Name Data Type Description
purchase_order_number string Purchase order number

OrderPaymentTransaction

This object is read only.
Attributes
Name Data Type Description
details array of OrderPaymentTransactionDetail Details
successful boolean True if the transaction was successful
transaction_gateway string Transaction gateway
transaction_timestamp string (dateTime) Transaction date/time

OrderPaymentTransactionDetail

This object is read only.
Attributes
Name Data Type Description
name string Name
type string Type
Allowed Values
  • AuthTicket
value string Value

OrderQuote

This object is read only.
Attributes
Name Data Type Description
quote_expiration_dts string (dateTime) Expiration of quote at date/time
quoted_by string Quoted by user
quoted_dts string (dateTime) Quoted on date/time

OrderSalesforce

This object is read only
Attributes
Name Data Type Description
salesforce_opportunity_id string Salesforce.com opportunity id

OrderShipping

Attributes
Name Data Type Description
address1 string(50) Address line 1
address2 string(50) Address line 2
city string(32) City
company string(50) Company
country_code string(2) ISO-3166 two letter country code
day_phone string(25) Day time phone
delivery_date string (dateTime) Date the customer is requesting delivery on. Typically used for perishable product delivery.
evening_phone string(25) Evening phone
first_name string(30) First name
last_name string(30) Last name
lift_gate boolean Lift gate requested (LTL shipping methods only)
postal_code string(20) Postal code
rma string(30) RMA number
ship_on_date string (dateTime) Date the customer is requesting that the order ship on. Typically used for perishable product delivery.
ship_to_residential boolean True if the shipping address is residential. Effects the methods that are available to the customer as well as the price of the shipping method.
shipping_3rd_party_account_number string(20) Shipping 3rd party account number
shipping_date (read only) string (dateTime) Date/time the order shipped on. This date is set once the first shipment is sent to the customer.
shipping_department_status string(30) Shipping department status
shipping_method string Shipping method
shipping_method_accounting_code (read only) string Shipping method accounting code
special_instructions string Special instructions from the customer regarding shipping
state_region string(32) State
title string(50) Title
tracking_numbers array of string Tracking numbers
weight (read only) Weight Total weight of the items on the order

OrderSummary

Attributes
Name Data Type Description
other_refunded (read only) Currency Other refunded
shipping_handling_refunded (read only) Currency Shipping/handling refunded
shipping_handling_total Currency Shipping/handling total
shipping_handling_total_discount (read only) Currency Shipping/handling total discount
subtotal (read only) Currency Subtotal
subtotal_discount (read only) Currency Subtotal discount
subtotal_discount_refunded (read only) Currency Subtotal discount refunded
subtotal_refunded (read only) Currency Subtotal refunded
tax Currency Tax
tax_refunded (read only) Currency Tax refunded
taxable_subtotal (read only) Currency Taxable subtotal
taxable_subtotal_discount (read only) Currency Taxable subtotal discount
total (read only) Currency Total
total_refunded (read only) Currency Total refunded

OrderTaxes

Attributes
Name Data Type Description
tax_city_accounting_code (read only) string QuickBooks tax city code
tax_country_accounting_code (read only) string QuickBooks tax country code
tax_county string(32) County used for tax calculation purposes (only in the United States)
tax_county_accounting_code (read only) string QuickBooks tax county code
tax_postal_code_accounting_code (read only) string QuickBooks tax postal code code
tax_rate number Tax rate
tax_rate_city (read only) number Tax rate at the city level
tax_rate_country (read only) number Tax rate at the country level
tax_rate_county (read only) number Tax rate at the county level
tax_rate_postal_code (read only) number Tax rate at the postal code level
tax_rate_state (read only) number Tax rate at the state level
tax_state_accounting_code (read only) string QuickBOoks tax state code

ResponseMetadata

Attributes
Name Data Type Description
payload_name string Payload name
result_set ResultSet Result set

ResultSet

Attributes
Name Data Type Description
count integer (int32) Number of results in this set
limit integer (int32) Maximum number of results that can be returned in a set
more boolean True if there are more results to query
next_offset integer (int32) The next offset that you should query to retrieve more results
offset integer (int32) Offset of this result set (zero based)
total_records integer (int32) The total number of records in the result set. May be null if the number is not known and the client should continue iterating as long as more is true.

Weight

Attributes
Name Data Type Description
uom string Unit of measure
Allowed Values
  • KG
  • LB
  • OZ
value number Weight

400
Status Code 400: bad request input such as invalid json

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

401
Status Code 401: invalid credentials supplied

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

410
Status Code 410: Your authorized application has been disabled by UltraCart

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

429
Status Code 429: you have exceeded the allowed API call rate limit for your application.

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

500
Status Code 500: any server side error. the body will contain a generic server error message

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse