customer
/customer
/customer
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class Introduction
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void IntroductionCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;
public class Introduction {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
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.
There are four steps to instantiating the API.
The customer REST API has the capability to expand everything related to the customer including
the original and rebill order records. By default, when you read an customer, a
limited object is returned. If you specify the _expand parameter, additional properties of the customer
object are returned. We encourage you to limit the amount of information that you query for customers
to the minimal amount possible to have optimal communication. The following expansion operations are
available.
Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
SDK Function Name: getCustomers
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| query | string | optional | ||
| qb_class | Quickbooks class | query | string | optional |
| quickbooks_code | Quickbooks code | query | string | optional |
| last_modified_dts_start | Last modified date start | query | string | optional |
| last_modified_dts_end | Last modified date end | query | string | optional |
| signup_dts_start | Signup date start | query | string | optional |
| signup_dts_end | Signup date end | query | string | optional |
| billing_first_name | Billing first name | query | string | optional |
| billing_last_name | Billing last name | query | string | optional |
| billing_company | Billing company | query | string | optional |
| billing_city | Billing city | query | string | optional |
| billing_state | Billing state | query | string | optional |
| billing_postal_code | Billing postal code | query | string | optional |
| billing_country_code | Billing country code | query | string | optional |
| billing_day_phone | Billing day phone | query | string | optional |
| billing_evening_phone | Billing evening phone | query | string | optional |
| shipping_first_name | Shipping first name | query | string | optional |
| shipping_last_name | Shipping last name | query | string | optional |
| shipping_company | Shipping company | query | string | optional |
| shipping_city | Shipping city | query | string | optional |
| shipping_state | Shipping state | query | string | optional |
| shipping_postal_code | Shipping postal code | query | string | optional |
| shipping_country_code | Shipping country code | query | string | optional |
| shipping_day_phone | Shipping day phone | query | string | optional |
| shipping_evening_phone | Shipping evening phone | query | string | optional |
| pricing_tier_oid | Pricing tier oid | query | integer (int32) | optional |
| pricing_tier_name | Pricing tier name | query | string | optional |
| _limit | The maximum number of records to return on this one API call. (Max 200)
Default: 100 |
query | integer | optional |
| _offset | Pagination of the record set. Offset is a zero based index.
Default: 0 |
query | integer | optional |
| _since | Fetch customers that have been created/modified since this date/time. | query | dateTime | optional |
| _sort | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
Allowed Values
|
query | string | optional |
| _expand | The object expansion to perform on the result. See documentation for examples | query | string | optional |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class GetCustomers
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void GetCustomersCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;
public class GetCustomers {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
Insert a customer on the UltraCart account.
SDK Function Name: insertCustomer
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer | Customer to insert | body | Customer | required |
| _expand | The object expansion to perform on the result. See documentation for examples | query | string | optional |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class InsertCustomer
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void InsertCustomerCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;
public class InsertCustomer {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
# frozen_string_literal: true
require 'json'
require 'ultracart_api'
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
customer_api = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
customer = UltracartClient::Customer.new
customer.email = "joe-#{rand}@aol.com"
customer.password = "pw#{rand}"
shipping = UltracartClient::CustomerShipping.new
shipping.first_name = 'Joe'
shipping.last_name = 'Smith'
shipping.address1 = '206 Washington St SW'
shipping.city = 'Atlanta'
shipping.state_region = 'GA'
shipping.postal_code = '30334'
customer.shipping = [shipping] # notice this is an array of one shipping address (for now)
billing = UltracartClient::CustomerBilling.new
billing.first_name = 'Joe'
billing.last_name = 'Smith'
billing.company = 'Joe Inc.'
billing.day_phone = '4046561776'
billing.address1 = '206 Washington St SW'
billing.city = 'Atlanta'
billing.state_region = 'GA'
billing.postal_code = '30334'
customer.billing = [billing] # notice this is an array of one shipping address (for now)
# by default, UltraCart returns a minimal object. If we want to see all the information we submitted, we need to
# ask for it back. If we're only doing an insert and we don't care, _expand may be left empty.
# Possible expansion components:
# shipping
# billing
# cards
# pricing_tiers
# cc_emails
# orders_summary
# quotes_summary
# tax_codes
# privacy
# reviewer
# attachments
# software_entitlements
# tags
# loyalty
opts = {_expand: 'shipping,billing'}
begin
customer_response = customer_api.insert_customer(customer, opts)
puts customer_response.to_json
rescue UltracartClient::ApiError => ex
puts "Error inserting customer: #{ex.json}"
# Ruby does not give detailed error information. Check the server logs.
# Login to secure.ultracart.com, navigate to Home->Configuration->Development->API Keys
# click the "log" button for your API key.
end
Retrieves a single customer using the specified customer email address.
SDK Function Name: getCustomerByEmail
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| The email address of the customer to retrieve. | path | string | required | |
| _expand | The object expansion to perform on the result. See documentation for examples | query | string | optional |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class GetCustomerByEmail
{
[Test]
public void ExecuteTest()
{
string email = "test@test.com";
Customer customer = GetCustomerByEmailCall(email);
Console.WriteLine(customer.ToString());
}
public static Customer GetCustomerByEmailCall(string Email)
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
string expand = null; // I'm only checking for existence, I don't need the expanded Customer object.
var response = api.GetCustomerByEmail(Email, expand);
return response.Success == true ? response.Customer : null;
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.util.ApiException;
public class GetCustomerByEmail {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
# frozen_string_literal: true
require 'json'
require 'ultracart_api'
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
customer_api = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
email = 'test@test.com'
opts = {}
customer_response = customer_api.get_customer_by_email(email, opts)
puts customer_response.to_json
Retrieves customers from the account. If no searches are specified, all customers will be returned.
SDK Function Name: getCustomersForDataTables
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| _expand | The object expansion to perform on the result. See documentation for examples | query | string | optional |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class GetCustomersForDataTables
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void GetCustomersForDataTablesCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;
public class GetCustomersForDataTables {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
Create a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
SDK Function Name: getEmailVerificationToken
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| token_request | Token request | body | EmailVerifyTokenRequest | required |
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.util.ApiException;
public class GetEmailVerificationToken {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
Validate a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
SDK Function Name: validateEmailVerificationToken
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| validation_request | Token validation request | body | EmailVerifyTokenValidateRequest | required |
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.util.ApiException;
public class ValidateEmailVerificationToken {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
SDK Function Name: getCustomersByQuery
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer_query | Customer query | body | CustomerQuery | required |
| _limit | The maximum number of records to return on this one API call. (Max 200)
Default: 100 |
query | integer | optional |
| _offset | Pagination of the record set. Offset is a zero based index.
Default: 0 |
query | integer | optional |
| _since | Fetch customers that have been created/modified since this date/time. | query | dateTime | optional |
| _sort | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
Allowed Values
|
query | string | optional |
| _expand | The object expansion to perform on the result. See documentation for examples | query | string | optional |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class GetCustomersByQuery
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void GetCustomersByQueryCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;
public class GetCustomersByQuery {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
Delete a customer on the UltraCart account.
SDK Function Name: deleteCustomer
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer_profile_oid | The customer_profile_oid to delete. | path | integer (int32) | required |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class DeleteCustomer
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void DeleteCustomerCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;
public class DeleteCustomer {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
Retrieves a single customer using the specified customer profile oid.
SDK Function Name: getCustomer
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer_profile_oid | The customer oid to retrieve. | path | integer (int32) | required |
| _expand | The object expansion to perform on the result. See documentation for examples | query | string | optional |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class GetCustomer
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void GetCustomerCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.util.ApiException;
public class GetCustomer {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
<?php
/** @noinspection SpellCheckingInspection */
/** @noinspection GrazieInspection */
use ultracart\v2\ApiException;
require_once '../vendor/autoload.php';
require_once '../samples.php';
require_once './item_functions.php'; // <-- see this file for details
// Of the two getItem methods, you'll probably always use getItemByMerchantItemId instead of this one.
// Most item work is done with the item id, not the item oid. The latter is only meaningful as a primary
// key in the UltraCart databases. But here is an example of using getItem(). We take the long route here
// of retrieving the item using getItemByMerchantItemId to obtain the oid rather than hard-coding it. We do this
// because these samples are used in our quality control system and run repeatedly.
try {
$item_id = insertSampleItem();
$item_api = Samples::getItemApi();
$customer_api = Samples::getCustomerApi(); // only needed for accessing reviewer information below.
// the _expand variable is null in the following call. we just need the base object this time.
$api_response = $item_api->getItemByMerchantItemId($item_id, null, false);
$item = $api_response->getItem(); // assuming this succeeded
$merchant_item_oid = $item->getMerchantItemOid();
// This is the actual call for this script.
// The real devil in the getItem calls is the expansion, making sure you return everything you need without
// returning everything since these objects are extremely large.
// These are the possible expansion values.
/*
accounting
amember
auto_order
auto_order.steps
ccbill
channel_partner_mappings
chargeback
checkout
content
content.assignments
content.attributes
content.multimedia
content.multimedia.thumbnails
digital_delivery
ebay
email_notifications
enrollment123
gift_certificate
google_product_search
kit_definition
identifiers
instant_payment_notifications
internal
options
payment_processing
physical
pricing
pricing.tiers
realtime_pricing
related
reporting
restriction
reviews
reviews.individual_reviews
salesforce
shipping
shipping.cases
shipping.destination_markups
shipping.destination_restrictions
shipping.distribution_centers
shipping.methods
shipping.package_requirements
tax
third_party_email_marketing
variations
wishlist_member
*/
// $expand = "kit_definition,options,shipping,tax,variations"; // just some random ones. contact us if you're unsure
$expand = "reviews,reviews.individual_reviews"; // changed the random above to reviews to illustrate accessing product reviews.
$api_response = $item_api->getItem($merchant_item_oid, $expand, false);
$item = $api_response->getItem();
$item_reviews = $item->getReviews();
$individual_reviews = $item_reviews->getIndividualReviews();
// do whatever you wish with the reviews. iterate them, print them, etc.
// if you need the reviewer information
foreach ($individual_reviews as $individual_review) {
// if you need reviewer profile questions, such as "How often do you use this product?", access the
// rating names and scores. these are configurable by merchant, so we do not know what your questions may be.
// See Home -> Configuration -> Items -> Reviews -> Settings
// Or this URL: https://secure.ultracart.com/merchant/item/review/reviewSettingsLoad.do
$individual_review->getRatingName1(); // <-- this will not be the full question, but a key string.
$individual_review->getRatingScore1();
// if you need the review information, access that via their customer object. Be careful. This can result
// in a LOT of API calls and exhaust your limit. You may wish to add 'sleep' calls to your loop and cache
// these results daily or weekly.
$customer_response = $customer_api->getCustomer($individual_review->getCustomerProfileOid(), "reviewer");
$customer = $customer_response->getCustomer();
$reviewer = $customer->getReviewer();
}
echo 'The following item was retrieved via getItem():';
var_dump($item);
deleteSampleItem($item_id);
} catch (ApiException $e) {
echo 'An ApiException occurred. Please review the following error:';
var_dump($e); // <-- change_me: handle gracefully
die(1);
}
# frozen_string_literal: true
require 'json'
require 'ultracart_api'
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
customer_api = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
customer_profile_oid = 2_698_265 # account.profile.ultracart_customer_profile_oid # Integer | Customer to retrieve.
opts = {}
customer_response = customer_api.get_customer(customer_profile_oid, opts)
puts customer_response.to_json
Update a customer on the UltraCart account.
SDK Function Name: updateCustomer
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer | Customer to update | body | Customer | required |
| customer_profile_oid | The customer_profile_oid to update. | path | integer (int32) | required |
| _expand | The object expansion to perform on the result. See documentation for examples | query | string | optional |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class UpdateCustomer
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void UpdateCustomerCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;
public class UpdateCustomer {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
SDK Function Name: adjustInternalCertificate
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer_profile_oid | The customer profile oid | path | integer (int32) | required |
| adjust_internal_certificate_request | adjustInternalCertificateRequest | body | AdjustInternalCertificateRequest | required |
Update email list subscriptions for a customer
SDK Function Name: updateCustomerEmailLists
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer_profile_oid | The customer profile oid | path | integer (int32) | required |
| list_changes | List changes | body | CustomerEmailListChanges | required |
using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;
namespace SdkSample.customer
{
public class UpdateCustomerEmailLists
{
[Test]
public void ExecuteTest()
{
//TODO-PT
}
public static void UpdateCustomerEmailListsCall()
{
const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
var api = new CustomerApi(simpleKey);
}
}
}
package customer;
import com.ultracart.admin.v2.CustomerApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;
public class UpdateCustomerEmailLists {
public static void main(String[] args) throws ApiException {
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
CustomerApi customerApi = new CustomerApi(apiKey);
// TODO-PT
}
}
Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
SDK Function Name: getMagicLink
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer_profile_oid | The customer_profile_oid of the customer. | path | integer (int32) | required |
| storefront_host_name | The storefront to log into. | path | string | required |
Merge customer into this customer.
SDK Function Name: mergeCustomer
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer | Customer to merge into this profile. | body | CustomerMergeRequest | required |
| customer_profile_oid | The customer_profile_oid to update. | path | integer (int32) | required |
| _expand | The object expansion to perform on the result. See documentation for examples | query | string | optional |
Retrieve the customer store credit accumulated through loyalty programs
SDK Function Name: getCustomerStoreCredit
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer_profile_oid | The customer oid to retrieve. | path | integer (int32) | required |
Adds store credit to a customer
SDK Function Name: addCustomerStoreCredit
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| customer_profile_oid | The customer oid to credit. | path | integer (int32) | required |
| store_credit_request | Store credit to add | body | CustomerStoreCreditAddRequest | required |
Retrieve values needed for a customer profile editor.
SDK Function Name: getCustomerEditorValues
Retrieve all email lists across all storefronts
SDK Function Name: getCustomerEmailLists
SDK Function Name: searchCustomerProfileValues
| Parameter | Description | Location | Data Type | Required |
|---|---|---|---|---|
| lookup_request | LookupRequest | body | LookupRequest | required |
The following webhook events are generated for this resource.
| Event | Description | Response | Expansion |
|---|---|---|---|
| customer_create | Trigger when a customer is created | Customer | Yes |
| customer_delete | Trigger when a customer is deleted | Customer | Yes |
| customer_update | Trigger when a customer is updated | Customer | Yes |
| Name | Data Type | Description |
|---|---|---|
| action | string | |
| channel | string | |
| metric | string | |
| storefront_oid | integer (int32) | |
| subject | string | |
| ts | integer (int64) | |
| type | string | |
| uuid | string |
| Name | Data Type | Description |
|---|---|---|
| adjustment_amount | number | The adjustment amount |
| description | string | Description of this adjustment, 50 characters max |
| entry_dts | string (dateTime) | Optional timestamp for the adjustment, defaults to current time |
| expiration_days | integer (int32) | Optional expiration days from the entry_dts when these adjustment becomes worthless |
| order_id | string | Optional order id if this adjustment is related to a particular order |
| vesting_days | integer (int32) | Optional days required for this adjustment to vest |
| Name | Data Type | Description |
|---|---|---|
| adjustment_amount | number | The adjustment amount |
| balance_amount | number | The balance amount after the adjustment was made |
| 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 |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| Name | Data Type | Description |
|---|---|---|
| arbitrary_item_id | string | Arbitrary item id that should be rebilled instead of the normal schedule |
| arbitrary_percentage_discount | number | An arbitrary percentage discount to provide on future rebills |
| arbitrary_quantity | number | Arbitrary quantity to rebill |
| arbitrary_schedule_days | integer (int32) | The number of days to rebill if the frequency is set to an arbitrary number of days |
| arbitrary_unit_cost | number | Arbitrary unit cost that rebills of this item should occur at |
| arbitrary_unit_cost_remaining_orders | integer (int32) | The number of rebills to give the arbitrary unit cost on before reverting to normal pricing. |
| auto_order_item_oid | integer (int32) | Primary key of AutoOrderItem |
| first_order_dts | (read only) string (dateTime) | Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet. |
| frequency | string | Frequency of the rebill if not a fixed schedule
Allowed Values
|
| future_schedules | array of AutoOrderItemFutureSchedule | The future rebill schedule for this item up to the next ten rebills |
| last_order_dts | string (dateTime) | Date/time of the last order of this item |
| life_time_value | number | The life time value of this item including the original purchase |
| next_preshipment_notice_dts | string (dateTime) | The date/time of when the next pre-shipment notice should be sent |
| next_shipment_dts | string (dateTime) | Date/time that this item is scheduled to rebill |
| no_order_after_dts | string (dateTime) | Date/time after which no additional rebills of this item should occur |
| number_of_rebills | integer (int32) | The number of times this item has rebilled |
| options | array of AutoOrderItemOption | Options associated with this item |
| original_item_id | string | The original item id purchased. This item controls scheduling. If you wish to modify a schedule, for example, from monthly to yearly, change this item from your monthly item to your yearly item, and then change the next_shipment_dts to your desired date. |
| original_quantity | number | The original quantity purchased |
| paused | boolean | True if paused. This field is an object instead of a primitive for backwards compatibility. |
| paypal_payer_id | string | The PayPal Payer ID tied to this item |
| paypal_recurring_payment_profile_id | string | The PayPal Profile ID tied to this item |
| preshipment_notice_sent | boolean | True if the preshipment notice associated with the next rebill has been sent |
| rebill_value | number | The value of the rebills of this item |
| remaining_repeat_count | integer (int32) | The number of rebills remaining before this item is complete |
| simple_schedule | AutoOrderItemSimpleSchedule | If the item is configured as an automatic rebill and only has a simple single step schedule then details are provided within this object |
| Name | Data Type | Description |
|---|---|---|
| item_id | string | Item ID that should rebill |
| rebill_count | integer (int32) | The number of times this rebill represents |
| shipment_dts | string (dateTime) | Date/time that this item is scheduled to rebill |
| unit_cost | number | The unit cost of the item rebilling |
| Name | Data Type | Description |
|---|---|---|
| label | string(50) | Label |
| value | string(1024) | Value |
| Name | Data Type | Description |
|---|---|---|
| frequency | (read only) string | Frequency of the rebill if not a fixed schedule
Allowed Values
|
| item_id | (read only) string | Item ID that should rebill |
| repeat_count | integer (int32) | The number of times this simple schedule is configured for |
| 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 |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| Name | Data Type | Description |
|---|---|---|
| device | BrowserDevice | |
| os | BrowserOS | |
| user_agent | BrowserUserAgent |
| Name | Data Type | Description |
|---|---|---|
| family | string |
| Name | Data Type | Description |
|---|---|---|
| family | string | |
| major | string | |
| minor | string | |
| patch | string | |
| patch_minor | string |
| Name | Data Type | Description |
|---|---|---|
| family | string | |
| major | string | |
| minor | string | |
| patch | string |
| Name | Data Type | Description |
|---|---|---|
| channel_partner_oid | integer (int32) | Channel partner object id |
| code | string | Code associated with the channel partner |
| communication_method | string | Communication method of the channel partner |
| inactive | boolean | True if the channel partner is inactive |
| merchant_id | string | Merchant ID of the channel partner |
| name | string | Name of the channel partner |
| skip_customer_emails | boolean | True if emails to the customer are skipped for this channel partner. |
| Name | Data Type | Description |
|---|---|---|
| iso_2_code | string(2) | iso_2_code |
| name | string(50) | name |
| 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 |
| 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_drop_shipping | boolean | Allow Drop Shipping |
| 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 |
| edi | CustomerEDI | EDI settings |
| 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 |
| merchant_id | (read only) string | Merchant ID |
| 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 (deprecated) |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| activities | array of Activity | |
| global_unsubscribed | boolean | |
| global_unsubscribed_dts | string | |
| memberships | array of ListSegmentMembership | |
| metrics | array of Metric | |
| properties_list | array of Property | |
| spam_complaint | boolean | |
| spam_complaint_dts | string |
| Name | Data Type | Description |
|---|---|---|
| affiliate_oid | (read only) integer (int32) | Affiliate object identifier |
| (read only) string | ||
| first_name | (read only) string | First name |
| last_name | (read only) string | Last name |
| 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 |
| 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 |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| channel_partner_oid | integer (int32) | EDI channel partner this customer profile is associated with |
| distribution_center_number | string | The EDI distribution center number associated with this customer profile. |
| store_number | string | The EDI store number associated with this customer profile. |
| Name | Data Type | Description |
|---|---|---|
| affiliates | (read only) array of CustomerAffiliate | affiliates |
| card_exp_months | (read only) array of string | card_exp_months |
| card_exp_years | (read only) array of string | card_exp_years |
| card_types | (read only) array of string | card_types |
| countries | (read only) array of Country | countries |
| edi_channel_partners | (read only) array of ChannelPartner | EDI channel partners |
| loyalty_ledger_descriptions | (read only) array of string | loyalty_ledger_descriptions |
| loyalty_program_type | (read only) string | loyalty_program_type |
| qb_classes | (read only) array of string | qb_classes |
| sales_rep_codes | (read only) array of string | sales_rep_codes |
| state_optional_countries | (read only) array of Country | state_optional_countries |
| terms | (read only) array of string | terms |
| Name | Data Type | Description |
|---|---|---|
| customer_profile_email_oid | integer (int32) | ID of the email |
| string(100) | ||
| 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 |
| Name | Data Type | Description |
|---|---|---|
| add_to_lists | array of string | Add this customer to these email lists |
| remove_from_lists | array of string | Remove this customer from these email lists |
| Name | Data Type | Description |
|---|---|---|
| current_points | (read only) integer (int32) | Current points |
| internal_gift_certificate | GiftCertificate | The internal gift certificate that is used to manage cashback points under the hood |
| internal_gift_certificate_balance | (read only) string | Loyalty Cashback / Store credit balance (internal gift certificate balance) |
| internal_gift_certificate_oid | (read only) integer (int32) | Internal gift certificate oid used to tracking loyalty cashback / store credit. |
| ledger_entries | (read only) array of CustomerLoyaltyLedger | Ledger entries |
| pending_points | (read only) integer (int32) | Pending Points |
| redemptions | (read only) array of CustomerLoyaltyRedemption | Redemptions |
| Name | Data Type | Description |
|---|---|---|
| created_by | (read only) string | Created By |
| created_dts | (read only) string (dateTime) | Created date |
| description | (read only) string | Description |
| (read only) string | ||
| 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 |
| 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 |
| 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 |
| url | string | URL |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| Name | Data Type | Description |
|---|---|---|
| customer_profile_oid | integer (int32) | Customer profile oid to merge |
| string | Email of the customer profile to merge |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| name | string(50) | Name |
| pricing_tier_oid | integer (int32) | Pricing Tier Oid |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| all_tags | array of string | All tags the customer must have |
| any_tags | array of string | Any of these tags the customer must have |
| billing_city | string(32) | Billing city |
| billing_company | string(50) | Billing company |
| billing_country_code | string(2) | Billing country code |
| billing_day_phone | string(25) | Billing day phone |
| billing_evening_phone | string(25) | Billing evening phone |
| billing_first_name | string(30) | Billing first name |
| billing_last_name | string(30) | Billing last name |
| billing_postal_code | string(20) | Billing postal code |
| billing_state | string(32) | Billing state |
| string | Email address of this customer profile | |
| last_modified_dts_end | string (dateTime) | Last modified date end |
| last_modified_dts_start | string (dateTime) | Last modified date start |
| pricing_tier_name | string(50) | Pricing tier name |
| pricing_tier_oid | integer (int32) | Pricing tier oid |
| qb_class | string | QuickBooks class to import this customer as |
| quickbooks_code | string | QuickBooks name to import this customer as |
| shipping_city | string(32) | Billing city |
| shipping_company | string(50) | Billing company |
| shipping_country_code | string(2) | Billing country code |
| shipping_day_phone | string(25) | Billing day phone |
| shipping_evening_phone | string(25) | Billing evening phone |
| shipping_first_name | string(30) | Billing first name |
| shipping_last_name | string(30) | Billing last name |
| shipping_postal_code | string(20) | Billing postal code |
| shipping_state | string(32) | Billing state |
| signup_dts_end | string (dateTime) | Signup date end |
| signup_dts_start | string (dateTime) | Signup date start |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| customer | Customer | Customer |
| 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 |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| 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 |
| 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 |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| customers | array of Customer | |
| 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 |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| Name | Data Type | Description |
|---|---|---|
| available | number | Available store credit which is defined as unused and vested |
| expiring | number | Amount of store credit expiring within 30 days |
| future_ledgers | array of CustomerStoreCreditLedgerEntry | Array of future ledger entries including expiring entries |
| past_ledgers | array of CustomerStoreCreditLedgerEntry | Array of past ledger entries including accrual, usage, and expiring entries |
| total | number | Total lifetime store credit for this customer. |
| vesting | number | Amount of store credit vesting |
| Name | Data Type | Description |
|---|---|---|
| amount | number | Amount of store credit |
| description | string | Description or reason for the store credit |
| expiration_days | integer (int32) | Optional days for store credit to expire or zero for no expiration |
| vesting_days | integer (int32) | Optional days for store credit to vesting or zero for immediately available |
| Name | Data Type | Description |
|---|---|---|
| action | string | Identifies the state of this ledger entry whether the entry is Vesting or Expiring |
| amount | number | The amount of the activity. |
| description | string(50) | Description of what this ledger entry is used. |
| entry_dts | string | Date time of this ledger activity. |
| gift_certificate_ledger_oid | integer (int32) | Gift certificate ledger oid is a primary key for this object, used internally. |
| gift_certificate_oid | integer (int32) | Gift certificate oid. |
| reference_order_id | string | The order id if this gift certificate was used as part of the payment. |
| Name | Data Type | Description |
|---|---|---|
| customer_store_credit | CustomerStoreCredit | Customer store credit |
| 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 |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| Name | Data Type | Description |
|---|---|---|
| tag_value | string(250) | Tag Value |
| Name | Data Type | Description |
|---|---|---|
| avalara_customer_code | string | Avalara customer code |
| avalara_entity_use_code | string | Avalara entity use code |
| sovos_customer_code | string | Sovos customer code |
| taxjar_customer_id | string | TaxJar customer id |
| taxjar_exemption_type | string | TaxJar exemption type |
| Name | Data Type | Description |
|---|---|---|
| data | array of Customer | |
| draw | integer (int32) | |
| recordsFiltered | integer (int32) | |
| recordsTotal | integer (int32) |
| Name | Data Type | Description |
|---|---|---|
| uom | string | Unit of measure
Allowed Values
|
| value | number | The distance measured in UOM |
| Name | Data Type | Description |
|---|---|---|
| allow_csv_download | boolean | True if the current user has the rights to download this list. |
| created_dts | (read only) string (dateTime) | Created date |
| deleted | boolean | True if this campaign was deleted |
| email_list_uuid | (read only) string | Email list UUID |
| esp_list_segment_folder_uuid | string | List/Segment folder UUID |
| member_count | integer (int32) | Count of members in this list |
| merchant_id | (read only) string | Merchant ID |
| name | string(250) | Name of email list |
| public_description | string | Description of list shown to customer. |
| public_list | boolean | True if this list is public |
| storefront_oid | (read only) integer (int32) | Storefront oid |
| used_by | array of EmailListSegmentUsedBy | Details on the flows or campaigns that use this list. |
| Name | Data Type | Description |
|---|---|---|
| email_campaign_uuid | (read only) string | Email campaign UUID |
| email_flow_uuid | (read only) string | Email flow UUID |
| name | string | Name of the list or segment. |
| Name | Data Type | Description |
|---|---|---|
| error | Error | Error object if unsuccessful |
| lists | array of EmailList | |
| metadata | ResponseMetadata | Meta-data about the response such as payload or paging information |
| success | boolean | Indicates if API call was successful |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| Name | Data Type | Description |
|---|---|---|
| string | ||
| password | string | password |
| 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 |
| token | string | token |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| Name | Data Type | Description |
|---|---|---|
| token | string | token |
| 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 |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| 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 |
| object_id | string | Object id that the error is associated with |
| user_message | string | An end-user friendly message suitable for display to the customer |
| 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 |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| Name | Data Type | Description |
|---|---|---|
| activated | boolean | True if this gift certificate is activated and ready to apply to purchases. |
| code | (read only) string | The code used by the customer to purchase against this gift certificate. |
| customer_profile_oid | (read only) integer (int32) | This is the customer profile oid associated with this internally managed gift certificate. |
| deleted | boolean | True if this gift certificate was deleted. |
| string(100) | Email of the customer associated with this gift certificate. | |
| expiration_dts | string (dateTime) | Expiration date time. |
| gift_certificate_oid | (read only) integer (int32) | Gift certificate oid. |
| internal | (read only) boolean | This is an internally managed gift certificate associated with the loyalty cash rewards program. |
| ledger_entries | (read only) array of GiftCertificateLedgerEntry | A list of all ledger activity for this gift certificate. |
| merchant_id | string | Merchant Id |
| merchant_note | string | A list of all ledger activity for this gift certificate. |
| original_balance | (read only) number | Original balance of the gift certificate. |
| reference_order_id | (read only) string | The order used to purchase this gift certificate. This value is ONLY set during checkout when a certificate is purchased, not when it is used. Any usage is recorded in the ledger |
| remaining_balance | (read only) number | The remaining balance on the gift certificate. This is never set directly, but calculated from the ledger. To change the remaining balance, add a ledger entry. |
| Name | Data Type | Description |
|---|---|---|
| amount | number | The amount of the activity. |
| description | string(50) | Description of what this ledger entry is used. |
| entry_dts | string (dateTime) | Date time of this ledger activity. |
| gift_certificate_ledger_oid | integer (int32) | Gift certificate ledger oid is a primary key for this object, used internally. |
| gift_certificate_oid | integer (int32) | Gift certificate oid. |
| reference_order_id | string | The order id if this gift certificate was used as part of the payment. |
| Name | Data Type | Description |
|---|---|---|
| description | (read only) string | Optional description of the lookup value |
| key | (read only) string | The key or id of this lookup value |
| value | (read only) string | The value of this lookup value |
| Name | Data Type | Description |
|---|---|---|
| name | string | |
| type | string | |
| uuid | string |
| Name | Data Type | Description |
|---|---|---|
| category | string | |
| matches | string | |
| max_hits | integer (int32) | |
| storefront_host_name | string | |
| storefront_oid | integer (int32) | |
| subcategory | string |
| 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 |
| values | array of KeyValue | |
| warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
| 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 |
| 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. If this is the original order then expansion can be done. If it is a rebill then the record is a small pointer to the auto order and original order records. |
| 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
|
| current_stage | string | Current stage that the order is in.
Allowed Values
|
| 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 |
| point_of_sale | (read only) OrderPointOfSale | If the order was a point of sale order, this this object contains the details of where the transaction took place. |
| 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 |
| refund_reason | string | Refund reason code. This can only be written during a refund operation otherwise this field is read only. |
| reject_dts | (read only) string (dateTime) | If the order was rejected, the date/time that the rejection occurred |
| reject_reason | string | Reject reason code. This can only be written during a reject operation otherwise this field is read only. |
| 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 |
| utms | (read only) array of OrderUtm | UTM clicks. The zero index is the most recent (last) UTM click |
| 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 |
| 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
|
| Name | Data Type | Description |
|---|---|---|
| auto_order_code | (read only) string | Unique code assigned to this auto order |
| auto_order_oid | (read only) integer (int32) | Auto order object identifier |
| cancel_after_next_x_orders | integer (int32) | Cancel this auto order after X additional rebills |
| cancel_downgrade | (read only) boolean | True if the auto order was canceled because the customer purchased a downgrade item |
| cancel_reason | string | The reason this auto order was canceled by either merchant or customer |
| cancel_upgrade | (read only) boolean | True if the auto order was canceled because the customer purchased an upgrade item |
| canceled_by_user | string | The user that canceled the auto order |
| canceled_dts | string (dateTime) | The date/time that the auto order was canceled |
| completed | (read only) boolean | True if the auto order ran successfully to completion |
| credit_card_attempt | integer (int32) | The number of credit card attempts that have taken place |
| disabled_dts | (read only) string (dateTime) | The date/time the auto order was disabled due to failed rebills |
| enabled | boolean | True if this auto order is enabled |
| failure_reason | (read only) string | The reason this auto order failed during the last rebill attempt |
| items | array of AutoOrderItem | The items that are setup to rebill |
| next_attempt | string (dateTime) | The next time that the auto order will be attempted for processing |
| original_order_id | (read only) string | The original order id that this auto order is associated with. |
| override_affiliate_id | integer (int32) | Override the affiliate id given credit for rebills of this auto order |
| rebill_orders | (read only) array of Order | Rebill orders that have taken place on this auto order |
| rotating_transaction_gateway_code | string | The RTG code associated with this order for future rebills |
| status | (read only) string | The status of the auto order
Allowed Values
|
| 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. |
| cell_phone | string(25) | Cell phone |
| cell_phone_e164 | (read only) string(25) | Cell phone (E164 format) |
| 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) |
| string(100) | ||
| evening_phone | string(25) | Evening phone |
| evening_phone_e164 | (read only) string(25) | Evening phone (E164 format) |
| 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 |
| 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 |
| 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(50) | The order ID assigned by the channel partner for this order. |
| ignore_invalid_shipping_method | boolean | Set to true to ignore invalid shipping method being specified. Only applicable on inserting orders. |
| 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. This flag defaults to true. Set this flag to false to 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 |
| Name | Data Type | Description |
|---|---|---|
| browser | (read only) Browser | Parsed user agent string into components |
| comments | string | Comments from the customer. Rarely used on the single page checkout. |
| custom_field1 | string(50) | Custom field 1 |
| custom_field10 | string(200) | Custom field 10 |
| 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 |
| custom_field8 | string(200) | Custom field 8 |
| custom_field9 | string(200) | Custom field 9 |
| 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) |
| screen_size | (read only) string | Screen size small, medium or large |
| 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 |
| 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 |
| hdie_from_customer | (read only) boolean | True if this coupon is hidde from the customer |
| 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 |
| 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 |
| 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 |
| 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
|
| 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 |
| 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 |
| 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 |
| 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. Full notes in non-transactional mode. Just used to write a new merchant note when transaction merchant notes enabled. |
| 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 |
| transactional_merchant_notes | (read only) array of OrderTransactionalMerchantNote | Transactional merchant notes |
| 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_index | integer (int32) | Index of the item on the order (one based index) |
| 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 |
| parent_item_index | integer (int32) | If this item is a kit component, this is the item index of the parent item (kit) |
| parent_merchant_item_id | string(20) | If this item is a kit component, this is the item id of the parent item (kit) |
| 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 |
| refund_reason | string | Refund reason code. This can only be written during a refund operation otherwise this field is read only. |
| return_reason | string | Return reason code. This can only be written during a refund operation otherwise this field is read only. |
| 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 |
| shipping_status | string | Shipping status for this item. This is the replacement for the old order level shipping status. |
| special_product_type | string | Special product type (USPS Media Mail)
Allowed Values
|
| tags | array of OrderItemTag | Tags |
| tax_free | boolean | True if the item is tax free |
| tax_product_type | string | Type of product for tax purposes (self or UltraCart Managed taxes)
Allowed Values
|
| 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 |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| identification | string | Identification value |
| quantity | integer (int32) | Quantity associated with this identifier |
| Name | Data Type | Description |
|---|---|---|
| lot_expiration | string (dateTime) | Log expiration |
| lot_number | string | Lot number |
| lot_quantity | integer (int32) | Lot quantity |
| Name | Data Type | Description |
|---|---|---|
| additional_dimension_application | string | How the additional dimensions are applied to the item.
Allowed Values
|
| 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 |
| 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 |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| tag_value | string(100) | Tag Value |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| advertising_source | string(50) | Advertising source |
| cell_phone_opt_in | boolean | True if the customer has opted into SMS marketing |
| mailing_list | boolean | True if the customer has opted into mailing list subscription |
| referral_code | string(30) | Referral code |
| 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 |
| insurance | OrderPaymentInsurance | If payment_method=Insurance Insurance information |
| 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
|
| 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
|
| 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 surcharge_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 |
| Name | Data Type | Description |
|---|---|---|
| check_number | string | Check number |
| 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 card number |
| card_number_truncated | (read only) boolean | True if the card has been truncated |
| card_type | string | Card type
Allowed Values
|
| 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 |
| dual_vaulted | (read only) OrderPaymentCreditCardDualVaulted | Details on the dual vaulted card that is also stored at the payment processor for future reuse |
| Name | Data Type | Description |
|---|---|---|
| gateway_name | string | |
| properties | array of OrderPaymentCreditCardDualVaultedProperty | |
| rotating_transaction_gateway_code | string |
| Name | Data Type | Description |
|---|---|---|
| name | string | |
| value | string |
| 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
|
| bank_name | string(50) | Bank name |
| bank_owner_type | string | Bank owner type
Allowed Values
|
| 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 |
| Name | Data Type | Description |
|---|---|---|
| application_id | string | application id |
| claim_id | string | claim id |
| insurance_type | string | insurance type |
| refund_claim_id | string | refund claim id |
| Name | Data Type | Description |
|---|---|---|
| purchase_order_number | string | Purchase order number |
| Name | Data Type | Description |
|---|---|---|
| details | array of OrderPaymentTransactionDetail | Details |
| successful | boolean | True if the transaction was successful |
| transaction_gateway | string | Transaction gateway |
| transaction_id | integer (int32) | Transaction ID |
| transaction_timestamp | string (dateTime) | Transaction date/time |
| Name | Data Type | Description |
|---|---|---|
| name | string | Name |
| type | string | Type |
| value | string | Value |
| Name | Data Type | Description |
|---|---|---|
| location | (read only) PointOfSaleLocation | The location that the point of sale transaction took place at. |
| reader | (read only) PointOfSaleReader | The card reader that the point of sale transaction took place at if a credit card was used. |
| register | (read only) PointOfSaleRegister | The register that the point of sale transaction took place at. |
| 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(1500) | Value |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| salesforce_opportunity_id | string | Salesforce.com opportunity id |
| 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 |
| evening_phone_e164 | (read only) string(25) | Evening phone (E164 format) |
| 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_number_details | (read only) array of OrderTrackingNumberDetails | Tracking number details |
| tracking_numbers | array of string | Tracking numbers |
| weight | (read only) Weight | Total weight of the items on the order |
| Name | Data Type | Description |
|---|---|---|
| actual_fulfillment | (read only) Currency | Actual amount of the fulfillment cost |
| actual_payment_processing | (read only) Currency | Actual amount of the payment processing cost |
| actual_shipping | (read only) Currency | Actual amount of the shipping cost |
| 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 handling 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. |
| internal_gift_certificate_amount | (read only) Currency | Internal gift certificate amount used (store credit) |
| internal_gift_certificate_refunded | (read only) Currency | Internal gift certificate refunded (store credit) |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| tag_value | string(100) | Tag Value |
| 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 |
| Name | Data Type | Description |
|---|---|---|
| city | string | |
| event_dts | (read only) string (dateTime) | ISO 8601 timestamp that the event occurred |
| event_local_date | string | |
| event_local_time | string | |
| event_timezone_id | (read only) string | Timezone the event occurred in. Use this in conjunction with event_dts to format a local date/time. |
| state | string | |
| subtag | string | |
| subtag_message | string | |
| tag | string | |
| tag_description | string | |
| tag_icon | string | |
| zip | string |
| Name | Data Type | Description |
|---|---|---|
| actual_delivery_date | string | |
| actual_delivery_date_formatted | string | |
| details | array of OrderTrackingNumberDetail | |
| easypost_tracker_id | string | |
| expected_delivery_date | string | |
| expected_delivery_date_formatted | string | |
| map_url | string | |
| order_placed_date | string | |
| order_placed_date_formatted | string | |
| payment_processed_date | string | |
| payment_processed_date_formatted | string | |
| shipped_date | string | |
| shipped_date_formatted | string | |
| shipping_method | string | |
| status | string | |
| status_description | string | |
| tracking_number | string | |
| tracking_url | string |
| Name | Data Type | Description |
|---|---|---|
| ip_address | string | IP Address |
| note | string | note |
| note_dts | (read only) string (dateTime) | Timestamp when the note was added |
| user | string | User that wrote the merchant note |
| Name | Data Type | Description |
|---|---|---|
| attribution_first_click_subtotal | number | |
| attribution_first_click_total | number | |
| attribution_last_click_subtotal | number | |
| attribution_last_click_total | number | |
| attribution_linear_subtotal | number | |
| attribution_linear_total | number | |
| attribution_position_based_subtotal | number | |
| attribution_position_based_total | number | |
| click_dts | (read only) string (dateTime) | Date/time that the click happened |
| facebook_ad_id | string | |
| fbclid | string | |
| gbraid | string | |
| glcid | string | |
| msclkid | string | |
| ttclid | string | |
| uc_message_id | string | |
| utm_campaign | string | |
| utm_content | string | |
| utm_id | string | |
| utm_medium | string | |
| utm_source | string | |
| utm_term | string | |
| vmcid | string | |
| wbraid | string |
| Name | Data Type | Description |
|---|---|---|
| adddress2 | string | Address line 2 |
| address1 | string | Address line 1 |
| city | string | City |
| country | string | Country |
| distribution_center_code | string | The distribution center code where inventory is reduced from for this sale. |
| external_id | string(100) | External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs. |
| merchant_id | string | Merchant ID that owns this location |
| pos_location_oid | integer (int32) | Object identifier of the point of sale location. |
| postal_code | string | Postal code |
| state_province | string | State/province |
| Name | Data Type | Description |
|---|---|---|
| device_type | string | The device type of the reader. |
| label | string | The label of the reader. |
| merchant_id | string | The merchant id that owns this point of sale reader. |
| payment_provider | string | The payment provider for the card reader.
Allowed Values
|
| pos_reader_id | integer (int32) | Object identifier of the point of sale reader. |
| pos_register_oid | integer (int32) | Object identifier of the point of sale register this reader is assigned to. |
| serial_number | string | The serial number of the reader. |
| stripe_account_id | string | If the payment provider is Stripe, this is the Stripe account id |
| stripe_reader_id | string | If the payment provide is Stripe, this is the Stripe terminal reader id |
| Name | Data Type | Description |
|---|---|---|
| merchant_id | string | The merchant id that owns this point of sale register. |
| name | string | Name of the register. |
| pos_location_oid | integer (int32) | Object identifier of the point of sale location where this register is located. |
| pos_register_oid | integer (int32) | Object identifier of the point of sale register. |
| Name | Data Type | Description |
|---|---|---|
| name | string | |
| value | string |
| Name | Data Type | Description |
|---|---|---|
| payload_name | string | Payload name |
| result_set | ResultSet | Result set |
| 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. |
| Name | Data Type | Description |
|---|---|---|
| more_info | string | Additional information often a link to additional documentation |
| warning_message | string | A technical message meant to be read by a developer |
| Name | Data Type | Description |
|---|---|---|
| uom | string | Unit of measure
Allowed Values
|
| value | number | Weight |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |
| Name | Data Type | Description |
|---|---|---|
| UC-REST-ERROR | string | Contains human readable error message |
| Name | Data Type |
|---|---|
| body | ErrorResponse |