Introduction

A simple two page checkout geared toward trial offers. This checkout is popular among merchants offering trial offers tied to recurring orders.

<?php /** @noinspection DuplicatedCode */

require_once '../vendor/autoload.php';
require_once '../constants.php';

// this example uses the getCart.php code as a starting point, because we must get a cart to handoff a cart.
// here, we are handing off the cart to the ultracart engine with an operation of 'view', meaning that we
// simply added some items to the cart and wish for UltraCart to gather the remaining customer information
// as part of a normal checkout operation.
// valid operations are: "view", "checkout", "paypal", "paypalcredit", "affirm", "sezzle"
// Besides "view", the other operations are finalizers.
// "checkout": finalize the transaction using a customer's personal credit card (traditional checkout)
// "paypal": finalize the transaction by sending the customer to PayPal

// getCart.php code start ----------------------------------------------------------------------------

// this example is the same for both getCart.php and getCartByCartId.php.  They work as a pair and are called
// depending on the presence of an existing cart id or not.  For new carts, getCart() is used.  For existing
// carts, getCartByCartId($cart_id) is used.

$checkout_api = ultracart\v2\api\CheckoutApi::usingApiKey(Constants::API_KEY);

$expansion = "items"; // for this example, we're just getting a cart to insert some items into it.

$cart_id = null;
if(isset($_COOKIE[Constants::CART_ID_COOKIE_NAME])){
    $cart_id = $_COOKIE[Constants::CART_ID_COOKIE_NAME];
}

$cart = null;
if(is_null($cart_id)){
    $api_response = $checkout_api->getCart($expansion);
} else {
    $api_response = $checkout_api->getCartByCartId($cart_id, $expansion);
}
$cart = $api_response->getCart();

// getCart.php code end ----------------------------------------------------------------------------


// Although the above code checks for a cookie and retrieves or creates a cart based on the cookie presence, typically
// a php script calling the handoff() method will have an existing cart, so you may wish to check for a cookie and
// redirect if there isn't one.  However, it is possible that you wish to create a cart, update it, and hand it off
// to UltraCart all within one script, so we've left the conditional cart creation calls intact.

$handoff_request = new \ultracart\v2\models\CheckoutHandoffRequest();
$handoff_request->setCart($cart);
$handoff_request->setOperation("view");
$handoff_request->setErrorReturnUrl("/some/page/on/this/php/server/that/can/handle/errors/if/ultracart/encounters/an/issue/with/this/cart.php");
$handoff_request->setErrorParameterName("uc_error"); // name this whatever the script supplied in ->setErrorReturnUrl() will check for in the $_GET object.
$handoff_request->setSecureHostName("mystorefront.com"); // set to desired storefront.  some merchants have multiple storefronts.
$api_response = $checkout_api->handoffCart($handoff_request, $expansion);


if(!is_null($api_response->getErrors()) && !empty($api_response->getErrors())){
    // TODO: handle errors that might happen before handoff and manage those
} else {
    $redirect_url = $api_response->getRedirectToUrl();
    header('Location: '. $redirect_url);
}

Requirements

For development, you will need:

• Node.js installed on your computer
• Gulp.js installed
• UltraCart SDK - See https://github.com/UltraCart/rest_api_v2_sdk_javascript

Getting Started

To Use:

1. Download or clone this project.
2. From the base directory, run 'npm install'.
3. Edit both html pages and provide your own browser key (for more on this, read the docs). The one provided will not work. You'll find the key around line 16 of each file. uc.browserKey = "d7f38666b17e60016306f071d41e3700";
4. Right below the browser key, set your storefront server name. This is needed to provide proper branding for receipts. uc.storeFront = "demo.ultracartstore.com"
5. In trial-page1.html, find the following javascript variables and set them accordingly:
   • myItemId - this is the trial item id you are offering.
   • shippingMethod - the name of the shipping method you'll use.
   • shippingCost - the cost of the shipping method. this is verified and corrected on the server, so do not worry about customers finding and changing this value. However, we set it here to make the checkout complete and run fast.
6. Terms and Conditions link: Search for 'add_link_here' and add a link to your terms and conditions.
7. From the base directory, run 'gulp'. The default action will build the .js and .css file.
8. Deploy or test your checkout!

Changelog

Version 3.0

Major overhaul. Converted the checkout to use the latest UltraCart API.

See www.ultracart.com/api/

Version 2.0

This version will now run without any PHP support.

• The rest_proxy.php script is gone. This checkout now uses CORS alone to communicate with UltraCart servers.
• Upgrade jQuery
• Slight changes to the form field layout on the 2nd page to ensure the hosted fields did not mess up layout.

Version 1.1

• PCI 3.0 Compliant. Added support for UltraCart Hosted Fields See: http://docs.ultracart.com/display/ucdoc/UltraCart+Hosted+Credit+Card+Fields
• Added localization. Removed hard coded dollar signs. Checkout is now easy to use with other currencies
• Updated jQuery and JSON to latest versions to support PCI changes.
• Added labels throughout to eliminate some html validation warnings.

Version 1.0

Of this release, the changes in the rest_proxy.php script are most important. Please upgrade your rest_proxy.php scripts as soon as possible. Doing so will prevent issues with your site. Additionally, we've added a proxy version header that will allow us to track which merchants might have out of date proxy scripts in the future. This could prove vital to rapidly addressing any compatibility issues that might arise from future server updates.

rest_proxy.php changes:

• Fixes for content-length being sent down when original response was gziped. Would cause the client problem if the server running the proxy wasn't gziping it as well
• We have disabled gzip upstream until 4/15/2015 at which point everyone should have their proxy scripts upgraded.
• Added a flag that can be set to enable debugging to the error_log instead of having to uncomment all the statements.
• Change SSL certificate verify flag.
• Set an empty Expect header in the request to prevent curl from sending the Expect: 100-Continue header.
• Simplify the HTTP 100 Continue header trimming and allow for multiple of them
• Close out the curl handle sooner.
• Add a proxy version number to the header so we can tell from the server side if people are running out of date proxy