Endpoints: Merchant APIs

Implement the four merchant endpoints detailed in the following sections. This Implementation is mandatory. We recommend exposing API methods via HTTPS.

Optionally, you can implement additional merchant APIs and APIs on the Global‑e Side.

Special Features and Requirements

If some of your products have reduced VAT rates (for example, you are a UK merchant with children's clothing), set the relevant reduced VAT rates for these products in the HTML data attribute. See Reduced VAT Rate Support.
If you require support for product country exceptions (for example, restrict browsing before reaching the Global‑e checkout), set the relevant data-countries for these products in the HTML data attribute. See Product-specific VAT Rates in the EU and Restrictions.
If you require the application of price coefficients to specific product classes (for example, on premium items in specific territories), set the relevant data-pc for these products in the HTML data attribute and the ProductClassCode in the GetCheckoutCartInfo (to Merchant) API.GetCheckoutCartInfo (to Merchant)
If you require support for existing logistics accounts, call a Global‑e API method to download the international commercial invoice for the specified order.

GetCheckoutCartInfo (Global-e to Merchant)

The GetCheckoutCartInfo API retrieves cart information for international checkout processing. This API:

Is triggered when the cart page loads or when a checkout attempt is made
Only returns products that are in stock
Requires proper cart token validation
Is part of Global-e's extensions (custom integration only)

This method is called from a Global-e server with the cart token rendered in a cookie or HTML.DOM. The client's session calculates the price totals. The GetCheckoutCartInfo API returns all cart contents, including customer information for logged-in customers

This API only returns products that are in stock. If special handling is required for stock validation on your side, for products in the basket (for example, calls to an external system), Global-e can specify an additional URL for this method, to indicate that stock validation is specifically required.

If the cart data is unavailable, the checkout will not open and an error message will appear in the browser development console.

The GetCheckoutCartInfo API is only triggered upon the cart page loading, or when a checkout attempt is made.

Note

This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration in required.

Usage

Displays totals on the basket page
Opens the checkout process
Validates order (SendOrderToMerchant)

Security Requirements

Client-side: Session and Cart token (present in the request URL parameters)
Server-side: For both GET and POST:
- Cart token - Request URL parameter (required)
- Custom parameter - Request URL parameter (optional)
- Custom header (optional)
- IP whitelist (optional)
- HTTP Basic Authentication (optional)
- JWT (optional)
Additional methods available with POST only:
- OrderID - In the request payload
- Merchant GUID - In request payload (required)

Retry Logic

None. The GetCheckoutCartInfo API is only triggered upon the cart page loading, or when a checkout attempt is made. If the GetCheckoutCartInfo request fails to execute on the cart page, the international cart totals will not be calculated or displayed there. If the GetCheckoutCartInfo request fails on the checkout, the checkout will not open.

Method/URL

Client-side: GET

Server-side: GET/ POST (default GET). Global-e can configure your preference.

GET https://www.merchant-site-domain.com/get-checkout-cart-info-url
POST https://www.merchant-site-domain.com/get-checkout-cart-info-url

Parameters

Request

Requests can contain more parameters than listed.

Name	Type	Description	Mandatory
`countryCode`	String	2-char ISO code for the country to which shipped	No
`currencyCode`	String	3-char currency code for the country to which shipped	No
`merchantCartToken`	String	Identifier used for the cart by the Merchant’s site	No

Response

The GetCheckoutCartInfo API returns all cart contents, including customer information for logged-in customers.

Note

Some values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.

Name	Type	Description
`CheckoutCartInfo`	Class CheckoutCartInfo	Retrieves cart information

Objects for GetCheckoutCartInfo API

CheckoutCartInfo

Parameter Name	Type	Description	Mandatory
`allowMailsFromMerchant`	Boolean	Indicates if the end customer’s consent to receive emails from merchants should be pre-selected in the Global‑e Checkout. TRUE - Customer consents to receive emails. FALSE - Customer does not consent to receive emails.	No
`billingDetails`	Object UserDetails	Billing details of a registered user (if available on the Merchant’s site). If the `userDetails` property mentioned below is specified, then `billingDetails` will be ignored.	No
`clientIP`	String	The end customer’s IP address	No
`CountryCode`	String	2-char ISO country code of the shipping country either pre-defined using geo-location or actively selected by the end customer. This may be different from `shippingDetails.CountryCode` denoting the registered user’s country.	No
`cultureCode`	String	ISO culture code. If specified, the textual properties will be returned in the requested culture’s language if available. Texts in English will be returned by default.	No
`currencyCode`	String	3-char ISO currency code denoting the end customer’s currency. If not specified, the Merchant’s default currency will be assumed by default.	No
`discountList`	List<Discounts>	List of JSON-serialized Discounts to be applied to the cart. Discounts of any type (“cart”, “shipping”, etc.) may be specified.	No
`doNotChargeVAT`	Boolean	Indicates if the end customer must not be charged VAT. This is usually set to TRUE for registered users who have validated their business entity’s VAT Registration Number with the merchant and are therefore VAT exempted.	No
`freeShippingCouponCode`	nvarchar	Merchant’s free shipping coupon code applied by the end customer. Max length: 50.	No
`hubID`	Decimal	Identifier of the Global‑e’s Local Hub previously returned by API. If not specified, the default Merchant’s Hub will be used instead.	No
`IncludeVAT`	Decimal	Optional for the merchants not supporting browsing integration. The value is returned from CountryCoefficients API.	No
`isFreeShipping`	Boolean	Indicates if the Merchant offers free international shipping to the end customer.	No
`loyaltyCode`	String	The loyalty code specified by the end customer (or read from the end customer’s account) on the Merchant’s site.	No
`LoyaltyPoints`	Object LoyaltyPoints	LoyaltyPoints contains data about the registered user for applying loyalty points on the Checkout page.	No
`loyaltyPointsEarned`	Decimal	The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site.	No
`loyaltyPointsSpent`	Decimal	The number of loyalty points to be spent for this purchase by the end customer on the Merchant’s site.	No
`loyaltyPointsTotal`	Decimal	The total number of loyalty points currently available in the end customer’s user account on the Merchant’s site.	No
`merchantCartHash`	nvarchar	A hash may be optionally generated by the merchant and returned to the merchant with an order API call. This hash may be used for additional cart and order validation purposes on the Merchant’s side. No max length.	No
`MerchantOrderId`	String	The merchant order id, if it is already known, at the point when the user is still in the cart page on the merchant’s store.	No
`originalCurrencyCode`	String	3-char ISO currency code denoting the original currency on the Merchant’s site (before applying country coefficient and FX conversion). If not specified, the Merchant’s default currency will be assumed by default.	No
`otVoucherAmount`	Decimal	Amount of the one-time voucher in `otVoucherCurrencyCode` currency.	No
`otVoucherCode`	String	One-time voucher code for the cart (for applicable platforms).	No
`otVoucherCurrencyCode`	String	One-time voucher currency used for the amount.	No
`paymentInstallments`	String	List of available payment instalment amounts. For example: {2,4,6,8} – This indicates that we should allow instalmentsin 2, 4, 6 or 8 instalment options (to be selected by the customer).	No
`prodectsList`	List<Product>	List of Product objects (specified in the request body)	Yes
`rateData`	String	Currency data is used by Global-e to verify the currency rate and to return the value received in the used currency rate.	Optional, irrelevant for GetCheckoutCartInfo API response
`shippingDetails`	Object UserDetails	Shipping details of a registered user (if available on the Merchant’s site). If the `userDetails` property is specified, then the `shippingDetails` will be ignored. If `countryCode` is not specified, the shipping country must be specified in `shippingDetails.CountryCode` property. If not specified neither in the `countryCode` argument nor in `shippingDetails.CountryCode` property, clientIP argument defined above becomes mandatory and will be used to determine the end user’s shipping country by Global‑e system.	No
`shippingOptionsList`	List<ShippingOption>	List of JSON-serialized Shipping Options available for local shipping of the order from the Merchant to Global‑e’s Local Hub previously returned by ActiveHubDetails API. If the Global-e integration shipping API has been created and enabled for Global‑e on the Merchant’s site, Global‑e will prefer this Shipping Option when posting the order back to the Merchant’s site (using SendOrderToMerchant API). Therefore, all other shipping APIs available for local shipping may be omitted in `shippingOptionsList`.	No
`urlParameters`	List<KeyValuePair>	List of JSON-serialized Key:Value pairs denoting the values of the parameters specified in the respective Merchant’s REST API action URLs. For example, to instruct Global‑e to include “en-AU” locale in the SendOrderToMerchant call for this cart, `urlParameters` should include the following `KeyValuePair: [{"Key":"locale", "Value":"en-AU"}]`. In this example “locale” parameter should be configured for `SendOrderToMerchant` URL for this merchant on the Global‑e side.	No
`userDetails`	Object CartUserDetails	All available details of the user including all relevant addresses. If `userDetails` is not specified, then `shippingDetails` and `billingDetails` properties will be used instead. `userDetails` property can be used by merchants who support multiple shipping and/or multiple billing addresses in the user’s account.	No
`vatRegistrationNumber`	String	VAT Registration Number of the end customer’s business entity validated with the merchant.	No
`webStoreCode`	nvarchar	Code used on the merchant’s side to identify the web store where the current cart is originating. This code should be used when a multi-store setup is on the merchant’s site. Max length: 100	No
`webStoreInstanceCode`	String	Code used on the merchant’s side to identify the web store instance where the current cart is originating from. This code should be used in case of multi-store domains set up on the merchant’s site.	No

Examples

Response Sample 1

Response contains CheckoutCartInfo class

{
    "productsList": [{
            "ProductCode": "9632261340000",
            "ProductGroupCode": "9632261_c340000",
            "CartItemId": "6601",
            "ParentCartItemId": "",
            "CartItemOptionId": "",
            "Name": "name of product",
            "Description": "product description",
            "Keywords": "product keywords",
            "URL ": "product page url",
            "GenericHSCode ": "",
            "OriginCountryCode": "CHN",
            "Weight": 0.0,
            "Height": 0,
            "Width": 0,
            "Length": 0,
            "Volume": 0,
            "ImageURL": "",
            "ImageHeight": 533,
            "ImageWidth": 414,
            "IsFixedPrice": "true",
            "ListPrice": null,
            "OriginalListPrice": 20.0000,
            "SalePrice": 0.0,
            "SalePriceBeforeRounding": 0.0,
            "OriginalSalePrice": 20.0000,
            "OrderedQuantity": 2,
            "DeliveryQuantity": 2,
            "IsBlockedForGlobalE": false,
            "VATRateType": "",
            "LocalVATRateType": "",
            "Brand": {
                "BrandCode": "7",
                "Name": "Brand2"
            },
            "Categories": null,
            "Attributes": [{
                    "AttributeCode": "26",
                    "Name": "26",
                    "AttributeTypeCode": "size"
                }, {
                    "AttributeCode": "Geranium Red/Cut Out",
                    "Name": "Geranium Red/Cut Out",
                    "AttributeTypeCode": "color"
                }
            ],
        }
    ],
    "shippingDetails": {
        "UserId": "",
        "UserIdNumber": "",
        "UserIdNumberType": {
            "UserIdNumberTypeCode": null,
            "Name": "Shipping"
        },
        "FirstName": "",
        "LastName": "",
        "MiddleName": "",
        "Salutation": "",
        "Phone1": "",
        "Phone2": "",
        "Fax": "",
        "Email": "",
        "Address1": "",
        "Address2": "",
        "City": "",
        "StateOrProvince": "",
        "StateCode": "",
        "Zip": "",
        "CountryCode": "",
        "CountryName": ""
    },
    "billingDetails": {
        "UserId": "",
        "UserIdNumber": "",
        "UserIdNumberType": {
            "UserIdNumberTypeCode": null,
            "Name": "Billing"
        },
        "FirstName": "",
        "LastName": "",
        "MiddleName": "",
        "Salutation": "",
        "Phone1": "",
        "Phone2": "",
        "Fax": "",
        "Email": "",
        "Address1": "",
        "Address2": "",
        "City": "",
        "StateOrProvince": "",
        "StateCode": "",
        "Zip": "",
        "CountryCode": "",
        "CountryName": ""
    },
    "discountsList": [{
            "OriginalDiscountValue": 10.0000,
            "DiscountType": "percentage",
            "Name": "discount name",
            "Description": "",
            "DiscountCode": null,
            "ProductCartItemId": 6601,
            "CouponCode": null
        }
    ]
}

Response Sample 2: Dynamic Prices

{
    "productsList": [{
            "CartItemId": "676106",
            "ProductCode": "676106",
            "ProductGroupCode": "CS16577",
            "Name": "+Warmers",
            "Description": "Product List Description",
            "IsFixedPrice": false,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https://www.mystore.co.uk/product/[myproduct]",
            "Volume": 0.12,
            "Weight": 0.08,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 0
            },
            "OriginalSalePrice": 29.17,
            "Categories": [{
                    "CategoryCode": 161,
                    "Name": "Cycle Clothing > Armwarmers"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 2,
                    "Name": "Black"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 869,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 35,
            "ImageURL": "https://www.mystore.co.uk/product-media/[myproductimpage.jpg]",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 38,
                "Name": "Castelli"
            },
            "SalePrice": 0,
            "ListPrice": 0,
            "ProductClassCode": "expensive_warmers"
        }, {
            "CartItemId": "678197",
            "ProductCode": "678197",
            "ProductGroupCode": "7MESH-1507",
            "Name": "Resistance Jacket",
            "Description": "With its ...... short or long sleeve.",
            "IsFixedPrice": false,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/item\/7Mesh\/Jacket\/EAM",
            "Volume": 1,
            "Weight": 0.115,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 20
            },
            "OriginalSalePrice": 150,
            "Categories": [{
                    "CategoryCode": 151,
                    "Name": "Cycle Clothing > Jacket Wind"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 3,
                    "Name": "Blue"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 367,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 180,
            "ImageURL": "https:\/\/dbyvw4efi.cloudfront.net\Jacket-blue.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 705,
                "Name": "7Mesh"
            },
            "SalePrice": 0,
            "ListPrice": 0
        }
    ],
    "discountsList": [{
            "OriginalDiscountValue": 3.398,
            "DiscountType": null,
            "Name": "GLOBALE20",
            "Description": null,
            "DiscountCode": "GLOBALE20",
            "ProductCartItemId": null,
            "CouponCode": "GLOBALE20",
            "CalculationMode": 1,
            "DiscountValue": 0
        }
    ],
    "billingDetails": {
        "UserId": "1144404",
        "Email": "[email protected]",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "doe",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    },
    "shippingDetails": {
        "UserId": "1144404",
        "Email": "[email protected]",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "winer",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    }
}

Response Sample 3: Fixed Prices

{
    "productsList": [{
            "CartItemId": "676106",
            "ProductCode": "676106",
            "ProductGroupCode": "CS16577",
            "Name": "N+ Warmers",
            "Description": "The Warmers .... and water resistance.",
            "IsFixedPrice": true,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/Warmers\/HOG",
            "Volume": 0.12,
            "Weight": 0.08,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 20
            },
            "OriginalSalePrice": 0,
            "VATRateType": {
                "VATRateTypeCode": "vat10.5",
                "Rate": 10.5
            },
            "Categories": [{
                    "CategoryCode": 161,
                    "Name": "Cycle Clothing > Warmers"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 2,
                    "Name": "Black"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 869,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 0,
            "ImageURL": "https:\/\/offpi.cloudfront.net\/Warmer.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 38,
                "Name": "BandNamei"
            },
            "SalePrice": 120,
            "ListPrice": 120,
            "ProductClassCode": "expensive_warmers"
        }, {
            "CartItemId": "678197",
            "ProductCode": "678197",
            "ProductGroupCode": "7MESH-1507",
            "Name": "Resistance Jacket",
            "Description": "With its .... your short or long sleeves.",
            "IsFixedPrice": true,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/Jacket\/JAM",
            "Volume": 1,
            "Weight": 0.115,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 20
            },
            "OriginalSalePrice": 0,
            "Categories": [{
                    "CategoryCode": 151,
                    "Name": "Cycle Clothing > Jacket Wind"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 3,
                    "Name": "Blue"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 367,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 0,
            "ImageURL": "https:\/\/offpi.cloudfront.net\/Jacket-blue.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 705,
                "Name": "Mesh"
            },
            "SalePrice": 180,
            "ListPrice": 150
        }
    ],
    "discountsList": [{
            "OriginalDiscountValue": 0,
            "DiscountType": null,
            "Name": "GLOBALE20",
            "Description": null,
            "DiscountCode": "GLOBALE20",
            "ProductCartItemId": null,
            "CouponCode": "GLOBALE20",
            "CalculationMode": 3,
            "DiscountValue": 50
        }
    ],
    "billingDetails": {
        "UserId": "1144404",
        "Email": "[email protected]",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "doe",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    },
    "shippingDetails": {
        "UserId": "1144404",
        "Email": "[email protected]",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "doe",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    }
}

Response Sample 4: Multi Addresses

{
    "productsList": [{
            "CartItemId": "676106",
            "ProductCode": "676106",
            "ProductGroupCode": "CS16577",
            "Name": "N+ Warmers",
            "Description": "The <a href=\"https:\/\/www.mysite.co.uk\/brand\/... and water resistance.",
            "IsFixedPrice": true,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/item\/Warmers\/HOG",
            "Volume": 0.12,
            "Weight": 0.08,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 21
            },
            "OriginalSalePrice": 0,
            "Categories": [{
                    "CategoryCode": 161,
                    "Name": "Cycle Clothing > Warmers"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 2,
                    "Name": "Black"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 869,
                    "Name": "M"
                }
            ],
            "MetaData": {
                "Attributes": [{
                        "AttributeKey": "Name",
                        "AttributeValue": "Alex"
                    }
                ]
            },
            "OriginalListPrice": 0,
            "ImageURL": "https:\/\/offpi.cloudfront.net\/Warmer.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 38,
                "Name": "BrandName"
            },
            "SalePrice": 50,
            "ListPrice": 123,
            "ProductClassCode": "expensive_warmers"
        }, {
            "CartItemId": "678197",
            "ProductCode": "678197",
            "ProductGroupCode": "7MESH-1507",
            "Name": "Resistance Jacket",
            "Description": "With its ... your short or long sleeve.",
            "IsFixedPrice": false,
            "IsBlockedForGlobalE": false,
            "OrderedQuantity": 1,
            "URL": "https:\/\/www.mysite.co.uk\/Jacket\/JAM",
            "Volume": 1,
            "Weight": 0.115,
            "LocalVATRateType": {
                "VATRateTypeCode": "NORMAL",
                "Rate": 20
            },
            "OriginalSalePrice": 150,
            "Categories": [{
                    "CategoryCode": 151,
                    "Name": "Cycle Clothing > Jacket"
                }, {
                    "CategoryCode": "WORLDWIDE",
                    "Name": "WORLDWIDE"
                }
            ],
            "Attributes": [{
                    "AttributeTypeCode": "colour_or_flavour",
                    "AttributeCode": 3,
                    "Name": "Blue"
                }, {
                    "AttributeTypeCode": "size",
                    "AttributeCode": 367,
                    "Name": "M"
                }
            ],
            "OriginalListPrice": 180,
            "ImageURL": "https:\/\/offpi.cloudfront.net\/Jacket-blue.jpg",
            "ImageHeight": 145,
            "ImageWidth": 145,
            "Brand": {
                "BrandCode": 705,
                "Name": "Mesh"
            },
            "SalePrice": 0,
            "ListPrice": 0
        }
    ],
    "discountsList": [{
            "OriginalDiscountValue": 0,
            "DiscountType": null,
            "Name": "GLOBALE20",
            "Description": null,
            "DiscountCode": "GLOBALE20",
            "ProductCartItemId": "676106",
            "CouponCode": "GLOBALE20",
            "CalculationMode": 3,
            "DiscountValue": 3.398
        }
    ],
    "userDetails": {
        "UserId": "1144404",
        "AddressDetails": [{
                "Email": "[email protected]",
                "Salutation": "",
                "FirstName": "john",
                "LastName": "doe",
                "Address1": "basel 25",
                "Address2": "",
                "City": "petah tikva",
                "StateOrProvince": "",
                "Zip": "11223344",
                "CountryCode": "IL",
                "CountryName": "Israel",
                "Phone1": "0000000000",
                "Phone2": "",
                "IsShipping": true,
                "IsBilling": false,
                "IsDefaultShipping": true,
                "IsDefaultBilling": false,
                "AddressBookId": 111
            }, {
                "Email": "[email protected]",
                "Salutation": "",
                "FirstName": "john",
                "LastName": "doe",
                "Address1": "basel 25",
                "Address2": "",
                "City": "petah tikva",
                "StateOrProvince": "",
                "Zip": "11223344",
                "CountryCode": "IL",
                "CountryName": "Israel",
                "Phone1": "0000000000",
                "Phone2": "",
                "IsShipping": false,
                "IsBilling": true,
                "IsDefaultShipping": false,
                "IsDefaultBilling": true,
                "AddressBookId": 222
            }, {
                "Email": "[email protected]",
                "Salutation": "",
                "FirstName": "john",
                "LastName": "doe3",
                "Address1": "basel 253",
                "Address2": "",
                "City": "petah tikva",
                "StateOrProvince": "",
                "Zip": "11223344",
                "CountryCode": "IL",
                "CountryName": "Israel",
                "Phone1": "0000000000",
                "Phone2": "",
                "IsShipping": true,
                "IsBilling": true,
                "IsDefaultShipping": false,
                "IsDefaultBilling": false,
                "AddressBookId": 333
            }
        ]
    },
    "allowMailsFromMerchant": true
}

SendOrderToMerchant (Global-e to Merchant)

Note

This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required.

This API posts the new order or updates the existing order on the merchant’s site.

When implementing a Global-e extension or plug-in, this method is required to create the customer order in the merchant’s system, clear the user’s basket, and optionally, reserve the inventory.

If order.PaymentDetails are provided, this method also performs the payment and returns the currency and amount actually charged in the Merchant.ResponseInfo.
If additional shipping documents are required for merchants that are shipping the order themselves, then it is indicated in AdditionalRequiredDocuments . In that case, the merchant should delay the fulfillment until the documents are ready and provided to the merchant in the SendAdditionalRequiredDocumentsToMerchant webhook.

Security Requirements

Merchant GUID - In request payload (required)
Custom header (optional)
IP whitelist (optional)
HTTP Basic Authentication (optional)
JWT (optional)

Retry Logic

There is no retry upon a merchant failure response or timeout. The timeout period is 5 minutes but can be adjusted if necessary. Merchant failure responses or timeouts will trigger an alert to the Global-e NOC team for manual review. Requests that fail to initiate from Global-e side will trigger a retry once a minute for up to 3 attempts, after which an alert will trigger for manual review.

Method/URL

POST https://www.merchant-site-domain.com/order-update-create-url

Parameters

Request

Requests can contain more parameters than listed.

Name	Type	Description	Mandatory
order	Object Merchant.Order	Information about the order.

Response

Note

Some values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.

Name	Type	Description	Mandatory
ResponseInfo	Object Merchant.ResponseInfo	Indicates if an API call was successful or not and why.

Objects for SendOrderToMerchant API

Merchant.Order

Parameter Name	Type	Description	Mandatory
`AdditionalRequiredDocuments`	List<orderDocoment>	The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.
`AllowMailsFromMerchant`	Boolean	Indicates if the end customer has opted on the Global‑e checkout page to receive emails from the Merchant. TRUE - Customer opted to receive emails FALSE - Customer did not opt to receive emails
`CartHash`	String	Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for `SendCart` method for the cart converted to this order on Global‑e.	No
`CashOnDeliveryFee`	Decimal	Cash On Delivery fee amount in Merchant’s currency.
`CCFPrice`	Decimal	Customs Clearance Fees (CCF), in the Merchant currency.
`ClearCart`	Boolean	Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site. TRUE - The end customer’s cart must be cleared FALSE - The end customer's cart does not have to be cleare
`CurrencyCode`	String	3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.
`CurrencyName`	String	Customer currency name. Returned by `GetOrdersDetails` API only	No
`Customer`	Object Merchant.Customer	The paying customer’s preferences (Global-e acts as a paying customer).
`CustomerComments`	String	Holds the gift message. In the offline order flow, holds the product comment.
`CustomerComments`	String	Comments text entered by the end customer in Global‑e checkout.	No
`CustomerDTBreakdown`	Object DTBreakdown	Contains the duties and tax parts the customer paid for the order.	No
`DateCreated`	String	Order creation date and time. Returned by `GetOrdersDetails` API only.	No
`DiscountedShippingPrice`	Decimal	The shipping price paid by the customer converted to the Merchant’s currency. Total Shipping price reducing Order Discounts (`InternationalDetails.DiscountedShippingPrice` price converted to the Merchant currency).
`Discounts`	List<Merchant.Discount>	The list of discounts being applied to the order, according to the original list of discounts received in `SendCart` for this order, and to the Merchant shipping configuration on Global‑e.	No
`DoNotChargeVAT`	Boolean	Indicates if the end customer hasn’t been charged VAT in Global‑e checkout, as specified in the `doNotChargeVAT` argument for the `SendCart` method for the cart converted to this order on Global‑e. TRUE - VAT is not charged TRUE - VAT is charged	No
`ExporterDetails.DestinationRegistrationNumber`	Decimal	The Tax reference number of the GE Entity at the destination country. Should only be provided when the order is tax-collected. Otherwise, the field should be Null. The value should be Null if the order destination is for an EU country.
`ExporterDetails.LocalRegistrationClearance`	Boolean	Indicates whether the Merchant can use the destination Registration number. TRUE - Merchant can use destination Registration number (`ExporterDetails.DestinationRegistrationNumber`) FALSE - Merchant cannot use destination Registration number .
`FreeShippingCouponCode`	String	Merchant’s free shipping `CouponCode` applied by the end customer, as specified in the `FreeShippingCouponCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`InternationalDetails`	Object Merchant.InternationalDetails	Details referring to the end customer’s order placed on the Global‑e side. These details apply only to the Merchants dealing with international customers’ support themselves.	No
`IsB2B`	Boolean	Indicates if the order has a Company name and VAT registration number. TRUE - Order contains a company name and VAT registration number FALSE - Order does not contain a company name and VAT registration number
`IsFreeShipping`	Boolean	Indicates if the Merchant offers free international shipping to the end customer, as specified in the `IsFreeShipping` argument for the `SendCart` method for the cart converted to this order on Global‑e. TRUE - Shipping is free. FALSE - Shipping is not free.	No
`IsMoto`	Boolean	Indicates if the the customer is a customer support agent and an “Offline order” took place TRUE - The customer is a customer support agent and an “Offline order” took place FALSE - The customer is a regular customer
`IsReplacementOrder`	Boolean	Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - The order is not a replacement
`IsSplitOrder`	Boolean	Indicates if the order should be handled as a split order (i.e. without consolidation). TRUE - Order will be split FALSE - Order is not to be split	No
`IsTaxExemption`	Boolean	Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - Order does not have a tax exemption
`LoyaltyCode`	String	Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout.	No
`LoyaltyPointsEarned`	Decimal	The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in the `loyaltyPointsEarned` argument for the `SendCart` method for the cart converted to this order on Global-e.	No
`LoyaltyPointsSpent`	Decimal	The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, the “Loyalty points” type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (i.e. on the end user’s My Account page).	No
`Markups`	List<Merchant.Discount>	The list of markups being applied to the order, according to the Merchant shipping configuration on Global‑e. Effectively Markup is a “negative Discount”. The main use case for markups is when the end customer is charged in Global‑e checkout, a flat shipping rate, which is higher than the shipping rate, calculated for the respective order. In this case, Global‑e pays the difference to the Merchant in the form of Markups applied to the order. Unlike Discounts, Markups may be only passed to the Merchant’s back-end ERP system for reconciliation purposes, and may not be displayed to the end customer.	No
`MerchantDTBreakdown`	Object DTBreakdown	Contains the duties and tax parts that the Merchant subsidized for the order.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	No
`ModifiedProduct`	String	Holds the product’s SKU
`OrderCreationSource`	Decimal	One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the OrderCreationSource Table.
`OrderDocuments`	List<OrderDocument>	Always contains a single document - it can be either a VAT Invoice or a Customer Receipt, depends if it is within the EU or not.
`OrderId`	String	Global‑e order unique identifier.
`OrderPaymentMethods`	List<OrderPaymentMethod>	List of payment methods the customer use (Credit card, Gift Cards)
`OrderStatusReason`	Object OrderStatusReason	Reason for the order status, why it was cancelled.
`OriginalOrder`	Object Merchant.OriginalOrder	Details that refer to the original order if the current order is a replacement.	No
`OTCurrencyCode`	String	Currency of the one-time voucher code used to place the order.	No
`OTVoucherAmount`	Decimal	The amount taken off the voucher when applicable.	No
`OTVoucherCode`	String	One-time voucher code used to place the order	No
`Parcels`	List<Merchant.Parcel>	The list of parcels created for the order. Returned by `GetOrdersDetails` API only.	No
`PaymentDetails`	Object Merchant.PaymentDetails	The paying customer’s payment details.
`PrePayOffered`	Boolean	Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.
`PriceCoefficientRate`	Decimal	`CountryCoefficient` rate applied to the prices in this order.
`PrimaryBilling`	Object Merchant.CustomerDetails	The primary customer’s billing details. If `IsEndCustomerPrimary` is set to TRUE, then the primary customer is the payer and his details are indicated in the URL-encoded form.
`PrimaryShipping`	Object Merchant.CustomerDetails	Primary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is TRUE, this field contains the end customers' shipping details. this field contains the Global-e hub's shipping address in the URL-encoded form.
`Products`	List<Merchant.Product>	The list of products being purchased.
`RoundingRate`	Decimal	The average conversion rate applied to the prices paid by the end customer when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.
`SameDayDispatch`	Boolean	Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout. TRUE - Customer requested "Same Day Dispatch" FALSE - Customer did not request "Same Day Dispatch"	No
`SameDayDispatchCost`	Decimal	Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.	No
`SecondaryBilling`	Object Merchant.CustomerDetails	Secondary customer’s billing details. If `Customer.IsEndCustomerPrimary` is FALSE, this contains attributes of the end customer’s details indicated in the URL-encoded form.
`SecondaryShipping`	Object Merchant.CustomerDetails	Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details.
`ShippingMethodCode`	String	Code denoting the local shipping method selected from the list of available shipping options provided in the `shippingOptionsList` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`ShipToStoreCode`	String	Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).
`Subs`	List<Merchant.Order>	Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.
`TotalDutiesAndTaxesPrice`	Decimal	Total Duties & Taxes value including Customs Clearance Fees, in the Merchant currency. This amount is the total amount, regardless of whether the customer or the Merchant paid it.
`TotalDutiesPaidByCustomerPrice`	Decimal	The total amount of duties paid by the customer in the Merchant’s currency.
`UserId`	String	Internal User identifier on the Merchant’s site originally specified in the `shippingDetails`.`UserId`argument for `SendCart` method for the cart converted to this order on Global‑e.	No
`USSalesTax`	Decimal	Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`.
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store, as specified in the `WebStoreCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No

OrderCreationSource

One of the following possible values of OrderCreationSource enumeration denoting a type of discount:

OrderCreationSource Value	Name	Description
0	GECheckout	The default value for orders created in a normal flow via Global‑e Checkout
1	Marketplace	The value for orders that are created at a marketplace and sent to Global-e via your brand

Merchant.ResponseInfo

Parameter Name	Type	Description	Mandatory
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	No
`ErrorCode`	String	Error code to be returned when an error occurs.	No
`InternalOrderId`	String	Order unique identifier on the Merchant’s site	Optional if there was an error, a failure, or if the action is not related to a specific order
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	No
`OrderId`	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the `InternalOrderId`, this identifier is not necessarily unique over time, as the Merchant’s site may potentially reuse it (for example after deleting the old order having the same `OrderId`).	No
`PaymentAmount`	String	The total payment amount in `PaymentCurrency` charged for the order (if payment was processed in the respective API method call).	No
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	Optional if there was an error or failure
`Success`	Boolean	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Examples

Request Sample 1

{
    "ClearCart": true,
    "UserId": null,
    "CurrencyCode": "ILS",
    "Products": [{
            "Attributes": [{
                    "AttributeKey": "color",
                    "AttributeValue": "GREY"
                }
            ],
            "ProductName":"Ribbed Modal Tank Flare Pants Set",
            "Sku": "7290012491726",
            "Price": 21.55,
            "Quantity": 8,
            "VATRate": 18,
            "InternationalPrice": 4.84,
            "CartItemId": "11007",
            "Brand": null,
            "Categories": []
        }
    ],
    "Customer": {
        "EmailAddress": "[email protected]",
        "IsEndCustomerPrimary": false,
        "SendConfirmation": false
    },
    "PrimaryShipping": {
        "FirstName": "GlobalE",
        "LastName": "GlobalE",
        "MiddleName": null,
        "Salutation": null,
        "Company": "GlobalE",
        "Address1": "21/D, Yegi'a Kapayim st. Yellow building - Floor 1",
        "Address2": "Test Address2",
        "City": "Petach Tikva",
        "StateCode": "NN",
        "StateOrProvince": null,
        "Zip": "4913020",
        "Email": "[email protected]",
        "Phone1": " 972 73 204 1384",
        "Phone2": "Test Phone2",
        "Fax": "Test Fax",
        "CountryCode": "IL",
        "CountryName": "Israel",
        "CollectionPointId": "030749"
    },
    "SecondaryShipping": {
        "FirstName": "John",
        "LastName": "Smith",
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": "Amishav%2024",
        "Address2": null,
        "City": "Paris",
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": "66666",
        "Email": "John.Smith%40global-e.com",
        "Phone1": "98756344782",
        "Phone2": null,
        "Fax": null,
        "CountryCode": "FR",
        "CountryName": "France",
        "CollectionPointId": null
    },
    "ShippingMethodCode": "globaleintegration_standard",
    "Discounts": [{
            "Name": "Shipping discount provided by globale",
            "Description": "Auto calculated according to products",
            "Price": 35.31,
            "DiscountType": 2,
            "VATRate": 18,
            "CouponCode": null,
            "InternationalPrice": 6.58
            "MetaData":""
        }
    ],
    "InternationalDetails": {
        "CurrencyCode": "EUR",
        "TotalPrice": 64.88,
        "TransactionCurrencyCode": "EUR",
        "TransactionTotalPrice": 64.88,
        "TotalShippingPrice": 32.74,
        "TotalDutiesPrice": 0,
        "ShippingMethodCode": "2",
        "ShippingMethodName": "EMS",
        "PaymentMethodCode": "1",
        "PaymentMethodName": "Visa",
        "DutiesGuaranteed": false,
        "OrderTrackingNumber": null,
        "OrderTrackingUrl": "http://www.israelpost.co.il/itemtrace.nsf/mainsearch?openform",
        "OrderWaybillNumber": null,
        "OrderWaybillUrl": null,
        "ShippingMethodStatusCode": "0",
        "ShippingMethodStatusName": "undefined",
        "CardNumberLastFourDigits": "7854",
        "ExpirationDate": "2023-06-30",
        "TotalVATAmount": 11.14
    },
    "PaymentDetails": null,
    "PrimaryBilling": {
        "FirstName": "GlobalE",
        "LastName": "GlobalE",
        "MiddleName": null,
        "Salutation": null,
        "Company": "GlobalE",
        "Address1": "21/D, Yegi'a Kapayim st. Yellow building - Floor 1",
        "Address2": null,
        "City": "Petach Tikva",
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": "4913020",
        "Email": "[email protected]",
        "Phone1": " 972 73 204 1384",
        "Phone2": null,
        "Fax": " 972 73 204 1386",
        "CountryCode": "IL",
        "CountryName": "Israel",
        "CollectionPointId": null
    },
    "SecondaryBilling": {
        "FirstName": "John",
        "LastName": "Smith",
        "MiddleName": null,
        "Salutation": null,
        "Company": "GlobalE",
        "Address1": "Amishav%2024",
        "Address2": null,
        "City": "Paris",
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": "66666",
        "Email": "John.Smith%40global-e.com",
        "Phone1": "972500000",
        "Phone2": null,
        "Fax": null,
        "CountryCode": "FR",
        "CountryName": "France",
        "CollectionPointId": null
    },
    "OrderId": "GE927127",
    "StatusCode": "N/A",
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
    "CartId": "9936",
    "MerchantOrderId": null,
    "PriceCoefficientRate": 1,
    "OrderCreationSource": 0,
    "IsMoto": true,
    "ModifiedProduct": "G007163737"
   "AdditionalRequiredDocuments": [
    {
      "DocumentTypeCode": "11 (value from enum)",
          "DocumentTypeName": "EAD",
    },
  ]
}

Request Sample 2

{
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
    "OrderId": "GE12345678GB",
    "CartId": "56004460",
    "UserId": "cecofzj348wdhbr98UbNNDa",
    "CurrencyCode": "GBP",
    "PriceCoefficientRate": 1.340000,
    "RoundingRate": 0.8774285714285714285714285714,
    "UrlParameters":"[{\"Key\":\"associateOrder\",\"Value\":\"false\"}}],
    "OrderCreationDate":"2024-05-29T12:33:08.443",
    "EffectiveFXRate":0.944130024000,
    "WebStoreInstanceCode": "GlobalEDefaultStoreInstance",
    "DiscountedShippingPrice": 8.77,
    "DoNotChargeVAT": false,
    "AllowMailsFromMerchant": true,
    "CustomerComments": null,
    "IsFreeShipping": false,
    "FreeShippingCouponCode": null,
    "ShipToStoreCode": null,
    "InternationalDetails": {
        "CurrencyCode": "USD",
        "TotalPrice": 38.00,
        "TransactionCurrencyCode": "USD",
        "TransactionTotalPrice": 38.0000,
        "TotalShippingPrice": 15.3600,
        "DiscountedShippingPrice": 10.0000,
        "DutiesGuaranteed": false,
        "TotalDutiesPrice": 0.0000,
        "PaymentMethodCode": "1",
        "PaymentMethodName": "Visa",
        "ShippingMethodCode": "608",
        "ShippingMethodName": "DHL Express Worldwide",
        "ShippingMethodTypeCode": "Express",
        "ShippingMethodTypeName": "Express Courier (Air)",
        "PaymentTransactionReference":"89288",
        "DeliveryDaysFrom": 3,
        "DeliveryDaysTo": 4,
        "OrderTrackingNumber": null,
        "OrderTrackingUrl": "https%3a%2f%2fwww2.bglobale.com%2fOrder%2fTrack%2fmZyd%3fOrderId%3dGE4874348GB%26ShippingEmail%3djsmith%40merchant.com",
        "CardNumberLastFourDigits": "7854",
        "ExpirationDate": "2023-06-18"
    },
    "Products": [{
            "CartItemId": "10367295488044",
            "Sku": "2410016114",
            "Price": 30.7100,
            "Quantity": 1,
            "VATRate": 20.000000,
            "InternationalPrice": 35.0000,
            "RoundingRate": 0.8774285714285714285714285714,
            "IsBackOrdered": false,
            "BackOrderDate": null,
            "DiscountedPrice": 24.57,
            "InternationalDiscountedPrice": 28.0000,
            "GenericHSCode":"392800",
            "GiftMessage": null,
            "MetaData": {
                "Attributes": [{
                        "AttributeKey": "giftnotemessage",
                        "AttributeValue": "Hello, world"
                    }, {
                        "AttributeKey": "giftnotefont",
                        "AttributeValue": "FONTTYPE1"
                    }, {
                        "AttributeKey": "WRTY",
                        "AttributeValue": "Warranty card"
                    }
                ]
            }
        }
    ],
    "Discounts": [{
            "DiscountType": 1,
            "Name": "20% off",
            "Description": "20% off all non-sale items.",
            "Price": 6.1400,
            "VATRate": 20.000000,
            "InternationalPrice": 7.0000,
            "CouponCode": "GO20",
            "DiscountCode": "Email_Sign_up-20%_off",
            "ProductCartItemId": "10367295488044",
            "LoyaltyVoucherCode": null
        }, {
            "DiscountType": 2,
            "Name": "Shipping discount for fixed price",
            "Description": "Shipping discount provided 
                            from fixed price range 24663",
            "Price": 4.7000,
            "VATRate": 20.000000,
            "InternationalPrice": 5.3600,
            "CouponCode": null,
            "DiscountCode": null,
            "ProductCartItemId": null,
            "LoyaltyVoucherCode": null
        }
    ],
    "PrimaryShipping": {
        "FirstName": "Jenny",
        "LastName": "Smith",
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": "12+E+11th+St",
        "Address2": null,
        "City": "New+York",
        "StateCode": "NY",
        "StateOrProvince": "New York",
        "Zip": "10003",
        "Email": "jsmith%40merchant.com",
        "Phone1": "0123456789",
        "Fax": null,
        "CountryCode": "US",
        "CountryCode3": "USA",
        "CountryName": "United States"
    },
    "SecondaryShipping": {
        "FirstName": "GlobalE",
        "LastName": "East Midlands Airport",
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": "96a, Beverley Road",
        "Address2": "East Midlands Airport\r\nGE12345678GB",
        "City": "Derby",
        "StateCode": "NN",
        "StateOrProvince": null,
        "Zip": "DE74 2SA",
        "Email": "[email protected]",
        "Phone1": "01332 818723",
        "Fax": null,
        "CountryCode": "GB",
        "CountryCode3": "GBR",
        "CountryName": "United Kingdom"
    },
    "PrimaryBilling": {
        "FirstName": "Jenny",
        "LastName": "Smith",
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": "12+E+11th+St",
        "Address2": null,
        "City": "New+York",
        "StateCode": "NY",
        "StateOrProvince": "New York",
        "Zip": "10003",
        "Email": "jsmith%40merchant.com",
        "Phone1": "0123456789",
        "Fax": null,
        "CountryCode": "US",
        "CountryCode3": "USA",
        "CountryName": "United+States"
    },
    "SecondaryBilling": {
        "FirstName": "GlobalE",
        "LastName": "UK Limited",
        "MiddleName": null,
        "Salutation": null,
        "Company": "GlobalE",
        "Address1": "45 Leather Lane",
        "Address2": null,
        "City": "London",
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": "EC1N 7TJ",
        "Email": "[email protected]",
        "Phone1": "+ 44 (0)808 258 0300",
        "Fax": "+ 44 (0)203 514 7171",
        "CountryCode": "GB",
        "CountryCode3": "GBR",
        "CountryName": "United Kingdom"
    },
  "OrderPaymentMethods":[
    {
      "PaymentMethodGuid":"23ATEM329IF9493",
      "IsGiftCard":false,
      "GiftCardFields":null,
    }],
  "AdditionalRequiredDocuments": [
    {
        "DocumentTypeCode": "11",
         "DocumentTypeName": "EAD",
    }
   ]
}

UpdateOrderStatus (Global-e to Merchant)

Updates the order status on the merchant's site. Only order.OrderId and order.StatusCode members are mandatory for this method.

This method is required to support order cancellation when initiated on Global-e’s side. It can also be used for reporting other order status updates as they occur in the Global-e’s system, and reflect them in the Merchant’s system.

Security Requirements

Merchant GUID - In request payload (required)
Custom header (optional)
IP whitelist (optional)
HTTP Basic Authentication (optional)
JWT (optional)

Retry Logic

No automatic retries are attempted. A manual retry can be done by the Global-e support team.

Method/URL

POST https://www.merchant-site-domain.com/order-status-update-only-url

Parameters

Requests can contain more parameters than listed.

Request

Name	Type	Description	Mandatory
order	Object Merchant.Order	`Merchant.Order` objects contain information about orders.	Yes

Response

Note

Some values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.

Name	Type	Description
ResponseInfo	Object Merchant.ResponseInfo	Indicates if the API call was successful or not and why.

Objects for UpdateOrderStatus API

Merchant.Order

Parameter Name	Type	Description	Mandatory
`AdditionalRequiredDocuments`	List<orderDocoment>	The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.
`AllowMailsFromMerchant`	Boolean	Indicates if the end customer has opted on the Global‑e checkout page to receive emails from the Merchant. TRUE - Customer opted to receive emails FALSE - Customer did not opt to receive emails
`CartHash`	String	Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for `SendCart` method for the cart converted to this order on Global‑e.	No
`CashOnDeliveryFee`	Decimal	Cash On Delivery fee amount in Merchant’s currency.
`CCFPrice`	Decimal	Customs Clearance Fees (CCF), in the Merchant currency.
`ClearCart`	Boolean	Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site. TRUE - The end customer’s cart must be cleared FALSE - The end customer's cart does not have to be cleare
`CurrencyCode`	String	3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.
`CurrencyName`	String	Customer currency name. Returned by `GetOrdersDetails` API only	No
`Customer`	Object Merchant.Customer	The paying customer’s preferences (Global-e acts as a paying customer).
`CustomerComments`	String	Holds the gift message. In the offline order flow, holds the product comment.
`CustomerComments`	String	Comments text entered by the end customer in Global‑e checkout.	No
`CustomerDTBreakdown`	Object DTBreakdown	Contains the duties and tax parts the customer paid for the order.	No
`DateCreated`	String	Order creation date and time. Returned by `GetOrdersDetails` API only.	No
`DiscountedShippingPrice`	Decimal	The shipping price paid by the customer converted to the Merchant’s currency. Total Shipping price reducing Order Discounts (`InternationalDetails.DiscountedShippingPrice` price converted to the Merchant currency).
`Discounts`	List<Merchant.Discount>	The list of discounts being applied to the order, according to the original list of discounts received in `SendCart` for this order, and to the Merchant shipping configuration on Global‑e.	No
`DoNotChargeVAT`	Boolean	Indicates if the end customer hasn’t been charged VAT in Global‑e checkout, as specified in the `doNotChargeVAT` argument for the `SendCart` method for the cart converted to this order on Global‑e. TRUE - VAT is not charged TRUE - VAT is charged	No
`ExporterDetails.DestinationRegistrationNumber`	Decimal	The Tax reference number of the GE Entity at the destination country. Should only be provided when the order is tax-collected. Otherwise, the field should be Null. The value should be Null if the order destination is for an EU country.
`ExporterDetails.LocalRegistrationClearance`	Boolean	Indicates whether the Merchant can use the destination Registration number. TRUE - Merchant can use destination Registration number (`ExporterDetails.DestinationRegistrationNumber`) FALSE - Merchant cannot use destination Registration number .
`FreeShippingCouponCode`	String	Merchant’s free shipping `CouponCode` applied by the end customer, as specified in the `FreeShippingCouponCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`InternationalDetails`	Object Merchant.InternationalDetails	Details referring to the end customer’s order placed on the Global‑e side. These details apply only to the Merchants dealing with international customers’ support themselves.	No
`IsB2B`	Boolean	Indicates if the order has a Company name and VAT registration number. TRUE - Order contains a company name and VAT registration number FALSE - Order does not contain a company name and VAT registration number
`IsFreeShipping`	Boolean	Indicates if the Merchant offers free international shipping to the end customer, as specified in the `IsFreeShipping` argument for the `SendCart` method for the cart converted to this order on Global‑e. TRUE - Shipping is free. FALSE - Shipping is not free.	No
`IsMoto`	Boolean	Indicates if the the customer is a customer support agent and an “Offline order” took place TRUE - The customer is a customer support agent and an “Offline order” took place FALSE - The customer is a regular customer
`IsReplacementOrder`	Boolean	Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - The order is not a replacement
`IsSplitOrder`	Boolean	Indicates if the order should be handled as a split order (i.e. without consolidation). TRUE - Order will be split FALSE - Order is not to be split	No
`IsTaxExemption`	Boolean	Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - Order does not have a tax exemption
`LoyaltyCode`	String	Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout.	No
`LoyaltyPointsEarned`	Decimal	The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in the `loyaltyPointsEarned` argument for the `SendCart` method for the cart converted to this order on Global-e.	No
`LoyaltyPointsSpent`	Decimal	The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, the “Loyalty points” type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (i.e. on the end user’s My Account page).	No
`Markups`	List<Merchant.Discount>	The list of markups being applied to the order, according to the Merchant shipping configuration on Global‑e. Effectively Markup is a “negative Discount”. The main use case for markups is when the end customer is charged in Global‑e checkout, a flat shipping rate, which is higher than the shipping rate, calculated for the respective order. In this case, Global‑e pays the difference to the Merchant in the form of Markups applied to the order. Unlike Discounts, Markups may be only passed to the Merchant’s back-end ERP system for reconciliation purposes, and may not be displayed to the end customer.	No
`MerchantDTBreakdown`	Object DTBreakdown	Contains the duties and tax parts that the Merchant subsidized for the order.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	No
`ModifiedProduct`	String	Holds the product’s SKU
`OrderCreationSource`	Decimal	One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the OrderCreationSource Table.
`OrderDocuments`	List<OrderDocument>	Always contains a single document - it can be either a VAT Invoice or a Customer Receipt, depends if it is within the EU or not.
`OrderId`	String	Global‑e order unique identifier.
`OrderPaymentMethods`	List<OrderPaymentMethod>	List of payment methods the customer use (Credit card, Gift Cards)
`OrderStatusReason`	Object OrderStatusReason	Reason for the order status, why it was cancelled.
`OriginalOrder`	Object Merchant.OriginalOrder	Details that refer to the original order if the current order is a replacement.	No
`OTCurrencyCode`	String	Currency of the one-time voucher code used to place the order.	No
`OTVoucherAmount`	Decimal	The amount taken off the voucher when applicable.	No
`OTVoucherCode`	String	One-time voucher code used to place the order	No
`Parcels`	List<Merchant.Parcel>	The list of parcels created for the order. Returned by `GetOrdersDetails` API only.	No
`PaymentDetails`	Object Merchant.PaymentDetails	The paying customer’s payment details.
`PrePayOffered`	Boolean	Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.
`PriceCoefficientRate`	Decimal	`CountryCoefficient` rate applied to the prices in this order.
`PrimaryBilling`	Object Merchant.CustomerDetails	The primary customer’s billing details. If `IsEndCustomerPrimary` is set to TRUE, then the primary customer is the payer and his details are indicated in the URL-encoded form.
`PrimaryShipping`	Object Merchant.CustomerDetails	Primary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is TRUE, this field contains the end customers' shipping details. this field contains the Global-e hub's shipping address in the URL-encoded form.
`Products`	List<Merchant.Product>	The list of products being purchased.
`RoundingRate`	Decimal	The average conversion rate applied to the prices paid by the end customer when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.
`SameDayDispatch`	Boolean	Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout. TRUE - Customer requested "Same Day Dispatch" FALSE - Customer did not request "Same Day Dispatch"	No
`SameDayDispatchCost`	Decimal	Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.	No
`SecondaryBilling`	Object Merchant.CustomerDetails	Secondary customer’s billing details. If `Customer.IsEndCustomerPrimary` is FALSE, this contains attributes of the end customer’s details indicated in the URL-encoded form.
`SecondaryShipping`	Object Merchant.CustomerDetails	Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details.
`ShippingMethodCode`	String	Code denoting the local shipping method selected from the list of available shipping options provided in the `shippingOptionsList` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`ShipToStoreCode`	String	Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).
`Subs`	List<Merchant.Order>	Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.
`TotalDutiesAndTaxesPrice`	Decimal	Total Duties & Taxes value including Customs Clearance Fees, in the Merchant currency. This amount is the total amount, regardless of whether the customer or the Merchant paid it.
`TotalDutiesPaidByCustomerPrice`	Decimal	The total amount of duties paid by the customer in the Merchant’s currency.
`UserId`	String	Internal User identifier on the Merchant’s site originally specified in the `shippingDetails`.`UserId`argument for `SendCart` method for the cart converted to this order on Global‑e.	No
`USSalesTax`	Decimal	Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`.
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store, as specified in the `WebStoreCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No

OrderCreationSource

One of the following possible values of OrderCreationSource enumeration denoting a type of discount:

OrderCreationSource Value	Name	Description
0	GECheckout	The default value for orders created in a normal flow via Global‑e Checkout
1	Marketplace	The value for orders that are created at a marketplace and sent to Global-e via your brand

Merchant.ResponseInfo

Parameter Name	Type	Description	Mandatory
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	No
`ErrorCode`	String	Error code to be returned when an error occurs.	No
`InternalOrderId`	String	Order unique identifier on the Merchant’s site	Optional if there was an error, a failure, or if the action is not related to a specific order
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	No
`OrderId`	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the `InternalOrderId`, this identifier is not necessarily unique over time, as the Merchant’s site may potentially reuse it (for example after deleting the old order having the same `OrderId`).	No
`PaymentAmount`	String	The total payment amount in `PaymentCurrency` charged for the order (if payment was processed in the respective API method call).	No
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	Optional if there was an error or failure
`Success`	Boolean	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Request Body

{
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
    "OrderId": "GE123874638GB",
    "MerchantOrderId": "14123332",
    "StatusCode": "canceled"
}

PerformOrderPayment (Global-e to Merchant)

Note

This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required.

Posts order payment details to the Merchant's site and perform the payment.

Only order.OrderId and order.PaymentDetails classes are mandatory for this method. For Mixed orders, "Subs" is mandatory.

SecurityRequirements

Merchant GUID - In request payload (required)
Custom header (optional)
IP whitelist (optional)
HTTP Basic Authentication (optional)
JWT (optional)

Retry Logic

There is no retry upon a merchant failure response or timeout. The timeout period is 5 minutes and this cannot be adjusted. Requests that fail to initiate from Global-e side will trigger an alert to the Global-e NOC team for manual review. Merchant failure responses or timeouts will trigger an alert to the Global-e NOC team for manual review. Requests that fail to initiate from Global-e side will trigger a retry once a minute for up to 3 attempts after which an alert will trigger for manual review.

Method/URL

POST https://www.merchant-site-domain.com/order-payment-only-url

Parameters

Request

Requests can contain more parameters than listed.

Note

Some response values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.

Name	Type	Description	Mandatory
order	Object Merchant.Order	`Merchant.Order` objects contain information about orders.	Yes

Objects for PerformOrderPayment API

Merchant.Order

Parameter Name	Type	Description	Mandatory
`AdditionalRequiredDocuments`	List<orderDocoment>	The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.
`AllowMailsFromMerchant`	Boolean	Indicates if the end customer has opted on the Global‑e checkout page to receive emails from the Merchant. TRUE - Customer opted to receive emails FALSE - Customer did not opt to receive emails
`CartHash`	String	Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for `SendCart` method for the cart converted to this order on Global‑e.	No
`CashOnDeliveryFee`	Decimal	Cash On Delivery fee amount in Merchant’s currency.
`CCFPrice`	Decimal	Customs Clearance Fees (CCF), in the Merchant currency.
`ClearCart`	Boolean	Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site. TRUE - The end customer’s cart must be cleared FALSE - The end customer's cart does not have to be cleare
`CurrencyCode`	String	3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.
`CurrencyName`	String	Customer currency name. Returned by `GetOrdersDetails` API only	No
`Customer`	Object Merchant.Customer	The paying customer’s preferences (Global-e acts as a paying customer).
`CustomerComments`	String	Holds the gift message. In the offline order flow, holds the product comment.
`CustomerComments`	String	Comments text entered by the end customer in Global‑e checkout.	No
`CustomerDTBreakdown`	Object DTBreakdown	Contains the duties and tax parts the customer paid for the order.	No
`DateCreated`	String	Order creation date and time. Returned by `GetOrdersDetails` API only.	No
`DiscountedShippingPrice`	Decimal	The shipping price paid by the customer converted to the Merchant’s currency. Total Shipping price reducing Order Discounts (`InternationalDetails.DiscountedShippingPrice` price converted to the Merchant currency).
`Discounts`	List<Merchant.Discount>	The list of discounts being applied to the order, according to the original list of discounts received in `SendCart` for this order, and to the Merchant shipping configuration on Global‑e.	No
`DoNotChargeVAT`	Boolean	Indicates if the end customer hasn’t been charged VAT in Global‑e checkout, as specified in the `doNotChargeVAT` argument for the `SendCart` method for the cart converted to this order on Global‑e. TRUE - VAT is not charged TRUE - VAT is charged	No
`ExporterDetails.DestinationRegistrationNumber`	Decimal	The Tax reference number of the GE Entity at the destination country. Should only be provided when the order is tax-collected. Otherwise, the field should be Null. The value should be Null if the order destination is for an EU country.
`ExporterDetails.LocalRegistrationClearance`	Boolean	Indicates whether the Merchant can use the destination Registration number. TRUE - Merchant can use destination Registration number (`ExporterDetails.DestinationRegistrationNumber`) FALSE - Merchant cannot use destination Registration number .
`FreeShippingCouponCode`	String	Merchant’s free shipping `CouponCode` applied by the end customer, as specified in the `FreeShippingCouponCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`InternationalDetails`	Object Merchant.InternationalDetails	Details referring to the end customer’s order placed on the Global‑e side. These details apply only to the Merchants dealing with international customers’ support themselves.	No
`IsB2B`	Boolean	Indicates if the order has a Company name and VAT registration number. TRUE - Order contains a company name and VAT registration number FALSE - Order does not contain a company name and VAT registration number
`IsFreeShipping`	Boolean	Indicates if the Merchant offers free international shipping to the end customer, as specified in the `IsFreeShipping` argument for the `SendCart` method for the cart converted to this order on Global‑e. TRUE - Shipping is free. FALSE - Shipping is not free.	No
`IsMoto`	Boolean	Indicates if the the customer is a customer support agent and an “Offline order” took place TRUE - The customer is a customer support agent and an “Offline order” took place FALSE - The customer is a regular customer
`IsReplacementOrder`	Boolean	Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - The order is not a replacement
`IsSplitOrder`	Boolean	Indicates if the order should be handled as a split order (i.e. without consolidation). TRUE - Order will be split FALSE - Order is not to be split	No
`IsTaxExemption`	Boolean	Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - Order does not have a tax exemption
`LoyaltyCode`	String	Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout.	No
`LoyaltyPointsEarned`	Decimal	The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in the `loyaltyPointsEarned` argument for the `SendCart` method for the cart converted to this order on Global-e.	No
`LoyaltyPointsSpent`	Decimal	The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, the “Loyalty points” type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (i.e. on the end user’s My Account page).	No
`Markups`	List<Merchant.Discount>	The list of markups being applied to the order, according to the Merchant shipping configuration on Global‑e. Effectively Markup is a “negative Discount”. The main use case for markups is when the end customer is charged in Global‑e checkout, a flat shipping rate, which is higher than the shipping rate, calculated for the respective order. In this case, Global‑e pays the difference to the Merchant in the form of Markups applied to the order. Unlike Discounts, Markups may be only passed to the Merchant’s back-end ERP system for reconciliation purposes, and may not be displayed to the end customer.	No
`MerchantDTBreakdown`	Object DTBreakdown	Contains the duties and tax parts that the Merchant subsidized for the order.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	No
`ModifiedProduct`	String	Holds the product’s SKU
`OrderCreationSource`	Decimal	One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the OrderCreationSource Table.
`OrderDocuments`	List<OrderDocument>	Always contains a single document - it can be either a VAT Invoice or a Customer Receipt, depends if it is within the EU or not.
`OrderId`	String	Global‑e order unique identifier.
`OrderPaymentMethods`	List<OrderPaymentMethod>	List of payment methods the customer use (Credit card, Gift Cards)
`OrderStatusReason`	Object OrderStatusReason	Reason for the order status, why it was cancelled.
`OriginalOrder`	Object Merchant.OriginalOrder	Details that refer to the original order if the current order is a replacement.	No
`OTCurrencyCode`	String	Currency of the one-time voucher code used to place the order.	No
`OTVoucherAmount`	Decimal	The amount taken off the voucher when applicable.	No
`OTVoucherCode`	String	One-time voucher code used to place the order	No
`Parcels`	List<Merchant.Parcel>	The list of parcels created for the order. Returned by `GetOrdersDetails` API only.	No
`PaymentDetails`	Object Merchant.PaymentDetails	The paying customer’s payment details.
`PrePayOffered`	Boolean	Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.
`PriceCoefficientRate`	Decimal	`CountryCoefficient` rate applied to the prices in this order.
`PrimaryBilling`	Object Merchant.CustomerDetails	The primary customer’s billing details. If `IsEndCustomerPrimary` is set to TRUE, then the primary customer is the payer and his details are indicated in the URL-encoded form.
`PrimaryShipping`	Object Merchant.CustomerDetails	Primary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is TRUE, this field contains the end customers' shipping details. this field contains the Global-e hub's shipping address in the URL-encoded form.
`Products`	List<Merchant.Product>	The list of products being purchased.
`RoundingRate`	Decimal	The average conversion rate applied to the prices paid by the end customer when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.
`SameDayDispatch`	Boolean	Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout. TRUE - Customer requested "Same Day Dispatch" FALSE - Customer did not request "Same Day Dispatch"	No
`SameDayDispatchCost`	Decimal	Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.	No
`SecondaryBilling`	Object Merchant.CustomerDetails	Secondary customer’s billing details. If `Customer.IsEndCustomerPrimary` is FALSE, this contains attributes of the end customer’s details indicated in the URL-encoded form.
`SecondaryShipping`	Object Merchant.CustomerDetails	Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details.
`ShippingMethodCode`	String	Code denoting the local shipping method selected from the list of available shipping options provided in the `shippingOptionsList` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`ShipToStoreCode`	String	Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).
`Subs`	List<Merchant.Order>	Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.
`TotalDutiesAndTaxesPrice`	Decimal	Total Duties & Taxes value including Customs Clearance Fees, in the Merchant currency. This amount is the total amount, regardless of whether the customer or the Merchant paid it.
`TotalDutiesPaidByCustomerPrice`	Decimal	The total amount of duties paid by the customer in the Merchant’s currency.
`UserId`	String	Internal User identifier on the Merchant’s site originally specified in the `shippingDetails`.`UserId`argument for `SendCart` method for the cart converted to this order on Global‑e.	No
`USSalesTax`	Decimal	Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`.
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store, as specified in the `WebStoreCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No

OrderCreationSource

One of the following possible values of OrderCreationSource enumeration denoting a type of discount:

OrderCreationSource Value	Name	Description
0	GECheckout	The default value for orders created in a normal flow via Global‑e Checkout
1	Marketplace	The value for orders that are created at a marketplace and sent to Global-e via your brand

Examples

Request (

{
    "OrderId": "00010000100000000020",
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
    "PaymentDetails": {
        "OwnerFirstName": "Nir",
        "OwnerLastName": "Debbi",
        "OwnerName": "GlobalE",
        "CardNumber": "0000-0000-0000-0000",
        "CVVNumber": "000",
        "PaymentMethodName": "Visa",
        "PaymentMethodCode": "VI",
        "PaymentMethodTypeCode": "cc",
        "ExpirationDate": "2016-10-31",
        "CountryName": "Israel",
        "CountryCode": "IL",
        "StateOrProvince": "",
        "City": "Petach Tikva",
        "Zip": "12345",
        "Address1": "Kiryat Arye",
        "Address2": "",
        "Phone1": "",
        "Phone2": "",
        "Fax": "",
        "Email": ""
    }
}

Response Example

  {
  "AllowMailsFromMerchant":false,
  "AllowSMSFromMerchant":null,
  "AllowDirectCommunicationFromMerchant":null,
  "ReservationRequestId":null,
  "ClearCart":false,
  "CurrencyCode":null,
  "Customer":{
    "EmailAddress":null,
    "IsEndCustomerPrimary":false,
    "SendConfirmation":false
  },
  "CustomerComments":null,
  "Discounts":[
  ],
  "DoNotChargeVAT":false,
  "FreeShippingCouponCode":null,
  "IsFreeShipping":false,
  "IsSplitOrder":false,
  "LoyaltyCode":null,
  "LoyaltyPointsEarned":null,
  "LoyaltyPointsSpent":null,
  "Markups":[
  ],
  "OriginalMerchantTotalProductsDiscountedPrice":0.0,
  "OTVoucherAmount":null,
  "OTVoucherCode":null,
  "OTVoucherCurrencyCode":null,
  "InitialCheckoutCultureCode":null,
  "CultureCode":null,
  "HubId":null,
  "HubCode":null,
  "PrimaryShipping":{
    "Address1":null,
    "Address2":null,
    "AddressBookId":null,
    "City":null,
    "Company":null,
    "CountryCode":null,
    "CountryCode3":null,
    "CountryName":null,
    "Email":null,
    "Fax":null,
    "FirstName":null,
    "LastName":null,
    "MiddleName":null,
    "Phone1":null,
    "Phone2":null,
    "Salutation":null,
    "StateCode":null,
    "StateOrProvince":null,
    "Zip":null,
    "CollectionPointId":null,
    "AddressBookName":null,
    "CustomerTaxId":null
  },
  "Products":[
  ],
  "RoundingRate":0.0,
  "SameDayDispatch":false,
  "SameDayDispatchCost":0.0,
  "SecondaryShipping":{
    "Address1":null,
    "Address2":null,
    "AddressBookId":null,
    "City":null,
    "Company":null,
    "CountryCode":null,
    "CountryCode3":null,
    "CountryName":null,
    "Email":null,
    "Fax":null,
    "FirstName":null,
    "LastName":null,
    "MiddleName":null,
    "Phone1":null,
    "Phone2":null,
    "Salutation":null,
    "StateCode":null,
    "StateOrProvince":null,
    "Zip":null,
    "CollectionPointId":null,
    "AddressBookName":null,
    "CustomerTaxId":null
  },
  "ShippingMethodCode":null,
  "ShipToStoreCode":null,
  "UrlParameters":null,
  "IsReplacementOrder":false,
  "OriginalOrder":null,
  "TotalDutiesAndTaxesPrice":0.0,
  "CCFPrice":0.0,
  "UserId":null,
  "GiftCards":[
  ],
  "PreferredCultureCode":null,
  "ShippingVATRate":null,
  "OrderPaymentMethods":[
    {
      "PaymentMethodId":1,
      "PaymentMethodName":"Visa",
      "IsGiftCard":false,
      "GiftCardFields":null,
      "PaidAmountInCustomerCurrency":393.5600,
      "PaidAmountInMerchantCurrency":235.74993308058803207162312511,
      "PaymentMethodTypeCode":"1",
      "PaymentMethodTypeName":"Credit Card"
    }],
  "CustomerDTBreakdown":null,
  "MerchantDTBreakdown":null,
  "TotalDutiesPaidByCustomerPrice":null,
  "CookieConsent":0,
  "IsMoto":false,
  "ModifiedProduct":null,
  "TaxCalculationRule":"CIF",
  "TotalValueForCustoms":393.5600,
  "USSalesTax":0.0,
  "ImporterDetails":null,
  "PaymentDetails":{
    "Address1":"200 west 41st street",
    "Address2":"9th floor",
    "CardNumber":null,
    "City":"New York",
    "CountryCode":"US",
    "CountryCode3":"USA",
    "CountryName":"United States",
    "CVVNumber":null,
    "Email":"[email protected]",
    "ExpirationDate":"2040-09-22",
    "Fax":null,
    "OwnerFirstName":"Global-e",
    "OwnerLastName":"US Inc.",
    "OwnerName":"Global-e US Inc.",
    "PaymentMethodCode":"OT",
    "PaymentMethodName":"Undefined",
    "PaymentMethodTypeCode":"globaleintegration",
    "Phone1":"+1 (212) 634-3952",
    "Phone2":null,
    "StateCode":"NY",
    "StateOrProvince":"New York",
    "Zip":"10036"
  },
  "PrimaryBilling":{
    "Address1":"t",
    "Address2":null,
    "AddressBookId":null,
    "City":"t",
    "Company":null,
    "CountryCode":"NZ",
    "CountryCode3":"NZL",
    "CountryName":"New+Zealand",
    "Email":"[email protected]",
    "Fax":null,
    "FirstName":"FirstName",
    "LastName":"LastName",
    "MiddleName":null,
    "Phone1":"2125551212",
    "Phone2":null,
    "Salutation":null,
    "StateCode":null,
    "StateOrProvince":null,
    "Zip":"2345",
    "CollectionPointId":null,
    "AddressBookName":null,
    "CustomerTaxId":null
  },
  "SecondaryBilling":{
    "Address1":"200 west 41st street",
    "Address2":"9th floor",
    "AddressBookId":null,
    "City":"New York",
    "Company":"GlobalE",
    "CountryCode":"US",
    "CountryCode3":"USA",
    "CountryName":"United States",
    "Email":"[email protected]",
    "Fax":null,
    "FirstName":"Global-e",
    "LastName":"US Inc.",
    "MiddleName":null,
    "Phone1":"+1 (212) 634-3952",
    "Phone2":null,
    "Salutation":null,
    "StateCode":"NY",
    "StateOrProvince":"New York",
    "Zip":"10036",
    "CollectionPointId":null,
    "AddressBookName":null,
    "CustomerTaxId":null
  },
  "CartHash":"3A29A654B1A5DD8D758D19C827B69E83",
  "CartToken":null,
  "GlobalECartToken":null,
  "CartId":"f9847639-95e8-4e75-b198-9031a205e001:384880634",
  "DiscountedShippingPrice":221.15,
  "InternationalDetails":{
    "ConsignmentFee":0.0000,
    "CurrencyCode":"NZD",
    "DeliveryDaysFrom":9,
    "DeliveryDaysTo":15,
    "DiscountedShippingPrice":369.1900,
    "DutiesGuaranteed":false,
    "OrderTrackingNumber":null,
    "OrderTrackingUrl":"https%3a%2f%2fwww.bglobale.com%2fOrder%2fTrack%2fmZz5%3fOrderId%3dGE01812420US%26ShippingEmail%3dtest%40test.com",
    "OrderWaybillNumber":null,
    "PaymentMethodCode":"1",
    "PaymentMethodName":"Visa",
    "RemoteAreaSurcharge":0.0000,
    "SameDayDispatchCost":0.0000,
    "ShippingMethodCode":"40049745",
    "ShippingMethodName":"DHL api Express Worldwide",
    "ShippingMethodTypeCode":"Express",
    "ShippingMethodTypeName":"Express Courier (Air)",
    "SizeOverchargeValue":17.0000,
    "TotalCCFPrice":0.0000,
    "TotalDutiesPrice":0.000000000,
    "TotalPrice":393.56,
    "TotalShippingPrice":369.1900,
    "TransactionCurrencyCode":"NZD",
    "TransactionTotalPrice":393.5600,
    "ParcelsTracking":null,
    "CardNumberLastFourDigits":null,
    "ExpirationDate":null,
    "ShippingVATRate":0.0000,
    "CashOnDeliveryFee":0.0,
    "CustomerDTBreakdown":null,
    "MerchantDTBreakdown":null,
    "DeliveryDateFrom":"25.03",
    "DeliveryDateTo":"04.04",
    "ShipmentLocation":null,
    "ShipmentStatusUpdateTime":null,
    "ShippingMethodStatusCode":"Undefined",
    "ShippingMethodStatusName":"undefined"
  },
  "MerchantGUID":"12345678-1234-1234-1234-123456789012",
  "MerchantOrderId":"123456789",
  "OrderId":"GE01812420US",
  "PriceCoefficientRate":1.150000,
  "StatusCode":"N/A",
  "WebStoreCode":"en-nz",
  "WebStoreInstanceCode":"en-nz"
}

Documentation Portal

Endpoints: Merchant APIs

Special Features and Requirements

GetCheckoutCartInfo (Global-e to Merchant)

Note

Parameters

Note

Objects for GetCheckoutCartInfo API

CheckoutCartInfo

Examples

SendOrderToMerchant (Global-e to Merchant)

Note

Parameters

Note

Objects for SendOrderToMerchant API

Merchant.Order

Merchant.ResponseInfo

Examples

UpdateOrderStatus (Global-e to Merchant)

Parameters

Note

Objects for UpdateOrderStatus API

Merchant.Order

Merchant.ResponseInfo

Request Body

PerformOrderPayment (Global-e to Merchant)

Note

Parameters

Note

Objects for PerformOrderPayment API

Merchant.Order

Examples

Search results