Send Order To Merchant
Global-e posts a new order (or updates an existing order) to a merchant-hosted endpoint via the SendOrderToMerchant (Global-e to Merchant) API.
PaymentDetails are provided, it also performs the payment and returns the currency and amount actually charged in the ResponseInfo.
AdditionalRequiredDocuments. In that case, delay fulfilment until the documents are ready and provided 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.Body
Information about the order. Requests can contain more parameters than listed.
Unique identifier of the Merchant on Global-e.
Global-e order unique identifier.
The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.
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.
Cart hash originally specified in the merchantCartHash argument for the SendCart method for the cart converted to this order on Global-e.
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.
Cash On Delivery fee amount in Merchant's currency.
Customs Clearance Fees (CCF), in the Merchant currency.
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 cleared.
3-char ISO currency code for the order being posted. By default, this is set to the original Merchant's currency.
Customer currency name. Returned by GetOrdersDetails API only.
The paying customer's preferences (Global-e acts as a paying customer).
Holds the gift message. In the offline order flow, holds the product comment. (The page also lists a second CustomerComments row: "Comments text entered by the end customer in Global-e checkout." See review §2.)
Order creation date and time. Returned by GetOrdersDetails API only.
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).
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.
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. (Second bullet appears to be a typo for FALSE; see review §2.)
Exporter details. Only the two fields below are documented (as dotted rows in the Merchant.Order table); no standalone ExporterDetails table exists on the page.
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.
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.
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.
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.
Indicates if 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.
Indicates if the order is a replacement. TRUE - The order is a replacement. FALSE - The order is not a replacement.
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.
Indicates if the order has a tax exemption. TRUE - Order has a tax exemption. FALSE - Order does not have a tax exemption.
Loyalty code applicable to the Merchant's site entered by the end customer in Global-e checkout.
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.
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).
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.
Order unique identifier on the Merchant's site returned from a previous call to the SendOrderToMerchant method for this order.
Holds the product's SKU.
One of the values of OrderCreationSource enumeration denoting a type of discount. 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).
0, 1 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.
List of payment methods the customer use (Credit card, Gift Cards).
Reason for the order status, why it was cancelled.
Details that refer to the original order if the current order is a replacement.
Currency of the one-time voucher code used to place the order.
The amount taken off the voucher when applicable.
One-time voucher code used to place the order.
The list of parcels created for the order. Returned by GetOrdersDetails API only.
The paying customer's payment details.
Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.
CountryCoefficient rate applied to the prices in this order.
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.
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.
The list of products being purchased.
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.
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".
Cost of the "Same Day Dispatch" option selected by the end customer on Global-e checkout, in the original Merchant's currency.
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.
Secondary customer's shipping details. If Customer.IsEndCustomerPrimary is FALSE, this field contains the end customers' shipping details.
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.
Code denoting the Merchant's store specified by the customer for "ship to shop" shipping destination (to be mapped on the Global-e side).
Code denoting the order status on the Merchant's site (to be mapped on the Global-e side).
Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.
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.
The total amount of duties paid by the customer in the Merchant's currency.
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.
Sales tax value for USA in the Merchant currency. This value is included in TotalDutiesAndTaxesPrice.
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.
Response
Indicates if an API call was successful or not and why. Some values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.
Response body. Some values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.
Indicates if an API call was successful or not and why.