Integration

In order to offer international checkout to your buyers, Glopal will have to interact with a cart during a customer’s session. This is the main integration point. This section describes what are the possible ways to do a cart transfer so international checkout can be initiated.

Plug & Play integration

Shopify, Bigcommerce, Magento - those are platforms that Glopal offers plugins for. This fast and easy integration supports a cart transfer by default and you don’t have to do any bespoke development.

If for any reason, there is a failure in the data from merchant cart to Glopal checkout, the customer will be redirected to the merchant's domestic checkout to complete their order.

Checkout API

If your platform is not among the listed platforms supported through the plugin, Glopal offers an easy-to-use Checkout API that you can use to transfer the buyer’s cart and redirect the buyer to the Glopal Checkout.

Integration with Glopal Checkout API should happen on the server-side. In the checkout funnel, you can decide the appropriate step when a buyer should be redirected to the Glopal Checkout to complete the purchase. Checkout API expects to receive information about the buyer's cart content and a checkout experience (country, language, currency) to be presented. In the successful response, API returns URL to redirect buyer into Glopal Checkout.

Glopal will share with you a secret API key for authentication.

Create checkout

Accepts cart content, returning checkout 'id' and 'cart_url' where buyer should be redirected to complete the checkout

POSThttps://api.glopal.com/v1/cart/transfer/external

Authorization

ClientAuth

Body

application/json

Cart transfer content

store_id*string

Example: "mystore"

visitor*Visitor (object)

cart*Cart (object)

items*Items (array of Item (object))

discountsDiscounts (array of one of)

shippingShipping (object)

referrerall of

Link used for return back from the checkout.

Example: "https://mystore.com"

trackingTracking (object)

checkoutCheckout (all of)

Response

200400401

Success response

Body

application/json

status*enum

ok

id*string

Example: "908dac6c-c9cd-4f0e-8a16-9916a5176845"

cart_url*string (url)

Url to redirect a buyer for completing the checkout. Note that this is not a resource, but a temporary redirection url that can expire. Caller is not supposed to store, parse or modify the url. Destination host and path may change without a notice.

Example: "https://mystore.glopal.com/fr-FR/api/cart/redirect/0068af0ae088778c94fc992576d8f"

Request

JavaScriptCurlPython

const response = await fetch('https://api.glopal.com/v1/cart/transfer/external', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "store_id": "mystore",
      "cart": {
        "currency": "USD"
      },
      "visitor": {
        "destination": "FR"
      },
      "items": [
        {
          "id": "5VBHU31KX1S0",
          "name": "Women Chevron Printed Trumpet Hem Dress",
          "quantity": 1,
          "regular_price": 25
        }
      ]
    }),
});
const data = await response.json();

Response

200400401

{
  "status": "ok",
  "id": "908dac6c-c9cd-4f0e-8a16-9916a5176845",
  "cart_url": "https://mystore.glopal.com/fr-FR/api/cart/redirect/0068af0ae088778c94fc992576d8f"
}

Minimal

Checkout will be presented to the visitor in the French language, with USD price converted to EUR and localized in the "calculated prices" mode according to predefined price localization rules.

{
  "short_name": "mystore",
  "cart": {
    "currency": "USD"
  },
  "visitor": {
    "destination": "FR"
  },
  "items": [
    {
      "id": "5VBHU31KX1S0",
      "name": "Women Chevron Printed Trumpet Hem Dress",
      "quantity": 1,
      "regular_price": 25
    }
  ]
}

If the total cost calculation feature is activated, duties and taxes will be calculated and charged on top of the items (and shipping method price). Note that total cost calculation may require additional data attributes or pre-existing integration/setup.

Fixed Prices

Checkout will be presented to the visitor in the French language, with the given price presented in EUR in the "fixed prices" mode.

{
  "short_name": "mystore",
  "cart": {
    "currency": "EUR",
    "prices": {
      "model": "fixed",
      "include_destination_tax": true,
      "include_destination_duties": true
    }
  },
  "visitor": {
    "destination": "FR"
  },
  "items": [
    {
      "id": "5VBHU31KX1S0",
      "name": "Women Chevron Printed Trumpet Hem Dress",
      "quantity": 1,
      "regular_price": 30
    }
  ]
}

If the total cost calculation feature is activated, duties and taxes on the item will be calculated but absorbed into the given price. Duties and taxes on the shipping method will be calculated separately. Note that total cost calculation may require additional data attributes or pre-existing integration/setup.

Attributes

Additional item attributes can be passed in the attributes object:

{
  "short_name": "mystore",
  "cart": {
    "currency": "USD"
  },
  "visitor": {
    "destination": "FR"
  },
  "items": [
    {
      "id": "5VBHU31KX1S0",
      "name": "Women Chevron Printed Trumpet Hem Dress",
      "quantity": 1,
      "regular_price": 25,
      "attributes": {
        "hs_code": "620444",
        "country_of_origin": "IN",
        "brand": "Placeholder Couture"
      }
    }
  ]
}

Additional attribute keys include fields like materials, gender or categories. Please refer to the OpenAPI specification for full descriptions. Depending on your integration passing additional attributes may be required for accurate total cost calculation.

Analytics & Tracking

Glopal Checkout is presented on a different domain. In order to maintain analytics & tracking, it is possible to pass analytics session identifiers and tracking cookies collected previously on the ecommerce site. This example is showing Google Analytics tracking and Google Ads conversion linker integration.

{
  ...
  "tracking": {
    "cookies": {
      "_gcl_au": "..."
    },
    "client_ids": {
      "ga": "1234.9876"
    }
  }
}

In addition, tracking code & properties should be configured in the Glopal Checkout settings.

OpenAPI

The latest API version is 1.3.0

43KB

openapi-checkout.yaml

Custom development

If the above options are unsuitable for your needs, you can expose the cart content in a machine-readable form so that Glopal will facilitate the cart transfer from the localized site.

Your platform must support a public endpoint that can be fetched in the session scope (passing a set of HTTP cookies) exposing cart information with enough details to allow cart transfer to the international checkout.

Cart content should contain the list of items that have been added to the cart, including:

• product name

• SKU

• price and quantity

• discount amounts

Glopal will then facilitate mapping the cart response into the Checkout API, as presented above. Please see the Checkout API description for more information on expected fields and values.

The response should be signed for integrity and authentication.

The response may be encrypted for confidentiality unless information included in the response (product, price, cart quantity) is not already public to the visitor and is not confidential.