Callback Functions

Glopal Checkout offers callback support (synchronous webhooks) that enables your system to respond at crucial points during the checkout process. The platform will pause for your backend to supply a response, modifying the related action's behavior accordingly.

On receiving network error, 5xx HTTP response or timeout (no response in 5 seconds), Glopal will retry the callback request up to 3 times. Most callbacks have optional response. In case of a bad or no response, Glopal will resume delivering checkout experience. Because of their synchronous nature, it is critical for a good buyer experience to ensure fast and reliable response.

To activate Checkout Callbacks, please provide the URL(s) of your backend that should receive callbacks to your Glopal account manager. For details on the expected request body and potential responses, consult the related documentation provided below.

Endpoint URL will be your backend endpoint that recieves request from Glopal. Request payload is sent by Glopal, and your endpoint can return specified response. To see full specification you can download Checkout API reference in the OpenAPI format.

To authenticate requests from Glopal, you can choose to setup Basic HTTP Authentication for the Endpoint URL or include a shared secret in query parameters.

Inventory Check (Available to Promise)

Callback is triggered at the last stage of the checkout, before starting the payment action. Use this callback to confirm items are available for purchase.

When integrating this callback, keep in mind that buyers may still opt not to complete the payment, effectively canceling the purchase. If you decide to reserve inventory at this stage, rendering it unavailable to other buyers, make sure to establish an appropriate time limit before the reservation is released.

Validate requested inventory

Callback for doing ATP (Available to Promise) check or inventory reservation right before buyer's payment attempt.

POSThttps://api.glopal.com/inventory-check

Body

application/json

store_id*string

checkout_id*string

callback*string

visitorobject

cartobject

itemsarray of object

discountsarray of object

shippingobject

trackingTracking (object)

callbackenum

inventory_check

Response

200

Successful response

Body

application/json

itemsarray of object

List of confirmed items. If missing, all items are assumed available.

checkoutobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.glopal.com/inventory-check', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "store_id": "text",
      "checkout_id": "text",
      "callback": "text"
    }),
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "line_id": "text"
    }
  ],
  "checkout": {
    "expires_at": "text"
  }
}

Checkout Purchase

Use this callback to specify custom confirmation page message (eg. your order number) or custom confirmation page url. Other common uses is draft order creation (inventory reservation), clearing cart on the localized store or server-side marketing analytics.

Completing the checkout with a purchase

POSThttps://api.glopal.com/checkout-purchase

Body

application/json

store_id*string

checkout_id*string

callback*string

visitorobject

cartobject

itemsarray of object

discountsarray of object

shippingobject

trackingTracking (object)

callbackenum

checkout_purchase

order*object

Response

200

Successful response

Body

application/json

checkoutCheckoutSuccess (one of)

objectobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.glopal.com/checkout-purchase', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "store_id": "text",
      "checkout_id": "text",
      "callback": "text",
      "order": {
        "id": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "checkout": {
    "success_url": "https://mysite.com/${COUNTRY}/checkout/thankyou?lang=${LANGUAGE}",
    "success_url_autoredirect": true,
    "success_url_enable_hmac": false,
    "terms_of_service_url": {},
    "terms_of_service_url_autoredirect": true,
    "privacy_policy_url": {},
    "privacy_policy_url_autoredirect": true,
    "returns_policy_url": {},
    "returns_policy_url_autoredirect": true,
    "contact_details_url": {},
    "contact_details_url_autoredirect": true
  }
}