This is Version 1 of the UltraCart REST API. It is now legacy. It will remain forever, but no new development will be done.

Please see Version 2 for new development.  Version 2 contains language specific SDKs, more functionality, and reduced API call counts.

Version 2 Main Documentation

Version 2 Supplemental Documentation

Additional Note, August 2020:

To prevent anyone from using this code in a new installation, several key samples have been removed.  These samples referred to php scripts that are no longer compatible with the UltraCart engine.    You should not be using this javascript anymore.   This documentation exists only for a reference for old legacy implementations.

Every call needs a merchant id (our merchant id is DEMO). We need to know who you are. There are three ways to provide the merchant id to the server:

1. Query Parameter: _mid=DEMO
2. HTTP Header: 'X-UC-Merchant-Id': 'DEMO'
3. Cookie named UltraCartMerchantID

Most of the examples below use the http header since it's easy to use with jQuery. If you wished to do it for all your ajax calls, you could execute this javascript:

jQuery.ajaxSetup({ cache: false, headers: {'X-UC-Merchant-Id': 'DEMO', "cache-control": "no-cache"});

However, that makes each call less atomic (and jQuery doesn't recommend it). Still, it's an option and may work well with your site.

If you receive an error "Missing Merchant ID", you've forgotten to do one of the above.

Now, in case you're wondering why the three methods use different names...

1. We made the query parameter as short as possible to keep the urls as short as possible. We used an underscore to denote "meta data" to the call.
2. We follow common practices for naming custom http headers. While the X- prefix is officially out of vogue, we still think it looks cool.
3. The cookie 'UltraCartMerchantID' is used in hundred of existing UltraCart checkout pages. So it made sense to stick with that cookie name.

When something doesn't work or you get an error, open your browser console and view the headers. Look for the error.

then fix it.

Can't? Then get on github.com. Ask for help here.

UltraCart's free support does not cover API development questions or troubleshooting of custom checkout pages.

Please post your questions to the "Issues" section of the github.com API reponsitories, which are monitored and responded to by the API developers. Please allow 24-48 hours for a reply.

Additional API support and troubleshooting services can be purchased at $100/hr (1 hour minimum) via UltraCart Professional Services.

(Scheduling of paid for support will be determined by Professional Services personnel.)

/rest/cart/checkout is NOT THE END! It's the beginning of the end. If the response from checkout has no errors, you must redirect the browser to the url found in checkoutResonse.redirectToUrl. That finishes the order. Any errors during that phase (card declined) will send the browser back to checkoutRequest.redirectOnErrorUrl, which is usually set to your checkout page. It's a circle, one that handles shipping companies and payment gateway timeouts without timing out the browser. It also handles any upsell gauntlets. So make sure you follow the redirect!

// incompatible code.  this code was removed.

Using PayPal with a custom upsell gauntlet:

When a checkout has upsells configured, and a PayPal payment method is chosen, the maximum amount of the upsell guantlet is used when authorizing funds. By doing this, the checkout is able to offer upsells and capture funds without having the customer login to PayPal again. Some merchants have need to implement their own upsell gauntlet. To provide a custom gauntlet and accept PayPal, you will need to supply two additional fields in your CheckoutRequest object.

1. payPalMaximumUpsellRevenue - the maximum upsell gauntlet $$. This should NOT include the current cart total.
2. payPalReturnUrl - this is the first page of your custom upsell gauntlet.  

Your guantlet pages are responsible for loading up the cart again, displaying offers, adding them to the cart, and then doing another "checkout" call at the end of the guantlet. This will again submit the cart to the UltraCart checkout service, finalize the order, and present the customer with a receipt.

 NEVER USE THIS OBJECT IN A CLIENT BROWSER.  This object requires a back end login (username/password). It is never safe to supply that to a client browser.

Every money field below is a number value. The number field has a corresponding string field with the suffix of 'Formatted'. These formatted fields contain the currency sign and decimal places. You should use the formatted fields wherever possible. Doing currency conversions of past orders is extremely complicated.

function createCart() {
  jQuery.ajax({
    url: '/rest/cart',
    headers: {'X-UC-Merchant-Id': 'DEMO',
      "cache-control": "no-cache"}, // could also pass merchant id as query parameter named '_mid' or cookie named 'UltraCartMerchantID'
    dataType: 'json'
  }).done(function (cart) {
        jQuery('#createCartResults').html('<pre>' + JSON.stringify(cart, null, '  ') + '</pre>');
      });
}
 
jQuery(document).ready(function () {
  jQuery('#createCartButton').on('click', createCart);
});

function updateCart() {
  // it's okay to have an empty cartId initially, but the property merchantId *must* be present and explicit.
  var cart = {
    'merchantId': 'DEMO',
    'cartId': '',
    'email': 'demo@demo.com' // pick any random field.  email will suffice for this demonstration
  };
 
  jQuery.ajax({
    url: '/rest/cart',
    type: 'PUT', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(cart),
    dataType: 'json'
  }).done(function (updatedCart) {
        jQuery('#updateCartResults').html('<pre>' + JSON.stringify(updatedCart, null, '  ') + '</pre>');
      });
}
 
jQuery(document).ready(function () {
  jQuery('#updateCartButton').on('click', updateCart);
});

function estimateShipping() {
  var cart = {
    'merchantId': 'DEMO',
    'cartId': '', // will be populated by call
    'items': [
      {'itemId': 'PDF', 'quantity': 1},
      {'itemId': 'Baseball', 'quantity': 2},
      {'itemId': 'BONE', 'quantity': 5}
    ]
  };
 
  jQuery.ajax({
    url: '/rest/cart',
    type: 'PUT', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(cart),
    dataType: 'json'
  }).done(function (updatedCart) {
 
        jQuery.ajax({
          url: '/rest/cart/estimateShipping',
          type: 'POST', // Notice
          headers : { "cache-control": "no-cache" },
          contentType: 'application/json; charset=UTF-8',
          data: JSON.stringify(updatedCart),
          dataType: 'json'
        }).done(function (availableShippingMethods) {
 
              var txt = JSON.stringify(availableShippingMethods, null, '  ');
              var pre = jQuery('<pre>');
              pre.text(txt);
              jQuery('#estimateShippingResults').html('').append(pre);
 
            });
      });
}
 
jQuery(document).ready(function () {
  jQuery('#estimateShippingButton').on('click', estimateShipping);
});

There are 3 main types of checkouts: 1) credit card, and 2) PayPal. The force a checkout down one of these paths, set the cart.paymentMethod property.

Credit Card: cart.paymentMethod = "Credit Card";

PayPal: cart.paymentMethod = "PayPal";

(If you wish to use PayPal Bill Me Later, you must also set a flag on the CheckoutRequest object. CheckoutRequest.payPalBillMeLater = true).

case matters, space matters. It must appear exactly as shown above.

The cart will be part of the CheckoutRequest object.

function checkout() {
  var cart = {
    'merchantId': 'DEMO',
    'cartId': '', // will be populated by call
 
    "customField1": 'blah blah blah',
    "customField2": 'perhaps an affiliate id here?',
    "coupons": [
      {couponCode: '10OFF'}
    ], // here is a coupon for $10 off the order
    "advertisingSource": "Radio",
    "screenBrandingThemeCode": "CSTM", // The demo account has a second them set up using the code CSTM
    "shippingMethod": "FedEx: 2-Day",
    "shipToFirstName": "Testy",
    "shipToLastName": "Testerson",
    "shipToTitle": "Sir",
    "shipToCompany": "Ultra Trains",
    "shipToAddress1": "55 Main Street",
    "shipToAddress2": "Suite 101",
    "shipToCity": "Duluth",
    "shipToState": "GA",
    "shipToPostalCode": "30097",
    "shipToCountry": "United States",
    "shipToPhone": "555-555-1212",
    "shipToEveningPhone": "5555553434", // notice the different format?
    "billToDayPhone": "555-555-1212",
    "billToEveningPhone": "5555551212",
    "billToFirstName": "Smith",
    "billToLastName": "Joe",
    "billToTitle": "Chief",
    "billToCompany": "Widgets, INC",
    "billToAddress1": "2000 Montana Dr",
    "billToAddress2": "",
    "billToCity": "Duluth",
    "billToState": "GA",
    "billToPostalCode": "30097",
    "billToCountry": "United States",
    "email": "test@test.com",
    "emailConfirm": "test@test.com",
    "paymentMethod": "Credit Card",
    "creditCardType": "VISA",
    "creditCardNumber": "4444333322221111",
    "creditCardExpirationMonth": 12,
    "creditCardExpirationYear": 2028,
    "creditCardVerificationNumber": "123",
    'items': [
      {'itemId': 'PDF', 'quantity': 1},
      {'itemId': 'Baseball', 'quantity': 2},
      {'itemId': 'BONE', 'quantity': 5}
    ]
  };
 
  // Notice: The checkout call does not take a cart.  It takes a CheckoutRequest which contains a cart.
  // Since the checkout process hands of to UltraCart to handle upsells, etc., we must also provide the
  // return point.
  var checkoutRequest = {
    'cart': cart,
    errorParameterName: 'error', // if there are errors after the handoff, the redirect page will receive those errors using this http parameter
    errorReturnUrl: document.URL, // this same page.
    secureHostName: null // can be null.  defaults to secure.ultracart.com if null.  could also be www.mystore.com if that was your url.
    //
 the secureHostName is where the checkout finishes on (receipt).  many 
merchants have dozens of sites.  So, if this isn't secure.ultracart and
    // you have more than one, you must specify it.
  };
 
 
  jQuery.ajax({
    url: '/rest/cart/checkout',
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(checkoutRequest),
    dataType: 'json'
  }).done(function (checkoutResult) {
 
 
        var txt = JSON.stringify(checkoutResult, null, '  ');
        var pre = jQuery('<pre>');
        pre.text(txt);
 
        var resultsDiv = jQuery('#checkoutResults');
        if (checkoutResult && checkoutResult.redirectToUrl) {
          resultsDiv.append("<div><a target='_blank' href='" + checkoutResult.redirectToUrl + " '>" + checkoutResult.redirectToUrl + "</a></div>");
        }
        resultsDiv.html('').append(pre);
      });
}
 
jQuery(document).ready(function () {
  jQuery('#checkoutButton').on('click', checkout);
});

 NEVER USE THIS CALL IN A CLIENT BROWSER.  This call requires a back end login (username/password). It is never safe to supply that to a client browser.

This method call cannot be used with Google or PayPal because those payment methods require a handoff in a browser, which does not happen with this call.

// okay, so we've provided you with a javascript example.  that's just to be consistent with the other examples.
// here's the warning again:  DO NOT USE THIS CALL IN A REAL JAVASCRIPT APPLICATION
 
  function finalizeOrder() {
    var cart = {
      'merchantId': 'DEMO',
      'cartId': '', // will be populated by call
      "customField1": 'blah blah blah',
      "customField2": 'perhaps an affiliate id here?',
      "coupons": [
        {couponCode: '10OFF'}
      ], // here is a coupon for $10 off the order
      "advertisingSource": "Radio",
      "screenBrandingThemeCode": "CSTM", // The demo account has a second them set up using the code CSTM
      "shippingMethod": "FedEx: 2-Day",
      "shipToFirstName": "Testy",
      "shipToLastName": "Testerson",
      "shipToTitle": "Sir",
      "shipToCompany": "Ultra Trains",
      "shipToAddress1": "55 Main Street",
      "shipToAddress2": "Suite 101",
      "shipToCity": "Duluth",
      "shipToState": "GA",
      "shipToPostalCode": "30097",
      "shipToCountry": "United States",
      "shipToPhone": "555-555-1212",
      "shipToEveningPhone": "5555553434", // notice the different format?
      "billToDayPhone": "555-555-1212",
      "billToEveningPhone": "5555551212",
      "billToFirstName": "Smith",
      "billToLastName": "Joe",
      "billToTitle": "Chief",
      "billToCompany": "Widgets, INC",
      "billToAddress1": "2000 Montana Dr",
      "billToAddress2": "",
      "billToCity": "Duluth",
      "billToState": "GA",
      "billToPostalCode": "30097",
      "billToCountry": "United States",
      "email": "test@test.com",
      "emailConfirm": "test@test.com",
      "paymentMethod": "Credit Card",
      "creditCardType": "VISA",
      "creditCardNumber": "4444333322221111",
      "creditCardExpirationMonth": 12,
      "creditCardExpirationYear": 2028,
      "creditCardVerificationNumber": "123",
      'items': [
        {'itemId': 'PDF', 'quantity': 1},
        {'itemId': 'Baseball', 'quantity': 2},
        {'itemId': 'BONE', 'quantity': 5}
      ]
    };
    // Notice: The checkout call does not take a cart.  It takes a CheckoutRequest which contains a cart.
    // Since the checkout process hands of to UltraCart to handle upsells, etc., we must also provide the
    // return point.
    var finalizeOrderRequest = {
      'cart': cart,
      'credentials':{
        'merchantId':'DEMO',
        'login':'demo',
        'password':'DoNotRunInBrowser'
      },
      'options':{
        noRealtimePaymentProcessing:true, // boolean
        skipPaymentProcessing:false, // boolean
        autoApprovePurchaseOrder:true, // boolean
        storeIfPaymentDeclines:true, // boolean (store the order even if payment declines -- goes into Accounts Receivable)
        creditCardAuthorizationReferenceNumber:'1234565', // string, if CC auth was already done elsewhere
        creditCardAuthorizationAmount:45.45, // decimal/float
        creditCardAuthorizationDate: '20130603T170226-0400' // string, ISO8601 format.
        // channelPartnerOid: 54, // integer, channel partner identifier
        // channelPartnerOrderId: 'CP-12345', // string, the order id the channel partner is using.
        // storeCompleted: true // boolean, if true, the order is marked as 'completed' -- bypassing Accounts Receivable and Shipping
      }
    };

    jQuery.ajax({
      url: '/rest/cart/finalizeOrder',
      type: 'POST', // Notice
      headers : { "cache-control": "no-cache" },
      contentType: 'application/json; charset=UTF-8',
      data: JSON.stringify(finalizeOrderRequest),
      dataType: 'json'
    }).done(function (finalizeOrderResult) {

          var txt = JSON.stringify(finalizeOrderResult, null, '  ');
          var pre = jQuery('<pre>');
          pre.text(txt);
          var resultsDiv = jQuery('#finalizeOrderResults');
          resultsDiv.html('').append(pre);
        });
  }
  jQuery(document).ready(function () {
    jQuery('#finalizeOrderButton').on('click', finalizeOrder);
  });

function validate() {
  var cart = {
    'merchantId': 'DEMO'
  };
 
  // grab the field values and add them to the cart.
  jQuery('.validation-fields input').each(function (idx, el) {
    cart[el.name] = jQuery.trim(el.value);
  });
 
 
  // validations are query parameters.
  var checks = [];
  jQuery('.validation-checkbox:checked').each(function (idx, el) {
    checks.push(encodeURIComponent(el.value));
  });
 
  jQuery.ajax({
    url: '/rest/cart/validate?check=' + checks.join("&check="),
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(cart),
    dataType: 'json'
  }).done(function (validationErrors) {
 
        var txt = null;
        if (validationErrors && validationErrors.length == 0) {
          txt = "No Errors Reported.";
        } else {
          txt = JSON.stringify(validationErrors, null, '  ');
        }
 
        var pre = jQuery('<pre>');
        pre.text(txt);
        jQuery('#validateResults').html('').append(pre);
      });
}
 
jQuery(document).ready(function () {
  jQuery('#validateButton').on('click', validate);
});

// since this demonstration has both a set and a clear, I'll need some state.
// so I'm going to use a global variable to store a cart reference.  Don't hate me.
var finalizeCart = null;
 
function finalizeAfter() {
 
  if (!finalizeCart) {
    jQuery.ajax({
      url: '/rest/cart',
      headers: {'X-UC-Merchant-Id': 'DEMO',
        "cache-control": "no-cache"}, // could also pass merchant id as query parameter named '_mid' or cookie named 'UltraCartMerchantID'
      dataType: 'json',
      async: false // for the demonstration, I'm keeping it simple with an synchronous call...
    }).done(function (cart) {
          finalizeCart = cart;
        });
  }
 
  jQuery.ajax({
    url: '/rest/cart/setFinalizeAfter?minutes=20', //minutes is optional.  default is 30
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(finalizeCart),
    dataType: 'json'
  }).done(function (data, textStatus, jqXHR) {
 
        var txt = jqXHR.status == 204
            ? "Server returned 204 'No Content', so the setFinalizeAfter was successful"
            : "Error. setFinalizeAfter failed with this: " + textStatus;
        var pre = jQuery('<pre>');
        pre.text(txt);
        jQuery('#finalizeResults').html('').append(pre);
 
 
      });
}
 
 
function clearFinalizeAfter() {
  if (!finalizeCart) {
    alert('Please click the finalizeAfter button before attempting to clear it.');
    return;
  }
 
  jQuery.ajax({
    url: '/rest/cart/clearFinalizeAfter',
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(finalizeCart),
    dataType: 'json'
  }).done(function (data, textStatus, jqXHR) {
 
        var txt = jqXHR.status == 204
            ? "Server returned 204 'No Content', so the clearFinalizeAfter was successful"
            : "Error. clearFinalizeAfter failed with this: " + textStatus;
        var pre = jQuery('<pre>');
        pre.text(txt);
        jQuery('#finalizeResults').html('').append(pre);
 
      });
}
 
 
jQuery(document).ready(function () {
  jQuery('#finalizeAfterButton').on('click', finalizeAfter);
  jQuery('#finalizeClearButton').on('click', clearFinalizeAfter);
});

var customerCart = null; // another global variable.  I need to keep state for this demonstration
 
function register() {
 
  // any cart passed to register must have a valid merchant id AND cart id, so I'm creating a cart here.
  if (!customerCart) {
    jQuery.ajax({
      url: '/rest/cart',
      headers: {'X-UC-Merchant-Id': 'DEMO',
        "cache-control": "no-cache"}, // could also pass merchant id as query parameter named '_mid' or cookie named 'UltraCartMerchantID'
      dataType: 'json',
      async: false // for the demonstration, I'm keeping it simple with an synchronous call...
    }).done(function (cart) {
          customerCart = cart;
        });
  }
 
  customerCart.email = jQuery.trim(jQuery('.customer-section input[name=email]').val());
  customerCart.password = jQuery.trim(jQuery('.customer-section input[name=password]').val());
 
  jQuery.ajax({
    url: '/rest/cart/register',
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(customerCart),
    dataType: 'json'
  }).done(function (loggedInCart) {
        customerCart = loggedInCart;
 
        var txt = JSON.stringify(customerCart, null, '  ');
        var pre = jQuery('<pre>');
        pre.text(txt);
        jQuery('#customerResults').html('').append(pre);
 
      });
}
 
function logout() {
  if (!customerCart || !customerCart.loggedIn) {
    alert('Please login first.');
    return;
  }
 
  jQuery.ajax({
    url: '/rest/cart/logout',
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(customerCart),
    dataType: 'json'
  }).done(function (loggedOutCart) {
        customerCart = loggedOutCart;
 
        var txt = JSON.stringify(customerCart, null, '  ');
        var pre = jQuery('<pre>');
        pre.text(txt);
        jQuery('#customerResults').html('').append(pre);
 
      });
}
 
 
function login() {
 
  // any cart passed to register must have a valid merchant id AND cart id, so I'm creating a cart here.
  if (!customerCart) {
    alert('Please register first to create a cart');
    return;
  }
 
  customerCart.email = jQuery.trim(jQuery('.customer-section input[name=email2]').val());
  customerCart.password = jQuery.trim(jQuery('.customer-section input[name=password2]').val());
 
  jQuery.ajax({
    url: '/rest/cart/login',
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(customerCart),
    dataType: 'json'
  }).done(function (loggedInCart) {
        customerCart = loggedInCart;
 
        var txt = JSON.stringify(customerCart, null, '  ');
        var pre = jQuery('<pre>');
        pre.text(txt);
        jQuery('#customerResults').html('').append(pre);
 
      });
}
 
 
function resetPassword() {
 
  // any cart passed to register must have a valid merchant id AND cart id, so I'm creating a cart here.
  if (!customerCart) {
    alert('Please register first to create a cart');
    return;
  }
 
  customerCart.email = jQuery.trim(jQuery('.customer-section input[name=email3]').val());
 
  jQuery.ajax({
    url: '/rest/cart/resetPassword',
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(customerCart),
    dataType: 'text' // Notice - plain text response.  no json
  }).done(function (response) {
 
        var pre = jQuery('<pre>');
        pre.text(response);
        jQuery('#customerResults').html('').append(pre);
 
      });
}
 
 
jQuery(document).ready(function () {
  jQuery('#registerButton').on('click', register);
  jQuery('#logoutButton').on('click', logout);
  jQuery('#loginButton').on('click', login);
  jQuery('#resetPasswordButton').on('click', resetPassword);
});

function checkoutTerms() {
 
  var cart = {
    'merchantId': 'DEMO',
    'cartId': '', // will be populated by call
    'items': [
      {'itemId': 'PDF', 'quantity': 1},
      {'itemId': 'Baseball', 'quantity': 2},
      {'itemId': 'BONE', 'quantity': 5}
    ]
  };
 
  jQuery.ajax({
    url: '/rest/cart',
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(cart),
    dataType: 'json'
  }).done(function (updatedCart) {
 
        jQuery.ajax({
          url: '/rest/cart/checkoutTerms',
          type: 'POST', // Notice
          headers : { "cache-control": "no-cache" },
          contentType: 'application/json; charset=UTF-8',
          data: JSON.stringify(updatedCart),
          dataType: 'json'
        }).done(function (terms) {
 
              var txt = JSON.stringify(terms, null, '  ');
              var pre = jQuery('<pre>');
              pre.text(txt);
              jQuery('#checkoutTermsResults').html('').append(pre);
 
            });
      });
}
 
jQuery(document).ready(function () {
  jQuery('#checkoutTermsButton').on('click', checkoutTerms);
});

function cityState() {
 
  var cart = {
    'merchantId': 'DEMO',
    'cartId': '', // will be populated by call
    'shipToPostalCode': '44233'
  };
 
  jQuery.ajax({
    url: '/rest/cart',
    type: 'POST', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: JSON.stringify(cart),
    dataType: 'json'
  }).done(function (updatedCart) {
 
        jQuery.ajax({
          url: '/rest/cart/cityState',
          type: 'POST', // Notice
          headers : { "cache-control": "no-cache" },
          contentType: 'application/json; charset=UTF-8',
          data: JSON.stringify(updatedCart),
          dataType: 'json'
        }).done(function (cityStateZip) {
 
              var txt = JSON.stringify(cityStateZip, null, '  ');
              var pre = jQuery('<pre>');
              pre.text(txt);
              jQuery('#cityStateResults').html('').append(pre);
 
            });
      });
}
 
jQuery(document).ready(function () {
  jQuery('#cityStateButton').on('click', cityState);
});

function shareCart() {
 
 
  jQuery.ajax({
    url: '/rest/cart/share/email',
    type: 'GET', // Notice
    headers : { "cache-control": "no-cache" },
    contentType: 'application/json; charset=UTF-8',
    data: {'_cid': my_cart_id, '_mid': 'DEMO', 'fromEmail': 'joe@aol.com', 'fromName': 'Joe Smith', 'toEmail': 'larray@aol.com' },
    dataType: 'json'
  }).done(function (data, textStatus, jqXHR) {
     // check for 204, 400, or 500.
      });
}