Skip to main content

Documentation Portal

Installing the Centra Plug-In

Configuring Global-e Plugins

Centra's three main APIs and webhooks must be added from Centra and configured in Global-e. Each of these has a plug-in that must be created on each environment separately.

To configure the Global-e plugins
  1. Navigate to Stores management > Stores.

  2. Select a store and click View.

    Each store should have one entry.

  3. From the Store panel, scroll down to the Plugins section and click Add plugin method.

  4. Click GE Order API to view its configuration settings.

  5. Configure the Order API settings (for managing your store):

    Note

    This document only describes the required settings, and all settings that are not described can be ignored.

    • Status: Active

    • Plugin name: GE Order API

    • Plugin: Order API

  6. Configure the following Settings:

    • URI: ge-order-api

    • Secret API key: to get the secret token, generate a random token in the Encrypt section of the it-tools.tech website:

      • Your text: GLOBAL-E INTEGRATION

      • Your secret key: <MERCHANT NAME>_ORDERAPI

      • Encryption algorithm: AES

      • Your text encrypted: <generated token>

    • Markets: Select all

    • Debug logging: Yes

    • Primary warehouse: Relevant warehouse specified by the merchant

    • Update stock updates: Physical

    • Limit shipments by warehouse: No

    • Get Orders with Status: Select ALL

    • Return "waiting for payment": Yes

    • Return "on hold" orders: Yes

    • Get orders starting with: Oldest

    • Get orders and shipments returns internal comment: Yes

    • Get orders and shipments returns Other: Yes

    • Get products returns cost price: Yes

    • Return unconfirmed allocations: No

    • Get products returns tax for the country: None

    • Bundles in shipments: Only containing items

    • Bundles in orders: Only containing items

    • Updating shipment with missing items: Keep items in order

    • Allow access to the following endpoints: Select ALL

  7. Click GE Integration Webhooks to view its configuration settings.

  8. Configure the following Centra Webhook settings (for integrating webhooks):

    • Status: Active

    • Plugin name: GE Integration Webhooks

    • Plugin: Centra Webhook

    • Required Settings:

      • Webhook URL: Setting this field with the correct value requires building a dedicated URL in the following format:

        https://{Global-e Environment}/webhooks/v1/Webhooks/WebhookIntegrationApi?merchantId={Merchant ID}&amp;domain={Centra’s Merchant Domain}

        See the table below for the possible options to include in the webhook URL format shown above:

        Element

        Example Value

        Global-e Environment

        • QA-INT - centra-int.bglobale.com

        • PROD - centra.global-e.com

        MerchantID

        1808

        Centra's merchant domain

        sandbox.centraqa.com

        The following is an example of the URL result based on the values above:

        https://centra-int.bglobale.com/webhooks/v1/Webhooks/WebhookIntegrationApi?merchantId=1808&amp;domain=sandbox.centraqa.com

    • Version: Integration API

    • Event triggers:

      • Order - Yes

      • Shipment - No

      • Customer - No

      • Account - No

      • Check first - No

      • Allocation request - No

      • Return - Yes

  9. Navigate to System > API Tokens.

  10. Click Create integration API token.

  11. Configure the following fields:

    General

    Restrictions

    Permissions

    • Description

    • Organization name

    • Email

    • Phone number

    • Integration name

    • Store types: ALL

    • Stores: GlobalE Store

    • Read permissions: Select ALL except CENTRAIP and CentraIP Details

    • Update permissions: Select ALL except Anonymize:write

  12. Copy and store the token:

    1. Click Show.

    2. Copy the token and save it locally.

Once created, Centra makes the token available for a limited time before hiding it.

Displaying Order Details

Once you've configured the required plugins and webhooks, you can configure orders to display the relevant details when an order is created. You can do this by using the mandatory extra attributes feature to enable configuring your relevant fields (Global-e order ID, tax values, discount values, etc).

Centra supports several discount types that may include multiple rules and dependencies. You can specify these conditions while creating both vouchers and campaigns.

Displaying Order Details
  1. Navigate to System > Configurations.

  2. Click Create attribute type.

  3. Type a name in the Name field

  4. Select Text from the dropdown menu.

  5. Paste the following in the text field and click Save:

     {
      "desc": "Global-E Information",
      "readonly": false,
      "group": "order",
      "elements": {
        "ge_order_id": {
          "type": "input",
          "desc": "Global-E Order Id"
        },
        "ge_order_total": {
          "type": "input",
          "desc": "Global-E Order Total"
        },
        "ge_order_shipping": {
          "type": "input",
          "desc": "Global-E Order Shipping"
        },
        "ge_order_duties": {
          "type": "input",
          "desc": "Global-E Order Duties"
        },
        "ge_order_delivery_days": {
          "type": "input",
          "desc": "Global-E delivery in days"
        },
        "canceled_by_ge": {
          "type": "boolean",
          "desc": "Canceled by Global-E"
        },
        "code_vouchers": {
          "type": "input",
          "desc": "Code Vouchers"
        },
        "automatic_vouchers": {
          "type": "input",
          "desc": "Automatic Vouchers"
        },
        "free_shipping": {
          "type": "input",
          "desc": "Free Shipping"
        },
        "ge_cart_item_ids_mapping": {
          "type": "textarea",
          "desc": "Global-E CartItemIds mapping"
        },
        "ge_cart_item_id_to_price_mapping": {
          "type": "textarea",
          "desc": "Global-E CartItemId to Price mapping"
        },
        "centra_to_ge_cart_mapping": {
          "type": "textarea",
          "desc": "Centra to Global-E order items mapping"
        }
      }
    }
Configuring the Global-e Module

After completing a merchant's integration, we must list the following relevant configurations that require specific values (in contrast to using the default template values):

  • Cart data on the front-end

  • Checkout tokens

  • Storefront attributes

  • Dedicated international Checkout page

  • Directing merchants to the Checkout page

  • Clearing the front-end cart

Mandatory Developments

The following table shows the mandatory developments:

Feature

Description

Pricelist

You must be able to retrieve the country from the Global-e Module cookie to use the relevant pricelist on the front-end

My account currency conversion

The following parameters are required to correctly convert currencies in the My Account or My Orders sections:

  • Customer ID: dedicated cookie

  • Global-e order ID: in the Document Object Model (DOM) of the relevant pages in the section

Client analytics

See the GEM client snippet.

Google Shopping feed

See the Marketing Feeds and Tax/Shipping Rates.

Cookies

The following cookies are required:

  • New cookie: Session token - The session token taken from Centra. Global-e needs the merchant's DTC plugin for identifying this token.

  • New cookie: Customer ID - Global-e needs a cookie to hold the customer ID in Centra.