csharp
java
javascript
php
python
ruby
typescript

order

/order

<?php /* docs.ultracart.com sample */ ?>
<?php
// Did you get an error?
// See this: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/39077885/Troubleshooting+API+Errors
?>

<?php
// for testing and development only
set_time_limit(3000);
ini_set('max_execution_time', 3000);
ini_set('display_errors', 1);
error_reporting(E_ALL);
?>

<?php
// initialization code
require_once './vendor/autoload.php';
$simple_key = '4256aaf6dfedfa01582fe9a961ab0100216d737b874a4801582fe9a961ab0100';
ultracart\v2\Configuration::getDefaultConfiguration()->setApiKey('x-ultracart-simple-key', $simple_key);

$client = new GuzzleHttp\Client(['verify' => false, 'debug' => false]);
$config = ultracart\v2\Configuration::getDefaultConfiguration();
$headerSelector = new \ultracart\v2\HeaderSelector(/* leave null for version tied to this sdk version */);

$order_api = new ultracart\v2\api\OrderApi($client, $config, $headerSelector);
?>

<?php

function die_if_api_error(\ultracart\v2\models\OrderResponse $order_response){
    if ($order_response->getError() != null) {
        echo "Error:<br>";
        echo $order_response->getError()->getDeveloperMessage() . '<br>';
        echo $order_response->getError()->getUserMessage() . '<br>';
        die('handle this error gracefully');
    }
}

?>


<!DOCTYPE html>
<html>
<body>
<?php

$order_expansion = "shipping,billing,item,summary,payment,coupon,taxes"; // see www.ultracart.com/api/ for all the expansion fields available

$order_query = new \ultracart\v2\models\OrderQuery();
$order_query->setEmail('test@test.com');
$orders_response = $order_api->getOrdersByQuery($order_query, 200, 0, null,$order_expansion);
die_if_api_error($order_response);

$orders = $orders_response->getOrders();

// -----------------------------------------------------------------------
// single order
// -----------------------------------------------------------------------
 $order_id = "DEMO-0009103586";
 $order_response = $order_api->getOrder($order_id, $order_expansion);
if ($order_response->getSuccess()) {
    $order = $order_response->getOrder();
}

// update the order here.
// request the same order expansion, or the updated object will not contain the same fields as the original 'get' request
//$order_response = $order_api->updateOrder($order, $order_id, $order_expansion);
//if ($order_response->getError() != null) {
//    $order_response->getError()->getDeveloperMessage();
//    $order_response->getError()->getUserMessage();
//}


// here is how to access the shipping fields
foreach ($orders as $order) {

    $s_addr = $order->getShipping();
    $s_addr->getAddress1();
    $s_addr->getAddress2();
    $s_addr->getCity();
    $s_addr->getStateRegion();
    $s_addr->getCountryCode();
    $s_addr->getPostalCode();


    $b_addr = $order->getBilling();
    $b_addr->getAddress1();
    $b_addr->getAddress2();
    $b_addr->getCity();
    $b_addr->getStateRegion();
    $b_addr->getCountryCode();
    $b_addr->getPostalCode();
    $b_addr->getEmail(); // email is located on the billing object.

// here is how to access the items
    $items = $order->getItems();
    foreach ($items as $item) {
        $qty = $item->getQuantity();
        $itemId = $item->getMerchantItemId();
        $description = $item->getDescription();
        $cost = $item->getCost();
        $cost->getLocalized(); // cost as float.
        $cost->getLocalizedFormatted(); // cost with symbols.
    }
}

?>
<pre>
    <h1>Order</h1>
    <?php echo print_r($orders); ?>
</pre>
<?php echo 'Finished.'; ?>
</body>
</html>

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.

Expansion

By default, when you read an order, a limited object is returned. If you specify the _expand parameter, additional properties of the order object are returned. We encourage you to limit the amount of information that you query for orders, to the minimal amount possible to have optimal communication. The following expansion operations are available.

Retrieve A/R Retry Configuration

Permissions:
  • order_read

Produces: application/json
get
/order/accountsReceivableRetryConfig

Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.

Responses
Status Code Reason Response Model
200
 Successful response AccountsReceivableRetryConfigResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update A/R Retry Configuration

Permissions:
  • order_write

Produces: application/json
post
/order/accountsReceivableRetryConfig

Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.

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

Retrieve A/R Retry Statistics

Permissions:
  • order_read

Produces: application/json
get
/order/accountsReceivableRetryConfig/stats

Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.

Parameters
Parameter Description Location Data Type Required
from ${parameter.description} query string optional
to ${parameter.description} query string optional
Responses
Status Code Reason Response Model
200
 Successful response AccountsReceivableRetryStatsResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Retrieve orders

Permissions:
  • order_read

Produces: application/json
get
/order/orders

Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters
Parameter Description Location Data Type Required
order_id Order Id query string optional
payment_method Payment Method
Allowed Values
  • Affirm
  • Amazon
  • Amazon SC
  • Cash
  • Check
  • COD
  • Credit Card
  • eCheck
  • LoanHero
  • Money Order
  • PayPal
  • Purchase Order
  • Quote Request
  • Unknown
  • Wire Transfer
 query string optional
company Company query string optional
first_name First Name query string optional
last_name Last Name query string optional
city City query string optional
state_region State/Region query string optional
postal_code Postal Code query string optional
country_code Country Code (ISO-3166 two letter) query string optional
phone Phone query string optional
email Email query string optional
cc_email CC Email query string optional
total Total query number optional
screen_branding_theme_code Screen Branding Theme Code query string optional
storefront_host_name StoreFront Host Name query string optional
creation_date_begin Creation Date Begin query string (dateTime) optional
creation_date_end Creation Date End query string (dateTime) optional
payment_date_begin Payment Date Begin query string (dateTime) optional
payment_date_end Payment Date End query string (dateTime) optional
shipment_date_begin Shipment Date Begin query string (dateTime) optional
shipment_date_end Shipment Date End query string (dateTime) optional
rma RMA query string optional
purchase_order_number Purchase Order Number query string optional
item_id Item Id query string optional
current_stage Current Stage
Allowed Values
  • Accounts Receivable
  • Pending Clearance
  • Fraud Review
  • Rejected
  • Shipping Department
  • Completed Order
  • Quote Request
  • Quote Sent
  • Least Cost Routing
 query string optional
channel_partner_code Channel Partner Code query string optional
channel_partner_order_id Channel Partner Order ID query string optional
customer_profile_oid ${parameter.description} query integer (int32) optional
Refund Date Begin ${parameter.description} query string optional
Refund Date End ${parameter.description} query string optional
_limit The maximum number of records to return on this one API call. (Maximum 200)
Default: 100 		query integer optional
_offset Pagination of the record set. Offset is a zero based index.
Default: 0 		query integer optional
_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
Allowed Values
  • order_id
  • shipping.company
  • shipping.first_name
  • shipping.last_name
  • shipping.city
  • shipping.state_region
  • shipping.postal_code
  • shipping.country_code
  • billing.phone
  • billing.email
  • billing.cc_email
  • billing.company
  • billing.first_name
  • billing.last_name
  • billing.city
  • billing.state
  • billing.postal_code
  • billing.country_code
  • creation_dts
  • payment.payment_dts
  • checkout.screen_branding_theme_code
  • channel_partner.channel_partner_code
  • channel_partner.channel_partner_order_id
 query string optional
_expand The object expansion to perform on the result. query string optional
Responses
Status Code Reason Response Model
200
 Successful response OrdersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Insert an order

Permissions:
  • order_write

Consumes: application/json
Produces: application/json
post
/order/orders

Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.

Parameters
Parameter Description Location Data Type Required
order Order to insert body Order 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 OrderResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Retrieve order batch

Permissions:
  • order_read

Produces: application/json
post
/order/orders/batch

Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.

Parameters
Parameter Description Location Data Type Required
order_batch Order batch body OrderQueryBatch required
_expand The object expansion to perform on the result. query string optional
Responses
Status Code Reason Response Model
200
 Successful response OrdersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Retrieve orders

Permissions:
  • order_read

Produces: application/json
post
/order/orders/query

Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters
Parameter Description Location Data Type Required
order_query Order query body OrderQuery required
_limit The maximum number of records to return on this one API call. (Maximum 200)
Default: 100 		query integer optional
_offset Pagination of the record set. Offset is a zero based index.
Default: 0 		query integer optional
_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
Allowed Values
  • order_id
  • shipping.company
  • shipping.first_name
  • shipping.last_name
  • shipping.city
  • shipping.state_region
  • shipping.postal_code
  • shipping.country_code
  • billing.phone
  • billing.email
  • billing.cc_email
  • billing.company
  • billing.first_name
  • billing.last_name
  • billing.city
  • billing.state
  • billing.postal_code
  • billing.country_code
  • creation_dts
  • payment.payment_dts
  • checkout.screen_branding_theme_code
  • channel_partner.channel_partner_code
  • channel_partner.channel_partner_order_id
 query string optional
_expand The object expansion to perform on the result. query string optional
Responses
Status Code Reason Response Model
200
 Successful response OrdersResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Retrieve an order using a token

Permissions:
  • order_read

Produces: application/json
post
/order/orders/token

Retrieves a single order using the specified order token.

Parameters
Parameter Description Location Data Type Required
order_by_token_query Order by token query body OrderByTokenQuery 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 OrderResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Delete an order

Permissions:
  • order_write

Produces: application/json
delete
/order/orders/{order_id}

Delete an order on the UltraCart account.

Parameters
Parameter Description Location Data Type Required
order_id The order id to delete. path string required
Responses
Status Code Reason Response Model
204
 No Content
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Retrieve an order

Permissions:
  • order_read

Produces: application/json
get
/order/orders/{order_id}

Retrieves a single order using the specified order id.

Parameters
Parameter Description Location Data Type Required
order_id The order 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 OrderResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Update an order

Permissions:
  • order_write

Consumes: application/json
Produces: application/json
put
/order/orders/{order_id}

Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.

Parameters
Parameter Description Location Data Type Required
order Order to update body Order required
order_id The order id to update. 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 OrderResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Cancel an order

Permissions:
  • order_write

Produces: application/json
post
/order/orders/{order_id}/cancel

Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.

Parameters
Parameter Description Location Data Type Required
order_id The order id to cancel. path string required
Responses
Status Code Reason Response Model
200
 Successful response BaseResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Format order

Permissions:
  • order_read

Produces: application/json
post
/order/orders/{order_id}/format

Format the order for display at text or html

Parameters
Parameter Description Location Data Type Required
order_id The order id to format path string required
format_options Format options body OrderFormat required
Responses
Status Code Reason Response Model
200
 Successful response OrderFormatResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Refund an order

Permissions:
  • order_write

Consumes: application/json
Produces: application/json
put
/order/orders/{order_id}/refund

Perform a refund operation on an order and then update the order if successful

Parameters
Parameter Description Location Data Type Required
order Order to refund body Order required
order_id The order id to refund. path string required
reject_after_refund Reject order after refund
Default: false 		query boolean optional
skip_customer_notification Skip customer email notification
Default: false 		query boolean optional
auto_order_cancel Cancel associated auto orders
Default: false 		query boolean optional
manual_refund Consider a manual refund done externally
Default: false 		query boolean optional
reverse_affiliate_transactions Reverse affiliate transactions
Default: true 		query boolean 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 OrderResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Replacement order

Permissions:
  • order_write

Produces: application/json
post
/order/orders/{order_id}/replacement

Create a replacement order based upon a previous order

Parameters
Parameter Description Location Data Type Required
order_id The order id to generate a replacement for. path string required
replacement Replacement order details body OrderReplacement required
Responses
Status Code Reason Response Model
200
 Successful response OrderReplacementResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Resend receipt

Permissions:
  • order_write

Produces: application/json
post
/order/orders/{order_id}/resend_receipt

Resend the receipt for an order on the UltraCart account.

Parameters
Parameter Description Location Data Type Required
order_id The order id to resend the receipt for. path string required
Responses
Status Code Reason Response Model
200
 Successful response BaseResponse
400
 Bad Request 400
401
 Unauthorized 401
410
 Authorized Application Disabled 410
429
 Too Many Requests 429
500
 Server Side 500

Resend shipment confirmation

Permissions:
  • order_write

Produces: application/json
post
/order/orders/{order_id}/resend_shipment_confirmation

Resend shipment confirmation for an order on the UltraCart account.

Parameters
Parameter Description Location Data Type Required
order_id The order id to resend the shipment notification for. path string required
Responses
Status Code Reason Response Model
200
 Successful response BaseResponse
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
order_create Fired when an order is placed. Order Yes
order_update Fired when an order is updated. Order Yes
order_delete Fired when an order is deleted. Order Yes
order_stage_change Fired when an order stage changes. Order Yes
order_payment_process Fired when a payment is processed. Order Yes
order_ship Fired when an order is shipped. Order Yes
order_reject Fired when an order is rejected. Order Yes
order_refund Fired when an order is refunded. Order Yes
order_s3_invoice Fired when an order has a PDF invoice archived to S3. Order Yes

AccountsReceivableRetryConfig

Attributes
Name Data Type Description
active boolean True if the retry should run daily. False puts the retry service into an inactive state for this merchant.
allow_process_linked_accounts boolean True if this account has linked accounts that it can process.
current_service_plan (read only) string The current service plan that the account is on.
daily_activity_list array of AccountsReceivableRetryDayActivity A list of days and what actions should take place on those days after an order reaches accounts receivable
managed_by_linked_account_merchant_id (read only) boolean If not null, this account is managed by the specified parent merchant id.
merchant_id string UltraCart merchant ID
notify_emails array of string A list of email addresses to receive summary notifications from the retry service.
notify_rejections boolean If true, email addresses are notified of rejections.
notify_successes boolean If true, email addresses are notified of successful charges.
process_linked_accounts boolean If true, all linked accounts are also processed using the same rules.
processing_percentage (read only) string The percentage rate charged for the service.
reject_at_end boolean If true, the order is rejected the day after the last configured activity day
trial_mode boolean True if the account is currently in trial mode. Set to false to exit trial mode.
trial_mode_expiration_dts (read only) string (dateTime) The date when trial mode expires. If this date is reached without exiting trial mode, the service will de-activate.

AccountsReceivableRetryConfigResponse

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

AccountsReceivableRetryDayActivity

Attributes
Name Data Type Description
charge boolean True if a charge attempt should be made on this day. False means the order should be rejected on this day.
coupon_code string The coupon code that should be applied to this order.
day integer (int32) The number of days since the order placed in Accounts Receivable

AccountsReceivableRetryStatAccount

Attributes
Name Data Type Description
days array of AccountsReceivableRetryStatMetrics
merchant_id string
overall AccountsReceivableRetryStatMetrics
revenue_for_period array of AccountsReceivableRetryStatRevenue

AccountsReceivableRetryStatMetrics

Attributes
Name Data Type Description
attempts integer (int32)
attempts_formatted string
conversion_rate number
conversion_rate_formatted string
day integer (int32)
discounts number
discounts_formatted string
revenue number
revenue_formatted string
successes integer (int32)
successes_formatted string

AccountsReceivableRetryStatRevenue

Attributes
Name Data Type Description
label string
revenue number

AccountsReceivableRetryStatsResponse

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

Activity

Attributes
Name Data Type Description
action string
metric string
subject string
ts integer (int64)
type string
uuid string

BaseResponse

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

Currency

Attributes
Name Data Type Description
currency_code string Currency code of the localized value
exchange_rate number Exchange rate used to localize
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
activity CustomerActivity activity by this customer
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
attachments array of CustomerAttachment Attachments
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
cc_emails array of CustomerEmail Additional emails to CC notification
customer_profile_oid (read only) integer (int32) Customer profile object identifier
dhl_account_number string(20) DHL account number
dhl_duty_account_number string(20) DHL duty 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 (dateTime) Last modified date
loyalty CustomerLoyalty Loyalty
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
orders array of Order Orders associated with this customer profile
orders_summary CustomerOrdersSummary Summary of orders placed by this customer profile
password string(30) Password (may only be set, never read)
pricing_tiers array of CustomerPricingTier Pricing tiers for this customer
privacy CustomerPrivacy Privacy settings of the customer profile
qb_class string QuickBooks class to import this customer as
qb_code string QuickBooks name to import this customer as
quotes array of Order Quotes associated with this customer profile
quotes_summary CustomerQuotesSummary Summary of the quotes submitted by this customer profile
referral_source string(50) Referral Source
reviewer CustomerReviewer Item reviewer information
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
software_entitlements array of CustomerSoftwareEntitlement Software entitlements owned by this customer
suppress_buysafe boolean Suppress buySAFE
tags array of CustomerTag Tags for this customer
tax_codes CustomerTaxCodes Tax codes used by tax integrations
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

CustomerActivity

Attributes
Name Data Type Description
activities array of Activity
memberships array of ListSegmentMembership
metrics array of Metric
properties_list array of Property

CustomerAttachment

Attributes
Name Data Type Description
customer_profile_attachment_oid (read only) integer (int32) Attachment identifier
description string Description
file_name (read only) string File name
mime_type (read only) string Mime typoe
upload_dts (read only) string (dateTime) Upload date/time

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 (dateTime) 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
last_used_dts string (dateTime) Last used date

CustomerEmail

Attributes
Name Data Type Description
customer_profile_email_oid integer (int32) ID of the email
email string(100) Email
label string(100) Label
receipt_notification boolean CC this email on receipt notifications
refund_notification boolean CC this email on refund notifications
shipment_notification boolean CC this email on shipment notifications

CustomerLoyalty

Attributes
Name Data Type Description
current_points (read only) integer (int32) Current Points
ledger_entries (read only) array of CustomerLoyaltyLedger Ledger entries
redemptions (read only) array of CustomerLoyaltyRedemption Redemptions

CustomerLoyaltyLedger

Attributes
Name Data Type Description
created_by (read only) string Created By
created_dts (read only) string (dateTime) Created date
description (read only) string Description
email (read only) string Email
item_id (read only) string Item Id
item_index (read only) integer (int32) Item Index
ledger_dts (read only) string (dateTime) Ledger date
loyalty_campaign_oid (read only) integer (int32) Loyalty campaign oid
loyalty_ledger_oid (read only) integer (int32) Loyalty ledger oid
loyalty_points (read only) integer (int32) Loyalty points
modified_by (read only) string Modified By
modified_dts (read only) string (dateTime) Modified date
order_id (read only) string Order Id
quantity (read only) integer (int32) Quantity
vesting_dts (read only) string (dateTime) Vesting date

CustomerLoyaltyRedemption

Attributes
Name Data Type Description
coupon_code (read only) string Coupon code
coupon_code_oid (read only) integer (int32) Coupon code OID
coupon_used (read only) boolean Coupon used
description_for_customer (read only) string Description for customer
expiration_dts (read only) string (dateTime) Expiration date
gift_certificate_code (read only) string Gift certificate code
gift_certificate_oid (read only) integer (int32) Gift certificate oid
loyalty_ledger_oid (read only) integer (int32) Loyalty ledger OID
loyalty_points (read only) integer (int32) Loyalty points
loyalty_redemption_oid (read only) integer (int32) Loyalty redemption OID
order_id (read only) string Order id
redemption_dts (read only) string (dateTime) Redemption date
remaining_balance (read only) number Remaining balance

CustomerOrdersSummary

Attributes
Name Data Type Description
first_order_dts (read only) string (dateTime) First order date
last_order_dts (read only) string (dateTime) Last order date
order_count integer (int32) Total number of orders
total number Total amount associated with the orders

CustomerPricingTier

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

CustomerPrivacy

Attributes
Name Data Type Description
last_update_dts (read only) string (dateTime) Last update date
marketing (read only) boolean The customer has opted in to marketing
preference (read only) boolean The customer has opted in to preference tracking
statistics (read only) boolean The customer has opted in to statistics collection

CustomerQuotesSummary

Attributes
Name Data Type Description
first_quote_dts (read only) string (dateTime) First quote date
last_quote_dts (read only) string (dateTime) Last quote date
quote_count integer (int32) Total number of quote
total number Total amount associated with the quotes

CustomerReviewer

Attributes
Name Data Type Description
auto_approve boolean True if reviewes from this customer profile should automatically be approved
average_overall_rating (read only) number Average overall rating of items reviewed
expert boolean True if the customer is an expert
first_review (read only) string (dateTime) First review
last_review (read only) string (dateTime) Last review
location string Location of the reviewer
nickname string Nickname of the reviewer
number_helpful_review_votes (read only) integer (int32) Number of helpful review votes
rank (read only) integer (int32) Rank of this reviewer
reviews_contributed (read only) integer (int32) Number of reviews contributed

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 (dateTime) 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

CustomerSoftwareEntitlement

Attributes
Name Data Type Description
activation_code string(50) Activation Code Associated with the software
activation_dts string (dateTime) Date/time when the activation code was created
customer_software_entitlement_oid (read only) integer (int32) Customer profile software entitlement object identifier
expiration_dts string (dateTime) Date/time when the activation code will expire
purchased_via_item_description (read only) string(512) Item description used to purchase this software.
purchased_via_item_id (read only) string(20) Item ID used to purchase this software.
purchased_via_order_id (read only) string(30) Order ID used to purchase this software.
software_sku string(30) SKU of the software

CustomerTag

Attributes
Name Data Type Description
tag_value string(100) Tag Value

CustomerTaxCodes

Attributes
Name Data Type Description
avalara_customer_code string Avalara customer code
avalara_entity_use_code string Avalara entity use code
taxjar_customer_id string TaxJar customer id

Distance

Attributes
Name Data Type Description
uom string 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

ListSegmentMembership

Attributes
Name Data Type Description
name string
type string
uuid string

Metric

Attributes
Name Data Type Description
all_time number
all_time_formatted string
last_30 number
last_30_formatted string
name string
prior_30 number
prior_30_formatted string
type string

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
  • MYR
  • 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
  • Unknown
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
properties array of OrderProperty Properties, available only through update, not through insert due to the nature of how properties are handled internally
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
Tags array of OrderTag tags, available only through update, not through insert due to the nature of how tags are handled internally
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 code assigned to the auto order
auto_order_oid integer (int32) 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
day_phone_e164 (read only) string(25) Day time phone (E164 format)
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

OrderByTokenQuery

Attributes
Name Data Type Description
order_token string Order Token

OrderChannelPartner

This object is read-only except for inserts.
Attributes
Name Data Type Description
auto_approve_purchase_order boolean If true, any purchase order submitted is automatically approved
channel_partner_code string The code of the channel partner
channel_partner_data string Additional data provided by the channel partner, read-only
channel_partner_oid integer (int32) Channel partner object identifier, read-only and available on existing channel orders only.
channel_partner_order_id string The order ID assigned by the channel partner for this order
no_realtime_payment_processing boolean Indicates this order should be placed in Account Receivable for later payment processing
skip_payment_processing boolean Indicates this order was already paid for via a channel purchase and no payment collection should be attempted
store_completed boolean Instructs UltraCart to skip shipping department and mark this order as fully complete. Set this flag if you have already shipped product for this order.
store_if_payment_declines boolean If true, any failed payment will place the order in Accounts Receivable rather than rejecting it.
treat_warnings_as_errors boolean Any warnings are raised as errors and halt the import of the 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
automatically_applied (read only) boolean Whether or not the coupon was automatically applied to the order
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

OrderFormat

Attributes
Name Data Type Description
context string The context to generate the order view for.
Allowed Values
  • unknown
  • receipt
  • shipment
  • refund
  • quote-request
  • quote
dont_link_email_to_search boolean True to not link the email address to the order search
email_as_link boolean True to make the email address a clickable mailto link
filter_distribution_center_oid integer (int32) Specify a distribution center oid to filter the items displayed to that particular distribution center.
filter_to_items_in_contact_oid integer (int32) The container oid to filter items to.
format string The desired format.
Allowed Values
  • text
  • div
  • table
  • email
hide_bill_to_address boolean True to ide the bill to address
hide_price_information boolean True to hide price information
link_file_attachments boolean True to link file attachments for download
show_contact_info boolean True to show contact information
show_in_merchant_currency boolean True to show the order in the merchant currency
show_internal_information boolean True to show internal information about the order
show_merchant_notes boolean True to show merchant notes
show_non_sensitive_payment_info boolean True to show non-sensitive payment information
show_payment_info boolean True to show payment information
translate boolean True to translate the order into the native language of the customer

OrderFormatResponse

Attributes
Name Data Type Description
css_links array of string The URLs to any stylesheets that need to be included to properly view the markup.
formatted_result string The formatted result of the order. This will be HTML or text depending upon the requested format.

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
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 Currency Amount refunded of the gift charge (read only except refund operation)
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 Currency Amount refunded of the gift wrap (read only except refund operation)
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
arbitrary_unit_cost Currency Arbitrary unit cost, used only during inserts for overriding the unit cost of an item
auto_order_last_rebill_dts string (dateTime) Date/time of the last rebill, used only during order insert to help project future rebills
auto_order_schedule string Auto order schedule, used only during inserts supplying the recurring schedule
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
properties array of OrderItemProperty Properties
quantity number Quantity
quantity_refunded number Quantity refunded on this item (read only except refund operation)
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
tags array of OrderItemTag Tags
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 Currency Total refunded on this item (read only except refund operation)
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

OrderItemProperty

Attributes
Name Data Type Description
display boolean True if this property is displayed to the customer
expiration_dts string (dateTime) The date/time that the property expires and is deleted
name string(100) Name
value string(3800) Value

OrderItemTag

Attributes
Name Data Type Description
tag_value string(100) Tag Value

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, for new orders, this field is only considered if channel_partner.skip_payment_processing is true
payment_method string Payment method
Allowed Values
  • Affirm
  • Amazon
  • Amazon SC
  • Cash
  • Check
  • COD
  • Credit Card
  • eBay
  • eCheck
  • LoanHero
  • Money Order
  • PayPal
  • Purchase Order
  • Quote Request
  • Unknown
  • Wire Transfer
  • Walmart
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 (read only) 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
card_verification_number_token string Card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries

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 Bank account type
Allowed Values
  • Checking
  • Savings
bank_name string(50) Bank name
bank_owner_type string 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
value string Value

OrderProperty

Attributes
Name Data Type Description
display boolean True if this property is displayed to the customer
expiration_dts string (dateTime) The date/time that the property expires and is deleted
name string(100) Name
value string(3800) Value

OrderQuery

Attributes
Name Data Type Description
cc_email string(100) CC Email
channel_partner_code string The code of the channel partner
channel_partner_order_id string The order ID assigned by the channel partner for this order
city string(32) City
company string(50) Company
country_code string(2) ISO-3166 two letter country code
creation_date_begin string (dateTime) Date/time that the order was created
creation_date_end string (dateTime) Date/time that the order was created
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
  • Unknown
customer_profile_oid integer (int32) The customer profile to find associated orders for
email string(100) Email
first_name string(30) First name
item_id string Item ID
last_name string(30) Last name
order_id string Order ID
payment_date_begin string (dateTime) Date/time that the order was successfully processed
payment_date_end string (dateTime) Date/time that the order was successfully processed
payment_method string Payment method
Allowed Values
  • Affirm
  • Amazon
  • Amazon SC
  • Cash
  • Check
  • COD
  • Credit Card
  • eCheck
  • LoanHero
  • Money Order
  • PayPal
  • Purchase Order
  • Quote Request
  • Unknown
  • Wire Transfer
phone string(25) Phone
postal_code string(20) Postal code
purchase_order_number string Purchase order number
refund_date_begin string (dateTime) Date/time that the order was refunded
refund_date_end string (dateTime) Date/time that the order was refunded
rma string(30) RMA number
screen_branding_theme_code string(10) Screen branding theme code associated with the order (legacy checkout)
shipment_date_begin string (dateTime) Date/time that the order was shipping
shipment_date_end string (dateTime) Date/time that the order was shipped
state_region string(32) State for United States otherwise region or province for other countries
storefront_host_name string StoreFront host name associated with the order
total number Total

OrderQueryBatch

Attributes
Name Data Type Description
order_ids array of string Order IDs

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

OrderReplacement

Attributes
Name Data Type Description
additional_merchant_notes_new_order string Additional merchant notes to append to the new order
additional_merchant_notes_original_order string Additional merchant notes to append to the original order
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
free boolean Set to true if this replacement shipment should be free for the customer.
immediate_charge boolean Set to true if you want to immediately charge the payment on this order, otherwise it will go to Accounts Receivable.
items array of OrderReplacementItem Items to include in the replacement order
original_order_id string Original order id
shipping_method string Shipping method to use. If not specified or invalid then least cost shipping will take place.
skip_payment boolean Set to true if you want to skip the payment as if it was successful.

OrderReplacementItem

Attributes
Name Data Type Description
arbitrary_unit_cost number Cost to charge the customer if specified. If not specified then the default item cost is used.
merchant_item_id string(20) Item ID
quantity number Quantity

OrderReplacementResponse

Attributes
Name Data Type Description
chargeSuccessful boolean
errorMessage string
feedback string
free boolean
orderId string
successful boolean

OrderResponse

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

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
day_phone_e164 (read only) string(25) Day time phone (E164 format)
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
least_cost_route boolean If true, instructs UltraCart to apply the cheapest shipping method to this order. Used only for channel partner order inserts.
least_cost_route_shipping_methods array of string List of shipping methods to consider if least_code_route is true. Used only for channel parter order inserts.
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

OrdersResponse

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

OrderSummary

Attributes
Name Data Type Description
arbitrary_shipping_handling_total Currency Arbitrary shipping handling total, this is meaningless for updating an order. For inserting a new order, this will override any internal shipping and handlig totals and should only be used for orders completed outside the system. This will probably only ever be needed when submitting arbitrary taxes AND shipping is taxed.
other_refunded (read only) Currency Other refunded
shipping_handling_refunded Currency Shipping/handling refunded (read only except refund operation)
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 Currency Subtotal discount refunded (read only except refund operation)
subtotal_refunded (read only) Currency Subtotal refunded
tax Currency Tax, may be updated to reflect any changes made to the tax fields, but cannot be used when inserting an order. For inserting, use the arbitrary fields instead.
tax_refunded Currency Tax refunded (read only except refund operation)
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

OrderTag

Attributes
Name Data Type Description
tag_value string(100) Tag Value

OrderTaxes

Attributes
Name Data Type Description
arbitrary_tax number Arbitrary Tax, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.
arbitrary_tax_rate number Arbitrary tax rate, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.
arbitrary_taxable_subtotal number Arbitrary taxable subtotal, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.
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_gift_charge (read only) boolean True if gift charge is taxed
tax_postal_code_accounting_code (read only) string QuickBooks tax postal code code
tax_rate number Tax rate, this is meaningless for updating an order. For inserting a new order, if you need to override internal tax calculations, use the arbitrary fields.
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_shipping (read only) boolean True if shipping is taxed
tax_state_accounting_code (read only) string QuickBooks tax state code

Property

Attributes
Name Data Type Description
name string
value string

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