Plug-In Configuration

This page describes the following elements:

• Configuring Global-e Plugins
• Extra Order Attributes in Order Details
• Configuring Local Tax Groups
• Creating Orders
• Shipping Methods
• Validating Payments
• Creating Voucher Extra Attributes
• Configuring the Global-e Module
• Mandatory Developments
• Order Management

1.1 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.

1. Navigate toStores 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):
   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 INTEGRATIONYour secret key: <MERCHANT NAME>_ORDERAPIEncryption algorithm: AESYour 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}&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&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.

1.2 Extra Order Attributes in 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.

1. Navigate to System > Configurations.
2. Click Create attribute type.
3. Type the new attribute type ge_order_details 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"
       }
     }
   }
   

1.3 Configuring Local Tax Groups

Centra tax groups may consist of one or more tax rules, which set how much tax to apply to orders on the market level. While each store can have only one default tax group, merchants can configure as many as they want. During integration, a local tax group must be made on the merchant’s platform to ensure that all markets operated by Global-e include relevant VAT in orders.

1. Navigate to System > Tax Groups.
2. Click Create tax group.TheNew tax group screen is displayed.
3. Configure the following settings:
   • Status: Active
   • Name: GE Local VAT
   • Default in stores: <relevant default store>
4. Click Save.The new tax group configuration page is displayed.
5. Click Add tax rule and set the following configurations:

   Name: GE Local VAT Tax display name: GE Local VAT Tax code: VAT Apply tax per: Select Ship-to country Geolocation: Select ALL and unselect markets operate by the merchant	Include tax: Select In prices displayed before and in the checkout Apply tax to shipping fees: Yes Apply tax to handling fees: Yes Tax rate: Merchant Local VAT (for example, UK = 20%) Include shipping cost to order total: Yes

6. Click Save.The tax is displayed in Global-e orders.

1.4 Creating Orders

When Global-e uses the SendOrderToMerchant API, Centra’s Order API is used to create the order in Centra. During this stage we include the relevant order data natively (when available in the API) or as an extra attribute.

1.4.1 Native Order Data

Natively added order data takes precedence and is classified along with the merchant’s domestic orders. This data is only transmitted if the Order API supports the relevant fields. The following order details are supported according to the method above: The following figure shows the Order payment history:

1.4.2 Extra Attributes

The data included in the Extra Attributes section must be preconfigured as described in the Integration Guide. The same Custom attribute (same name and structure) is implemented during each the QA/Staging phase of each merchant’s integration, and deployed to Production by Centra developers. For any additional attributes that we add we must add a change in the configuration. This information is visible in the Other Information section of the order. Global-e supports the following fields:

1.4.3 Static Information

Static information is information that includes the same values for all orders belonging to a specific merchant:

• Tax (Global-e local VAT) - a tax group set up in Centra according to the base country
• Pricelist- always the default pricelist

1.5 Shipping Methods

To map the relevant shipping method to each Global-e order in Centra, the mapping must exist on both sides (in Global-e and in Centra) so that the shipping method used appears on your Global-e orders and is displayed correctly on your order form. During integration, your Global-e Solutions Engineer agrees with you on the list of shipping methods to support. For each method, we need the code (URI) you intend to use; it is critical that Global-e and Centra hold identical codes per method, so Global-e can use the shipping code to display the correct method on your order form. This list of shipping methods and their corresponding codes (URIs) must then be mapped on both sides - in Global-e and in Centra. In addition, you must create a default Global-e shipping method (GESHIPPING) that acts as a fallback whenever Global-e sends an order with an unmapped shipping method code: To correctly map your shipping methods to Global-e’s, create your shipping methods using the values in 1.3 Configuring Local Tax Groups.

1. Navigate to More (DTC) > Shipping:
   
2. Click on Create range on the top right side of the screen and set the following:
   • Status: Active
   • Shipping Name: Global-e Shipping
   • Currency: Merchant Base Currency
   • URI: GESHIPPING
   • Active in market: relevant GE operated markets
   • Default in stores: relevant stores
   • Pickup point: No
   • Click on Add group:
     • Apply shipping group per: Select Countries
     • Geolocation: Select ALL
     • Add Price Range: From 0 to 0 - fixed price
   • Click Save:
     
   Repeat the same procedure for every other shipping method agreed with your Global-e Solutions Engineer, substituting the relevant Shipping Name and URI for each one. The URIs in Centra must match the codes mapped in Global-e exactly.

1.6 Validating Payments

When an order is created in Centra, Global-e does the following:

1. Validates that payment has been received for the order.
2. Notifies the platform when the fraud check passes. Failed fraud checks cancel the order.
3. Adds a new row in the Order payment history region:
   

1.7 Creating Voucher Extra Attributes

You can store vouchers in Centra’s back-office. Storing these vouchers requires adding two extra attributes.

1. Configure the customer voucher usage:
   1. Navigate to System > Configurations.
   2. Click Create Attribute Type.
   3. Define the Name as ge_customer_coupon.
   4. In the Copy values form dropdown menu, select text.
   5. Copy and paste the following in the text field:
      	{
        "desc": "Coupons used by GE orders",
        "readonly": false,
        "group": "customer",
        "elements": {
          "ge_coupon_usage": {
            "type": "textarea",
            "desc": "Coupons used by GE orders"
          }
        }
      }
      
2. Configure the number of usages:
   1. Navigate to System > Configurations.
   2. Click Create Attribute Type.
   3. Define the Name as ge_voucher_details.
   4. In the Copy values form dropdown menu, select text.
   5. Copy and paste the following in the text field:
      {
        "desc": "Global-e Voucher details",
        "readonly": false,
        "group": "voucher",
        "elements": {
          "ge_successful_usages": {
            "type": "input",
            "desc": "Global-e Successful Usages"
          }
        }
      }
      

1.8 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:

Order Management

Cancelling Orders

Orders can be cancelled from Global-e to Centra, or from Centra to Global-e. When an order is cancelled Global-e restocks the inventory. Note that refunds are only created in Global-e and not in Centra. When orders are cancelled from Centra to Global-e, you can restock items using native functionality without Global-e’s assistance, and a refund is created in Global-e for the entire order amount.

Creating Refunds

In Centra you need to create a return to get a refund. Marking uncompleted reverts the return, but does not the refund. This creates discrepancies between the order status in Centra and Global-e. Global-e always sends the refund as Return in this scenario. Regarding return objects, you can restock items directly on Centra.

Amending Items

You can cancel single products from orders by removing them from the order, or by reducing their quantity.