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 API.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
Overview
The 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.
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
Totals on the basket page
Open checkout
Validate order (SendOrderToMerchant)
Security
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:
Cart token - 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.
Sample URL
https://www.merchant-site-domain.com/get-checkout-cart-info-url
Parameters
Request Body Parameters
GetCheckoutCartInfo
(string merchantCartToken
, string countryCode
)
Name | Type | Description | Mandatory (Y/) |
---|---|---|---|
| String | 2-char ISO code for the country to which shipped | N |
| String | 3-char currency code for the country to which shipped | N |
| String | Identifier used for the cart by the Merchant’s site | N |
Return Body Parameters
The GetCheckoutCartInfo
API returns all cart contents, including customer information for logged-in customers.
Name | Type | Description |
---|---|---|
| Class | Object with billing details |
| Class | Object with details about discounts |
| Class | Object with products' details |
| Class | Object with shipping details |
Examples
Response Body
Sample 1
Response is 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 } ] }
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": "" } }
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": "" } }
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 }
Classes related to GetCheckoutCartInfo
SendOrderToMerchant
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.
SendOrderToMerchant
( Merchant.Orderorder
)
Description
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, to clear the user’s basket, and optionally, to 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 fulfilment until the documents are ready and provided to the Merchant in the SendAdditionalRequiredDocumentsToMerchant
webhook.
Method POST
Security
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.
Sample
Body
{ "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", }, ] }
Sample URL:
https://www.merchant-site-domain.com/order-update-create-url
Accepts
Merchant.Order order
Returns
Merchant.ResponseInfo
class
Sample Request
{ "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
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.
UpdateOrderStatus (Merchant.Order order)
Method POST
Security
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.
Accepts
Merchant.Order order
Returns
Merchant.ResponseInfo class
Sample URL
https://www.merchant-site-domain.com/order-status-update-only-url
Request Body
{ "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd", "OrderId": "GE123874638GB", "MerchantOrderId": "14123332", "StatusCode": "canceled" }
PerformOrderPayment
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
members are mandatory for this method. For Mixed orders, "Subs" is mandatory.
PerformOrderPayment
( Merchant.Order order
)
Method POST
Security
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.
URL
https://www.merchant-site-domain.com/order-payment-only-url
Sample
Request Body
{ "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 Body
{ "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" }