Skip to main content
knowledgecenter.2checkout.com

Set the item external reference in the InLine Cart

Overview

Use the Product object to set item external reference by setting the externalReference property.

Use case

  1. Add an HTML link or button in your page like the one below.
  2. Create a JavaScript click handler to execute the Inline Client desired methods.
  3. Set dynamic mode usingTwoCoInlineCart.setup.setMode('DYNAMIC').
  4. Use theTwoCoInlineCart.products.add({name, quantity, price, options, externalReference})method to prepare your dynamic product.
  5. You can see below a signature token request payload for this example. A success response contains a JSON with the property “signature“ which needs to be used at the next step to set the signature using the TwoCoInlineCart method.
{
    "merchant": "2COLRNC",
    "dynamic": "1",
    "currency": "USD",
    "products": [
        {
            "name": "A test dynamic product",
            "price": 10,
            "reference": {
                "external": {
                    "item": "test-item-external-ref"
                }
            }
        }
    ]
}

The above payload will generate the signature 794da13570fbd72d7ffb970b7b16390508c1ac5581e829a811c5301f5e5bc0f3.

6. Use the TwoCoInlineCart.cart.setSignature('794da13570fbd72d7ffb970b7b16390508c1ac5581e829a811c5301f5e5bc0f3') method to set the signature. It is important that you employ TwoCoInlineCart.cart.removeAll() just before the TwoCoInlineCart.products.addMany(products) or TwoCoInlineCart.products.add(product) methods to remove previous products as the signature is based on the products' definition.

7. Use theTwoCoInlineCart.cart.checkout()method to show the cart on your page.

Sample request

HTML

<a href="#" class="btn btn-success" id="buy-button">Buy now!</a>

Javascript

window.document.getElementById('buy-button').addEventListener('click', function() {
  TwoCoInlineCart.setup.setMode('DYNAMIC');
  TwoCoInlineCart.cart.setCurrency('USD');
  TwoCoInlineCart.products.add({
    name: "A test dynamic product",
    price: 10,
    externalReference: 'test-item-external-ref'
  });
  TwoCoInlineCart.cart.setSignature('794da13570fbd72d7ffb970b7b16390508c1ac5581e829a811c5301f5e5bc0f3');
  TwoCoInlineCart.cart.checkout();
});

Demo

After setting the item external reference in the InLine cart using the above method, your cart should look like this: