> ## Documentation Index
> Fetch the complete documentation index at: https://pro-docs.bglobale.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Endpoints
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](/storefront-attributes#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](/storefront-attributes#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 (Global-e to Merchant)](/endpoints#getcheckoutcartinfo--global-e-to-merchant-) 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 (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.
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.
* Displays totals on the basket page
* Opens the checkout process
* Validates order ([SendOrderToMerchant](/endpoints#sendordertomerchant--global-e-to-merchant-))
* **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)
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` (sdefault `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**
Returns all cart contents, including customer information for logged-in customers.
Some values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.
| Name | Type | Description |
| ------------------ | ------------------------- | -------------------------- |
| `CheckoutCartInfo` | Object `CheckoutCartInfo` | Retrieves cart information |
### CheckoutCartInfo
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------ | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -------- |
| `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 | Yes |
| `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 of `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 | Yes |
| `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 | |
| `productsList` | List of `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](/endpoints#getcheckoutcartinfo--global-e-to-merchant-)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 of `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](/endpoints#sendordertomerchant--global-e-to-merchant-) API). Therefore, all other shipping APIs available for local shipping may be omitted in `shippingOptionsList`. | No | |
| `urlParameters` | List of `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](/endpoints#sendordertomerchant--global-e-to-merchant-)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 | Yes |
| `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 | Yes |
### CartUserDetails
| Parameter Name | Type | Description | Mandatory |
| ---------------- | ------------------------ | --------------------------------------------------------------------------- | --------- |
| `AddressDetails` | List of `AddressDetails` | All available addresses are taken from the registered customer address book | No |
| `UserId` | String | Internal User identifier on the Merchant’s site | No |
### AddressDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------- | ------------------------- | -------------------------------------------------------------------- | --------- | -------- |
| `Address1` | String | Address line 1. | No | Yes |
| `Address2` | String | Address line 2. | No | Yes |
| `AddressBookId` | String | Id of the current address from within the address book | No | |
| `AddressBookName` | String | Name of the current address from within the address book | No | |
| `City` | String | City name. | No | Yes |
| `Company` | String | Company name | No | Yes |
| `CountryCode` | String | 2-char ISO country code | No | Yes |
| `Email` | String | E-mail address | No | |
| `Fax` | String | Fax | No | |
| `FirstName` | String | First name | No | |
| `FirstNameInLocalCulture` | String | First name in local culture | No | |
| `IsBilling` | Boolean | Indicates that the current address can be used as a billing address | No | |
| `IsDefaultBilling` | Boolean | Indicates that the current address is the default billing address | No | |
| `IsDefaultShipping` | Boolean | Indicates that the current address is the default shipping address | No | |
| `IsShipping` | Boolean | Indicates that the current address can be used as a shipping address | No | |
| `LastName` | String | Last name | No | |
| `LastNameInLocalCulture` | String | Last name in local culture | No | |
| `MiddleName` | String | Middle name | No | |
| `Phone1` | String | Phone #1 | No | |
| `Phone2` | String | Phone #2 | No | |
| `Salutation` | String | Salutation or title (e.g. Dr., Mr., etc.). | No | |
| `StateCode` | String | State or province ISO code such as AZ for Arizona (if applicable) | No | Yes |
| `StateOrProvince` | String | State or province name | No | |
| `UserIdNumber` | String | User’s personal ID document number | No | |
| `UserIdNumberType` | Object `UserIdNumberType` | User’s personal ID document type (e.g. Passport, ID card, etc.) | No | |
| `Zip` | String | Zip or postal code | No | Yes |
### UserIdNumberType
| Parameter Name | Type | Description | Mandatory |
| ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `Name` | String | Identification document type name | |
| `UserIdNumberTypeCode` | String | Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side) | |
### Discounts
| Parameter Name | Type | Description | Mandatory |
| ----------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `CouponCode` | String | Merchant Coupon Code used for this discount (applicable to coupon-based discounts only).Max length: 100 chars. | No |
| `Description` | String | Discount textual description.Length: Unlimited. | No |
| `DiscountType` | Integer | One of the following possible values of `DiscountTypeOptions`enumeration denoting a type of discount:
Cart discount - 1
Shipping discount - 2
Loyalty points discount - 3
Duties discount - 4
Checkout Loyalty points discount - 5
Payment charge - 6 | No |
| `DiscountValue` | Decimal | Discount value in end customer’s currency (specified in `InternationalDetails.CurrencyCode` property for the `Merchant.Order`, after applying country coefficient, FX conversion, and IncludeVAT. | No |
| `Name` | String | Discount name.Length: Unlimited. | No |
| `OriginalDiscountValue` | Decimal | Discount value in the currency defined in the `CurrencyCode`; property of the `Merchant.Order`; object for the order being submitted to the Merchant. | Yes |
| `VATRate` | Decimal | The VAT rate applied to this discount | No (Required for merchants whose base country has VAT. If not specified, will default to **0**.) |
| `ProductCartItemId` | String | For product level discount, match the unique CartItemId line identifier of the respective product in the productList. For cart level discounts, leave this field blank or null. | No |
| `CalculationMode` | Integer | The mode of calculation:
1 - value in base currency while maintaining ratio to domestic discount
2 - fixed amount in base currency
3 - fixed amount in shopper currency (used for fixed price markets only) | Yes |
### KeyValuePair
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | -------------------------------------------------------------------------------------------------------- | --------- |
| `Key` | String | Entity key (for example a URL parameter) used on the Merchant’s site (to be mapped on the Global‑e side) | |
| `Value` | String | Entity value for the respective Key | |
### LoyaltyPoints
| Parameter Name | Type | Description | Mandatory |
| ------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------ | --------- |
| `LoyaltyPointsMaxSpend` | Decimal | The limit loyalty points that the user can use in this order – if not exists the `LoyaltyPointsTotal` is taken. | No |
| `LoyaltyPointsOriginalValueForEarn` | Decimal | Value of one loyalty point for earn, in Merchant currency – optional if `LoyaltyPointsOriginalForEarn` exists. | No |
| `LoyaltyPointsOriginalValueForSpend` | Decimal | Value of one loyalty point for spending, in Merchant currency – optional if `LoyaltyPointsValueForSpend` exists. | No |
| `LoyaltyPointsTotal` | Decimal | The total loyalty points the user has on account at the Merchant’s site | No |
| `LoyaltyPointsValueForEarn` | Decimal | Value of one loyalty point for earn, in customer currency – optional if `LoyaltyPointsOriginalValueForEarn` exists. | No |
| `LoyaltyPointsValueForSpend` | Decimal | Value of one loyalty point for spending, in customer currency – optional if `LoyaltyPointsOriginalValueForSpend` exists. | No |
### Product
| Parameter Name | Type | Description | Mandatory |
| --------------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `Attributes` | List of `Attributes` | The product’s custom attributes (such as Color, Size, etc.) | No |
| `AttributesEnglish` | List of `Attributes` | The product’s custom attributes (such as Color, Size, etc.) in English | No |
| `BackOrderDate` | String | Estimated date for the backordered item to be in stock | No |
| `Brand` | Object `Brand` | The product’s brand | No |
| `CartItemId` | String | Identifier of the cart item on the Merchant’s site. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method. | No |
| `CartItemOptionId` | String | Identifier of the child cart item “option” on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (`CartItemId` must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a package for the parent item in the same cart. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method. | No |
| `Categories` | List of `Category` | The product’s categories | No |
| `DeliveryQuantity` | Decimal | The quantity actually set for delivery for the product (to be used in the Order methods described below, as needed) | No |
| `Description` | String | Description of the Product | |
| `DescriptionEnglish` | String | Description of the Product in English | |
| `GenericHSCode` | String | The product’s generic HS Code (not country-specific). If specified this property may assist in mapping the product for duties and taxes calculation purposes. | No |
| `GiftMessage` | String | Optional “gift message” text defined by the end customer to be printed on the product. | No |
| `HandlingCode` | String | Code applicable to the product on the Merchant’s site. This code may be optionally used by the Merchant to trigger a certain business logic when this product is included in the order posted back to the Merchant’s site with the `SendOrderToMerchant` method. | No |
| `Height` | Decimal | The product’s height in the Merchant’s default unit of length measure (will be converted to CM). | No |
| `HubCode` | String | The Merchant hub code indicates from which hub the product was sent. Note that the HubCode should be mapped to a Global-e hubId on the Global-e side. | No |
| `ImageHeight` | Decimal | The product’s image height in pixels | No |
| `ImageURL` | String | The product’s image URL | No |
| `ImageWidth` | Decimal | The product’s image width in pixels | |
| `IsBackOrdered` | Boolean | Boolean specifying if the product was ordered as a backed ordered item.TRUE - The item is back orderedFALSE - The item is not back ordered. Default FALSE. | No |
| `IsBlockedForGlobalE` | Boolean | Indicates if product is available for international shipping.TRUE - The product is not available for international shippingFALSE - The product is available for international shipping | No |
| `IsBundle` | Boolean | Indicates if the product represents a set of products.TRUE - The product represents a set of other products. If a bundled product has non-zero prices specified (i.e. `OriginalListPrice`, `ListPrice`, etc.), then all the contained products must have zero prices, and vice versa, to avoid double charging for the same products.FALSE - The product does not represent a set of other products. | No |
| `IsFixedPrice` | Boolean | Indicates if the product’s price is fixed by the Merchant, in the default currency for the country.TRUE - The product’s price is fixed. In this case, all price modifications are disabled for this product. Setting fixed prices is only allowed for the Countries where the `SupportsFixedPrices` flag is set to TRUE.FALSE - The product's price is not fixed. | No |
| `IsVirtual` | Boolean | Indicates if the product represents a virtual product that does not have weight or volume and doesn’t affect shipping calculation in Global‑e checkoutTRUE - The product represents a virtual productFALSE - The product does not represent a virtual product | No |
| `Keywords` | String | The product’s keywords | No |
| `Length` | Decimal | The product’s length in the Merchant’s default unit of length measure (will be converted to CM). | No |
| `LineItemOriginalSalePrice` | Decimal | Line item (product in ordered quantity) sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the price in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country. If not specified, will be deemed equal to “`OriginalSalePrice* OrderedQuantity`”. If specified, will take preference over `OriginalSalePrice`. | No |
| `LineItemSalePrice` | Decimal | Line item (product in ordered quantity) sale price as displayed to the customer, after applying country coefficient, FX conversion and `IncludeVAT` handling, before rounding rules have been applied. If not specified, will be deemed equal to “`SalePrice * OrderedQuantity`”. If specified, will take preference over `SalePrice`. | No |
| `ListPrice` | Decimal | Product list price (before discounts) as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling. | Optional in `SendCart`, `SaveProductsBulk` |
| `LocalVATRateType` | Object `VATRateType` | VAT rate type or class that would be applied to this product if the order was placed by the local customer. This value must be specified if `UseCountryVAT` for the current Country is TRUE, and therefore the `VATRateType` property actually denotes the VAT for the target country. | No |
| `MetaData` | Object `ProductMetaData` | Used to hold additional product data such as customer-defined product attributes. | No |
| `Name` | String | Name of the Product | |
| `NameEnglish` | String | Name of the Product in English | |
| `NetVolume` | Decimal | The product’s net volume in the Merchant’s default unit of volume measure (will be converted to cubic CM). If specified, this property indicates the net volume of the product, excluding any packaging. | No |
| `NetWeight` | Decimal | The product’s net weight in the Merchant’s default unit of weight measure (will be converted to grams). If specified, this property indicates the net weight of the product, excluding any packaging. | No |
| `OrderedQuantity` | Decimal | Ordered quantity for the product (to be used in Checkout / Order methods described below, as needed) | No |
| `OriginalListPrice` | Decimal | Product list price (before any discounts) in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT` for the end customer’s current country. | Optional in `SendCart`, `SaveProductsBulk` |
| `OriginalSalePrice` | Decimal | Product sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of `UseCountryVAT`for the end customer’s current country. | Optional in SaveProductsList, `SaveProductsBulk` |
| `OriginCountryCode` | String | 2-char ISO country code of the product’s country of Origin. The Merchant’s country will be assumed if not specified. | No |
| `ParentCartItemId` | String | Identifier of the current item’s parent cart item on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (`CartItemId` must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a custom option (such as a product package) for the parent item in the same cart. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method. | No |
| `PriceCoefficientRate` | Decimal | Rate applicable to this Product’s`ProductClassCode` if returned from the `CountryCoefficients` method. | No |
| `ProductClassCode` | String | The product class code is used by the Merchant to classify products to use different country coefficient rates. | No |
| `ProductCode` | String | SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side) | |
| `ProductCodeSecondary` | String | Secondary code that may be used to refer to the product on the Merchant’s site. This code may be used in addition to the `ProductCode` and is not guaranteed to be unique (may be reused for other products as long as the old product is not available on the Merchant’s site any more). | No |
| `ProductGroupCode` | String | Product’s group code on the Merchant’s site (to be mapped on the Global‑e side). Usually, this value is a part of the product SKU code denoting a group of similar products (such as "the same product in different s"). | No |
| `ProductGroupCodeSecondary` | String | Secondary code that may refer to the group of products on the Merchant’s site. This code may be used in addition to the `ProductGroupCode` and is not guaranteed to be unique (may be reused for other groups as long as the old group is not available on the Merchant’s site anymore). | No |
| `SalePrice` | Decimal | Product sale price as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable) and `IncludeVAT` handling. | Optional in SaveProductsList, `SaveProductsBulk`, [GetCheckoutCartInfo](/endpoints#getcheckoutcartinfo--global-e-to-merchant-) |
| `SalePriceBeforeRounding` | Decimal | Product sale price as displayed to the customer, after applying country coefficient, FX conversion and `IncludeVAT` handling, before rounding rules have been applied. If not specified, will be deemed equal to `SalePrice`. | No |
| `SalePriceReason` | String | Reason for the sale price. This property may optionally contain the text definition of the promo that has resulted in the price deduction for this product (such as “10% discount on all shoes”). | No |
| `URL` | String | The product’s information page URL | No |
| `VATCategory` | Object `VATCategory` | The product’s VAT category. A product may be assigned to a single VAT category on the Merchant’s site. If available, the respective product’s HS Code should be used as the VAT category for a product. | No |
| `VATRateType` | Object `VATRateType` | Product’s VAT rate type or class | No |
| `Volume` | Decimal | The product’s volume in the Merchant’s default unit of volume measure (will be converted to cubic CM). | Optional, can be used as an alternative for specifying all Height, Width and Length dimensions |
| `Weight` | Decimal | The product’s weight is in the Merchant’s default unit of weight measure (will be converted to grams). The Merchant’s default product weight will be used if not specified. | No |
| `Width` | Decimal | The product’s width in the Merchant’s default unit of length measure (will be converted to CM). | No |
### Attributes
| Parameter Name | Type | Description | Mandatory |
| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `AttributeCode` | String | Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side) | |
| `AttributeTypeCode` | String | Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side) | |
| `Name` | String | Attribute name | |
### Brand
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | --------------------------------------------------------------------- | --------- |
| `BrandCode` | String | Brand code on the Merchant’s site (to be mapped on the Global‑e side) | |
| `Name` | String | Brand name | |
### Category
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | ---------------------------------------------------------------------- | --------- |
| `CategoryCode` | String | Category code on the Merchant site (to be mapped on the Global‑e side) | |
| `Name` | String | Category name | |
### MetaData
| Parameter Name | Type | Description | Mandatory |
| -------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `Attributes` | List of `Attributes` | Customer-defined product attributes that allow the personalisation of the product if supported by the merchant’s site (e.g. engraving) | |
### Attributes
| Parameter Name | Type | Description | Mandatory |
| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `AttributeCode` | String | Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side) | |
| `AttributeTypeCode` | String | Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side) | |
| `Name` | String | Attribute name | |
### VATCategory
| Parameter Name | Type | Description | Mandatory |
| ----------------- | ------ | ------------------------------------------------------------------------------------------------- | --------- |
| `Name` | String | VAT Category name | |
| `VATCategoryCode` | String | Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side) | |
### VATRateType
| Parameter Name | Type | Description | Mandatory |
| ----------------- | ------- | ---------------------------------------------------------------------------------------- | --------- |
| `Name` | String | VAT rate type name | No |
| `Rate` | Decimal | VAT rate decimal value | |
| `VATRateTypeCode` | String | VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side) | |
### ShippingOption
| Parameter Name | Type | Description | Mandatory |
| ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `Carrier` | String | Carrier’s short name | |
| `CarrierName` | String | Carrier’s full name | |
| `CarrierTitle` | String | Carrier’s title | |
| `Code` | String | Shipping method code used to identify the shipping option on the Merchant’s site (to be mapped on the Global‑e side) | |
| `Method` | String | Shipping method name | |
| `MethodTitle` | String | Shipping method title | |
| `MethodDescription` | String | Shipping method description | |
| `Price` | Decimal | Shipping price in Merchant’s original currency defined in the `originalCurrencyCode` argument of the respective method call (i.e. `SendCart`) | |
### UserDetails
| Parameter Name | Type | Description | Mandatory |
| ------------------------- | ------------------------- | ----------------------------------------------------------------- | --------- |
| `Address1` | String | Address line 1 | No |
| `Address2` | String | Address line 2 | No |
| `City` | String | City name | No |
| `Company` | String | Company name | No |
| `CountryCode` | String | 2-char ISO country code | No |
| `CountryName` | String | Country name | No |
| `Email` | String | E-mail address | No |
| `Fax` | String | Fax | No |
| `FirstName` | String | First name | No |
| `FirstNameInLocalCulture` | String | First name in local culture Ex: Kana Japanese dialect | No |
| `LastName` | String | Last name | No |
| `LastNameInLocalCulture` | String | Last name in local culture Ex: Kana Japanese dialect | No |
| `MiddleName` | String | Middle name | No |
| `Phone1` | String | Phone #1 | No |
| `Phone2` | String | Phone #2 | No |
| `Salutation` | String | Salutation or title (e.g. Dr., Mr., etc.) | No |
| `StateCode` | String | State or province ISO code such as AZ for Arizona (if applicable) | No |
| `StateOrProvice` | String | State or province name | No |
| `UserId` | String | Internal User identifier on the Merchant site | No |
| `UserIdNumber` | String | User’s personal ID document number | No |
| `UserIdNumberType` | Object `UserIdNumberType` | User’s personal ID document type (e.g. Passport, ID card, etc.) | No |
| `Zip` | String | Zip or postal code | No |
### UserIdNumberType
| Parameter Name | Type | Description | Mandatory |
| ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `Name` | String | Identification document type name | |
| `UserIdNumberTypeCode` | String | Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side) | |
### Examples
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
}
]
}
```
```
{
"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": "john.doe@global-e.com",
"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": "john.doe@global-e.com",
"Salutation": "",
"FirstName": "john",
"LastName": "winer",
"Address1": "basel 25",
"Address2": "",
"City": "petah tikva",
"StateOrProvince": "",
"Zip": "11223344",
"CountryCode": "ISR",
"CountryName": "Israel",
"Phone1": "0000000000",
"Phone2": ""
}
}
```
```
{
"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": "john.doe@global-e.com",
"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": "john.doe@global-e.com",
"Salutation": "",
"FirstName": "john",
"LastName": "doe",
"Address1": "basel 25",
"Address2": "",
"City": "petah tikva",
"StateOrProvince": "",
"Zip": "11223344",
"CountryCode": "ISR",
"CountryName": "Israel",
"Phone1": "0000000000",
"Phone2": ""
}
}
```
```
{
"productsList": [{
"CartItemId": "676106",
"ProductCode": "676106",
"ProductGroupCode": "CS16577",
"Name": "N+ Warmers",
"Description": "The 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": "john.doe@global-e.com",
"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": "john.doe@global-e.com",
"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": "john.doe@global-e.com",
"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)
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.
* Merchant GUID - In request payload (required)
* Custom header (optional)
* IP whitelist (optional)
* HTTP Basic Authentication (optional)
* JWT (optional)
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. | |
### Merchant.Order
| Parameter Name | Type | Mandatory | Description | GEM Only |
| ----------------------------------------------- | -------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `AdditionalRequiredDocuments` | List of `OrderDocument` | | The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment. | Yes |
| `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 emailsFALSE - CustoCurrencyCodemer did not opt to receive emails | |
| `CartHash` | String | No | Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e. | Yes |
| `CartId` | String | No | 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. | Yes |
| `CashOnDeliveryFee` | Decimal | | Cash On Delivery fee amount in Merchant’s currency. | |
| `CCFPrice` | Decimal | | Customs Clearance Fees (CCF), in the Merchant currency. | Yes |
| `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 clearedFALSE - The end customer's cart does not have to be cleare | Yes |
| `CurrencyCode` | StringCustomer | | 3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency. | Yes |
| `CurrencyName` | String | No | Customer currency name. Returned by `GetOrdersDetails` API only | |
| `Customer` | Object `Merchant.Customer` | | The paying customer’s preferences (Global-e acts as a paying customer). | Yes |
| `CustomerComments` | String | | Holds the gift message. In the offline order flow, holds the product comment. | Yes |
| `CustomerComments` | String | No | Comments text entered by the end customer in Global‑e checkout. | |
| `CustomerDTBreakdown` | Object `DTBreakdown` | No | Contains the duties and tax parts the customer paid for the order. | |
| `DateCreated` | String | No | Order creation date and time. Returned by `GetOrdersDetails` API only. | |
| `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). | Yes |
| `Discounts` | List of `Merchant.Discount` | No | 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. | Yes |
| `DoNotChargeVAT` | Boolean | No | 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 chargedTRUE - VAT is charged | Yes |
| `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 | No | 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. | Yes |
| `InternationalDetails` | Object `Merchant.InternationalDetails` | No | 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. | Yes |
| `IsB2B` | Boolean | | Indicates if the order has a Company name and VAT registration number.TRUE - Order contains a company name and VAT registration numberFALSE - Order does not contain a company name and VAT registration number | |
| `IsFreeShipping` | Boolean | No | 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. | Yes |
| `IsMoto` | Boolean | | Indicates if the the customer is a customer support agent and an “Offline order” took placeTRUE - The customer is a customer support agent and an “Offline order” took placeFALSE - The customer is a regular customer | Yes |
| `IsReplacementOrder` | Boolean | | Indicates if the order is a replacement.TRUE - The order is a replacementFALSE - The order is not a replacement | |
| `IsSplitOrder` | Boolean | No | Indicates if the order should be handled as a split order (i.e. without consolidation).TRUE - Order will be splitFALSE - Order is not to be split | Yes |
| `IsTaxExemption` | Boolean | | Indicates if the order has a tax exemption.TRUE - Order has a tax exemptionFALSE - Order does not have a tax exemption | |
| `LoyaltyCode` | String | No | Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout. | Yes |
| `LoyaltyPointsEarned` | Decimal | No | 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. | Yes |
| `LoyaltyPointsSpent` | Decimal | No | 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). | Yes |
| `Markups` | List of `Merchant.Discount` | No | 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. | Yes |
| `MerchantDTBreakdown` | Object `DTBreakdown` | No | Contains the duties and tax parts that the Merchant subsidized for the order. | |
| `MerchantGUID` | String | | Unique identifier of the Merchant on Global-e. | Yes |
| `MerchantOrderId` | String | No | Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order. | |
| `ModifiedProduct` | String | | Holds the product’s SKU | Yes |
| `OrderCreationSource` | Decimal | | One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the [OrderCreationSource Table](/endpoints#UUID-ca1e0c9b-0f53-e713-379c-1c52e4e46068_N1736933585508). | |
| `OrderDocuments` | List of `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. | Yes |
| `OrderId` | String | | Global‑e order unique identifier. | Yes |
| `OrderPaymentMethods` | List of `OrderPaymentMethod` | | List of payment methods the customer use (Credit card, Gift Cards) | Yes |
| `OrderStatusReason` | Object `OrderStatusReason` | | Reason for the order status, why it was cancelled. | Yes |
| `OriginalOrder` | Object `Merchant.OriginalOrder` | No | Details that refer to the original order if the current order is a replacement. | Yes |
| `OTCurrencyCode` | String | No | Currency of the one-time voucher code used to place the order. | |
| `OTVoucherAmount` | Decimal | No | The amount taken off the voucher when applicable. | Yes |
| `OTVoucherCode` | String | No | One-time voucher code used to place the order | Yes |
| `Parcels` | List of `Merchant.Parcel` | No | The list of parcels created for the order. Returned by `GetOrdersDetails` API only. | |
| `PaymentDetails` | Object `Merchant.PaymentDetails` | | The paying customer’s payment details. | Yes |
| `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. | Yes |
| `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. | Yes |
| `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. | Yes |
| `Products` | List of `Merchant.Product` | | The list of products being purchased. | Yes |
| `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. | Yes |
| `SameDayDispatch` | Boolean | No | 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" | Yes |
| `SameDayDispatchCost` | Decimal | No | Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency. | Yes |
| `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. | Yes |
| `SecondaryShipping` | Object `Merchant.CustomerDetails` | | Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details. | Yes |
| `ShippingMethodCode` | String | No | 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. | Yes |
| `ShipToStoreCode` | StringExporterDetails | No | Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side). | Yes |
| `StatusCode` | String | | Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side). | Yes |
| `Subs` | List of `Merchant.Order` | | Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed. | Yes |
| `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. | Yes |
| `TotalDutiesPaidByCustomerPrice` | DecimalWebStoreInstanceCode | | The total amount of duties paid by the customer in the Merchant’s currency. | Yes |
| `UserId` | String | No | 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. | Yes |
| `USSalesTax` | Decimal | | Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`. | Yes |
| `WebStoreCode` | String | No | 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. | Yes |
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 |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Customer
| Parameter Name | Type | Description | Mandatory |
| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `IsEndCustomerPrimary` | Boolean | Indicates if end customer details are “swapped” with a paying (Global‑e) customer’s details when submitting the order to the Merchant. By default, `IsEndCustomerPrimary` is FALSE.TRUE - The primary customer is the same as the end customer who has placed the orderFALSE - The primary customer denotes the paying (Global‑e) customer and the secondary customer denotes the end customer who has placed the order with Global‑e checkout | Yes |
| `SendConfirmation` | Boolean | Indicates if e-mail confirmation of the respective order’s status change needs to be sent to the paying customer (Global‑e acts as a paying customer). | Yes |
### Merchant.CustomerDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------- | ------------------- | --------------------------------------------------------------------------- | --------- | -------- |
| `Address1` | String | Address line 1 | No | Yes |
| `Address2` | String | Address line 2 | No | Yes |
| `AddressBookId` | String | Id of the current address from within the address book | No | Yes |
| `AddressBookName` | String | Name of the current address from within the address book | No | Yes |
| `City` | String | City name | No | Yes |
| `Company` | String | Company name | No | Yes |
| `CountryCode` | StringCustomerTaxId | 2-char ISO country code | No | Yes |
| `CountryName` | String | Country name | No | Yes |
| `Email` | String | Email address | No | Yes |
| `Fax` | String | Fax | No | Yes |
| `FirstName` | String | First name | No | Yes |
| `FirstNameInLocalCulture` | String | First name in local culture | No | |
| `LastName` | String | Last name | No | Yes |
| `LastNameInLocalCulture` | String | Last name in local culture | No | |
| `MiddleName` | String | Middle name | No | Yes |
| `Phone1` | String | Phone #1 | No | Yes |
| `Phone2` | String | Phone #2 | No | Yes |
| `Salutation` | String | Salutation or title (e.g. Dr., Mr., etc.) | No | Yes |
| `SaveAddress` | Boolean | Indicates that the current address should be saved in the Merchant platform | No | |
| `StateCode` | String | State or province ISO code such as AZ for Arizona (if applicable) | No | Yes |
| `StateOrProvice` | String | State or province name | No | Yes |
| `Zip` | String | Zip or postal code | No | Yes |
### Merchant.Discount
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `CouponCode` | String | Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only) | No | Yes |
| `Description` | String | Discount textual description | No | Yes |
| `DiscountCode` | String | Discount code originally specified in the `Discount.DiscountCode` property of the respective discount in `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `DiscountSource` | Enum | The enum DiscountSource has the following possible values:
1 = Merchant
2 = FixedShippingPrice
3 = PercentageCartPrice
4 = HiddenForceDDP
5 = Amend
6 = RemoteAreaSurchargeSubsidy
7 = LoyaltyPoints
8 = PaymentCharge
9 = ReplacementOrder | Yes | |
| `DiscountType` | Decimal | Discount type (“Cart”, “Shipping”, etc.), as defined in the `DiscountTypeOptions` enumeration described in the Discount class in this document. | | Yes |
| `InternationalPrice` | Decimal | Discount value in end customer’s currency (specified in `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, and `IncludeVAT` handling. | No | Yes |
| `LocalVATRate` | Decimal | The VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if `UseCountryVAT` for the current Country is TRUE and therefore the `VATRate` property denotes the VAT for the target country. | No | Yes |
| `LoyaltyVoucherCode` | String | Loyalty Voucher code originally specified in `Discount.LoyaltyVoucherCode` property of the respective discount in `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Name` | String | Discount name | | Yes |
| `Price` | Decimal | Discount value in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `ProductCartItemId` | String | Identifier of the product cart item related to this discount on the Merchant’s site originally specified in the `Discount.ProductCartItemId` property of the respective discount in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `VATRate` | Decimal | The VAT rate applied to this discount | | Yes |
### Merchant.InternationalDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `CardNumberLastFourDigits` | String | The last 4 digits of the Card number (if applicable). | No | |
| `CashOnDeliveryFee` | Decimal | The additional charge is paid by the end customer when the “Cash on Delivery” payment method has been selected. | No | |
| `ConsignmentFee` | Decimal | The consignment fee is paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `CurrencyCode` | String | 3-char ISO code for the currency selected by the end customer for the order payment. | | |
| `CustomerDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes parts the customer paid for the order in the currency denoted by `CurrencyCode`. | No | Yes |
| `DeliveryDaysFrom` | Decimal | The minimum number of days for delivery to the end customer for the selected shipping method. | No | |
| `DeliveryDaysTo` | Decimal | The maximum number of days for delivery to the end customer for the selected shipping method. | No | |
| `DiscountedShippingPrice` | Decimal | The price paid by the customer in local currency. Total Shipping price reducing Order Discounts International price. | | |
| `DutiesGuaranteed` | Bool | Indicates if the end customer has selected the “guaranteed duties and taxes” option. | | |
| `ExpirationDate` | string | Card expiration date in YYYY-MM-DD format (if applicable). | No | |
| `MerchantDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes parts the Merchant subsidized for the order in the currency denoted by `CurrencyCode`. | No | Yes |
| `OrderTrackingNumber` | String | Tracking number used by the selected international shipping method for this order. | No | |
| `OrderTrackingUrl` | String | Full tracking URL including `OrderTrackingNumber` used by the selected international shipping method for this order. | No | |
| `OrderWaybillNumber` | String | Waybill number used by the selected international shipping method for this order. | No | |
| `ParcelsTracking` | List of `Merchant.ParcelTracking` | List of `Merchant.ParcelTracking` objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number). | | |
| `PaymentMethodCode` | String | Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global‑e payment method code will be specified instead. | | |
| `PaymentMethodName` | String | Name of the selected payment method. | | |
| `RemoteAreaSurcharge` | Decimal | Remote area surcharge paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `SameDayDispatchCost` | Decimal | Cost of the “Same Day Dispatch” option (if selected by the end customer on Global‑e checkout), in the currency denoted by `CurrencyCode`. This value is NOT included in `TotalShippingPrice`. | No | |
| `ShippingMethodCode` | String | Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global‑e shipping method code will be specified instead. | | |
| `ShippingMethodName` | String | Name of the selected international shipping method. | | |
| `ShippingMethodStatusCode` | String | Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on the Global‑e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global‑e shipping status code will be specified instead. | No | |
| `ShippingMethodStatusName` | String | Name of the shipping status. | No | |
| `ShippingMethodTypeCode` | String | Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method type does not exist on the Merchant’s site, the internal Global‑e shipping method type code will be specified instead. | | |
| `ShippingMethodTypeName` | String | Name of the selected international shipping method type. | | |
| `ShippingVATRate` | Decimal | The shipping VAT rate for the customer. This rate is applied to the shipping cost. | | Yes |
| `SizeOverchargeValue` | Decimal | Oversized items charge paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `TotalCCFPrice` | Decimal | Total Customs Clearance Fees value in the currency denoted by `CurrencyCode`. This value is included in `TotalDutiesPrice`. | No | |
| `TotalDutiesPrice` | Decimal | Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by `CurrencyCode`. | | |
| `TotalPrice` | Decimal | Total order price in the currency denoted by `CurrencyCode`. | | |
| `TotalShippingPrice` | Decimal | Total shipping price in the currency denoted by `CurrencyCode`. | | |
| `TotalVATAmount` | Decimal | Amount of VAT paid by the customer to Global‑e | | |
| `TransactionCurrencyCode` | String | 3-char ISO code for the currency actually used for the current order payment. `TransactionCurrencyCode` may differ from `CurrencyCode` if the currency selected by the end customer could not be used with the selected payment method. | | |
| `TransactionTotalPrice` | Decimal | Total order price actually paid by the end customer in the currency denoted by `TransactionCurrencyCode`. | | |
| `USSalesTax` | Decimal | Sales tax value for the USA in the currency denoted by `CurrencyCode`. This value is included in TotalDutiesPrice. | | |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Parcel
| Parameter Name | Type | Description | Mandatory |
| ---------------- | -------------------------------- | ---------------------------------------- | --------- |
| `Code` | String | Parcel code. | |
| `ParcelStatusId` | Decimal | Parcel status id. | |
| `StatusName` | String | Parcel status name. | |
| `TrackingUrl` | String | Direct tracking URL. | |
| `Products` | List of `Merchant.ParcelProduct` | List of products included in the parcel. | |
### Merchant.ParcelProduct
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------- | ---------------------------------------- | --------- |
| `CartItemId` | String | Cart item id of the product. | |
| `Quantity` | Decimal | Product quantity included in the parcel. | |
| `Sku` | String | Product SKU. | |
### Merchant.OriginalOrder
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------- | ------ | ---------------------------------------------------------------------------------- | --------- | -------- |
| `MerchantInternalOrderId` | String | `InternalOrderId` returned from `SendOrderToMerchant` call for the original order. | No | Yes |
| `MerchantOrderId` | String | `OrderId` returned from `SendOrderToMerchant` call for the original order. | No | Yes |
| `OrderId` | String | Global‑e order unique identifier for the original order. | | |
### Merchant.Parcel
| Parameter Name | Type | Description | Mandatory |
| ---------------- | -------------------------------- | ---------------------------------------- | --------- |
| `Code` | String | Parcel code. | |
| `ParcelStatusId` | Decimal | Parcel status id. | |
| `StatusName` | String | Parcel status name. | |
| `TrackingUrl` | String | Direct tracking URL. | |
| `Products` | List of `Merchant.ParcelProduct` | List of products included in the parcel. | |
### Merchant.ParcelProduct
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------- | ---------------------------------------- | --------- |
| `CartItemId` | String | Cart item id of the product. | |
| `Quantity` | Decimal | Product quantity included in the parcel. | |
| `Sku` | String | Product SKU. | |
### Merchant.PaymentDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ----------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -------- |
| `Address1` | String | Address line 1 | No | Yes |
| `Address2` | String | Address line 2 | No | Yes |
| `CardNumber` | String | Card number | | Yes |
| `City` | String | City name | No | Yes |
| `CountryCode` | String | 2-char ISO country code | | Yes |
| `CountryName` | String | Country name | | Yes |
| `CVVNumber` | String | Card CVV number | | Yes |
| `Email` | String | E-mail address | No | Yes |
| `ExpirationDate` | String | Card expiration date (in YYYY-MM-DD format) | | Yes |
| `Fax` | String | Fax | No | Yes |
| `OwnerFirstName` | String | Card owner’s first name | Optional if `OwnerName` is specified | Yes |
| `OwnerLastName` | String | Card owner’s last name | Optional if `OwnerName` is specified | Yes |
| `OwnerName` | String | Card owner’s full name (the Merchant may choose to consider either full name or first name with the last name, according to the existing payment method input validation requirements). | No | Yes |
| `PaymentMethodCode` | String | Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `PaymentMethodName` | String | Payment method name | | Yes |
| `PaymentMethodTypeCode` | String | Payment method type’s code used to identify the payment method type (such as Credit Card or Check) on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `Phone1` | String | Phone #1 | No | Yes |
| `Phone2` | String | Phone #2 | No | Yes |
| `StateCode` | String | State or province ISO code such as AZ for Arizona (if applicable) | No | Yes |
| `StateOrProvice` | String | State or province name | No | Yes |
| `Zip` | String | Zip or postal code | No | Yes |
### Merchant.Product
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------------------------------ | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `Attributes` | List of `Merchant.CartProductAttribute` | Custom attributes describe products that customers can personalize according to what the site offers. Each Attribute holds a key to specify attribute name and Value properties. | No | Yes |
| `BackOrderDate` | String | Estimated date for the backordered item to be in stock | No | Yes |
| `Brand` | Object `Merchant.Brand` | Product’s brandSku | No | |
| `CartItemId` | String | Identifier of the cart item on the Merchant’s site originally specified in the `Product.CartItemId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `CartItemOptionId` | String | Identifier of the child cart item “option” on the Merchant’s site originally specified in the `Product.CartItemOptionId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Categories` | List of `Merchant.Category` | List of product categories | No | |
| `CustomerVATRate` | Decimal | The customer VAT rate applied to this product | | Yes |
| `DiscountedPrice` | Decimal | The product value is in Merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product’s refund. | | Yes |
| `DiscountedPriceForCustoms` | Decimal | Product price in Merchant currency reflects the price after Reverse D\&T calculation. | | Yes |
| `DTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes per item in Merchant currency. | No | Yes |
| `GenericHSCode` | String | Product’s HS code | No | Yes |
| `GiftMessage` | String | Text originally specified in the `Product.GiftMessage` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `HandlingCode` | String | Code originally specified in `Product.HandlingCode` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `InternationalDiscountedPrice` | Decimal | The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product’s refund. | | Yes |
| `InternationalDiscountedPriceForCustoms` | Decimal | Product price in customer currency reflects the price after Reverse D\&T calculation | | Yes |
| `InternationalDiscountedPriceInMerchantCurrency` | Decimal | Product Price in Merchant currency | | Yes |
| `InternationalDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes per item in customer currency. | No | Yes |
| `InternationalListPrice` | Decimal | Single product list price in end customer’s currency (specified in the `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. | No | Yes |
| `InternationalPrice` | Decimal | Single product final sale price in end customer currency (specified in InternationalDetails.CurrencyCode property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. | No | Yes |
| `IsBackOrdered` | Bool | Identifies if the product was ordered as a backed ordered itemTRUE - Product is back-ordered.FALSE - Product is not back-ordered. | No | Yes |
| `LineItemInternationalPrice` | Decimal | Line item (product in ordered quantity) price in end customer’s currency (specified in the `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. If not specified, should be deemed equal to “InternationalPrice \* Quantity”. If specified, should take preference over InternationalPrice. | No | |
| `LineItemPriceBeforeGlobalEDiscount`- DEPRECATED | Decimal | Line item (product in ordered quantity) price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If not specified, should be deemed equal to “PriceBeforeGlobalEDiscount \* Quantity”. If specified, should take preference over `PriceBeforeGlobalEDiscount`. | No | |
| `ListPrice` | Decimal | Single product List price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `Name` | String | Name of the product. Returned by `GetOrdersDetails` API only | No | Yes |
| `ParentCartItemId` | String | Identifier of the current item’s parent cart item on the Merchant’s site originally specified in the `Product.ParentCartItemId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Price` | Decimal | Single product final sale price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `PriceBeforeGlobalEDiscount`- DEPRECATED | Decimal | Single product price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If no Global‑e discount was applied, `PriceBeforeGlobalEDiscount` is equal to Price. | No | Yes |
| `ProductAttributes` | List of `Merchant.ProductAttribute` | Product attributes. Returned by `GetOrdersDetails` API only | No | Yes |
| `Quantity` | Decimal | Product quantity in the order that is currently being submitted to the Merchant. | | Yes |
| `RoundingRate` | Decimal | The conversion rate applied to this product price 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. | | Yes |
| `Sku` | String | SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `VATRate` | Decimal | The VAT rate applied to this product | | Yes |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Brand
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | ----------- | --------- |
| `BrandCode` | String | Brand code | |
| `Name` | String | Brand name | |
### Merchant.Category
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | ---------------------- | --------- |
| `CategoryCode` | String | Merchant category code | |
| `Name` | String | Merchant category name | |
### Merchant.CartProductAttribute
| Parameter Name | Type | Description | Mandatory |
| ---------------- | ------ | --------------------------------------------------------------------------------- | --------- |
| `AttributeKey` | String | Custom product attribute name that is used to describe the personalized product. | |
| `AttributeValue` | String | Custom product attribute value that is used to describe the personalized product. | |
### Merchant.ProductAttribute
| Parameter Name | Type | Description | Mandatory |
| ---------------- | ------ | ----------------------------------------------------------------------------- | --------- |
| `AttributeKey` | String | Customized product attribute name, used to describe the personalized product. | |
| `AttributeValue` | String | Customized product attribute, used to describe the personalized product. | |
### OrderDocument
| Parameter Name | Type | Description | Mandatory | GEM Only |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | -------- |
| `CreationDateTime` | DateTime | The date and time the document was created. | No | |
| `DocumentData` | String | Base64 encoded byte array representing the document file content. | | |
| `DocumentExtension` | String | Document extension (PDF, ZPL, EPL). | | Yes |
| `DocumentReference` | String | The reference provided by the government authorities to this document (such as MRN or ITN number). | No | |
| `DocumentTypeCode` | String | Document type code, this value can be:
CommercialInvoice = 1
PackingList = 2
ShipperManifest = 3
Label = 4
VATInvoice = 5
DangerousGoodDeclarationLink = 6
GELabel = 7
CustomerReceiptInvoice = 8
ArchibeLabel = 9
DeliveryAdvice = 10
EAD = 11 | | Yes |
| `DocumentTypeName` | String | Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`. | | Yes |
| `ErrorMessage` | String | Description of the error for this entity (order/parcel) if it happened. | No | Yes |
| `ParcelCode` | String | The parcel code related to the document. | No | |
| `ShippingServiceName` | String | The name of the shipping service for this document (relevant for `DispatchOrders` and `DispatchConsolidatedShipment`). | No | |
| `TrackingNumber` | String | Shipping tracking number associated with the document. | No | |
| `URL` | String | URL of the document. | | Yes |
### OrderPaymentMethod
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------ | --------- | -------- |
| `GiftCardFields` | String | Gift card fields | | Yes |
| `IsGiftCard` | Boolean | Indicates if the order payment method is a gift card.TRUE if using a gift card for paymentFALSE if not using a gift card | | Yes |
| `PaidAmountInCustomerCurrency` | Decimal | Amount that paid in customer’s currency | | Yes |
| `PaidAmountInMerchantCurrency` | Decimal | Amount paid in Merchant’s currency | | Yes |
| `PaymentMethodId` | Decimal | The ID for the payment method | | Yes |
| `PaymentMethodName` | String | Name of the payment method | | Yes |
### OrderStatusReason
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ----------------------- | ------ | ------------------------------------------------------------------------------------------------ | --------- | -------- |
| `Name` | String | Order status reason name | | Yes |
| `OrderStatusReasonCode` | String | Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side) | | Yes |
**Response**
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. | |
### Merchant.ResponseInfo
| Parameter Name | Type | Description | Mandatory | GEM Only |
| --------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -------- |
| `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 | Yes |
| `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 | Yes |
| `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**
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": "info@global-e.com",
"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": "info@global-e.com",
"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": "info@global-e.com",
"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
## 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.
* Merchant GUID - In request payload (required)
* Custom header (optional)
* IP whfUpdateOrderStatus (Global-e to Merchant)itelist (optional)
* HTTP Basic Authentication (optional)
* JWT (optional)
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 |
### Merchant.Order
| Parameter Name | Type | Mandatory | Description | GEM Only |
| ----------------------------------------------- | -------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `AdditionalRequiredDocuments` | List of `OrderDocument` | | The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment. | Yes |
| `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 emailsFALSE - CustoCurrencyCodemer did not opt to receive emails | |
| `CartHash` | String | No | Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e. | Yes |
| `CartId` | String | No | 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. | Yes |
| `CashOnDeliveryFee` | Decimal | | Cash On Delivery fee amount in Merchant’s currency. | |
| `CCFPrice` | Decimal | | Customs Clearance Fees (CCF), in the Merchant currency. | Yes |
| `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 clearedFALSE - The end customer's cart does not have to be cleare | Yes |
| `CurrencyCode` | StringCustomer | | 3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency. | Yes |
| `CurrencyName` | String | No | Customer currency name. Returned by `GetOrdersDetails` API only | |
| `Customer` | Object `Merchant.Customer` | | The paying customer’s preferences (Global-e acts as a paying customer). | Yes |
| `CustomerComments` | String | | Holds the gift message. In the offline order flow, holds the product comment. | Yes |
| `CustomerComments` | String | No | Comments text entered by the end customer in Global‑e checkout. | |
| `CustomerDTBreakdown` | Object `DTBreakdown` | No | Contains the duties and tax parts the customer paid for the order. | |
| `DateCreated` | String | No | Order creation date and time. Returned by `GetOrdersDetails` API only. | |
| `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). | Yes |
| `Discounts` | List of `Merchant.Discount` | No | 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. | Yes |
| `DoNotChargeVAT` | Boolean | No | 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 chargedTRUE - VAT is charged | Yes |
| `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 | No | 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. | Yes |
| `InternationalDetails` | Object `Merchant.InternationalDetails` | No | 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. | Yes |
| `IsB2B` | Boolean | | Indicates if the order has a Company name and VAT registration number.TRUE - Order contains a company name and VAT registration numberFALSE - Order does not contain a company name and VAT registration number | |
| `IsFreeShipping` | Boolean | No | 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. | Yes |
| `IsMoto` | Boolean | | Indicates if the the customer is a customer support agent and an “Offline order” took placeTRUE - The customer is a customer support agent and an “Offline order” took placeFALSE - The customer is a regular customer | Yes |
| `IsReplacementOrder` | Boolean | | Indicates if the order is a replacement.TRUE - The order is a replacementFALSE - The order is not a replacement | |
| `IsSplitOrder` | Boolean | No | Indicates if the order should be handled as a split order (i.e. without consolidation).TRUE - Order will be splitFALSE - Order is not to be split | Yes |
| `IsTaxExemption` | Boolean | | Indicates if the order has a tax exemption.TRUE - Order has a tax exemptionFALSE - Order does not have a tax exemption | |
| `LoyaltyCode` | String | No | Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout. | Yes |
| `LoyaltyPointsEarned` | Decimal | No | 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. | Yes |
| `LoyaltyPointsSpent` | Decimal | No | 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). | Yes |
| `Markups` | List of `Merchant.Discount` | No | 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. | Yes |
| `MerchantDTBreakdown` | Object `DTBreakdown` | No | Contains the duties and tax parts that the Merchant subsidized for the order. | |
| `MerchantGUID` | String | | Unique identifier of the Merchant on Global-e. | Yes |
| `MerchantOrderId` | String | No | Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order. | |
| `ModifiedProduct` | String | | Holds the product’s SKU | Yes |
| `OrderCreationSource` | Decimal | | One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the [OrderCreationSource Table](/endpoints#UUID-ef0f96ab-7a5f-b915-e84b-6dee24269e51_N1736933585508). | |
| `OrderDocuments` | List of `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. | Yes |
| `OrderId` | String | | Global‑e order unique identifier. | Yes |
| `OrderPaymentMethods` | List of `OrderPaymentMethod` | | List of payment methods the customer use (Credit card, Gift Cards) | Yes |
| `OrderStatusReason` | Object `OrderStatusReason` | | Reason for the order status, why it was cancelled. | Yes |
| `OriginalOrder` | Object `Merchant.OriginalOrder` | No | Details that refer to the original order if the current order is a replacement. | Yes |
| `OTCurrencyCode` | String | No | Currency of the one-time voucher code used to place the order. | |
| `OTVoucherAmount` | Decimal | No | The amount taken off the voucher when applicable. | Yes |
| `OTVoucherCode` | String | No | One-time voucher code used to place the order | Yes |
| `Parcels` | List of `Merchant.Parcel` | No | The list of parcels created for the order. Returned by `GetOrdersDetails` API only. | |
| `PaymentDetails` | Object `Merchant.PaymentDetails` | | The paying customer’s payment details. | Yes |
| `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. | Yes |
| `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. | Yes |
| `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. | Yes |
| `Products` | List of `Merchant.Product` | | The list of products being purchased. | Yes |
| `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. | Yes |
| `SameDayDispatch` | Boolean | No | 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" | Yes |
| `SameDayDispatchCost` | Decimal | No | Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency. | Yes |
| `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. | Yes |
| `SecondaryShipping` | Object `Merchant.CustomerDetails` | | Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details. | Yes |
| `ShippingMethodCode` | String | No | 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. | Yes |
| `ShipToStoreCode` | StringExporterDetails | No | Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side). | Yes |
| `StatusCode` | String | | Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side). | Yes |
| `Subs` | List of `Merchant.Order` | | Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed. | Yes |
| `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. | Yes |
| `TotalDutiesPaidByCustomerPrice` | DecimalWebStoreInstanceCode | | The total amount of duties paid by the customer in the Merchant’s currency. | Yes |
| `UserId` | String | No | 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. | Yes |
| `USSalesTax` | Decimal | | Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`. | Yes |
| `WebStoreCode` | String | No | 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. | Yes |
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 |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Customer
| Parameter Name | Type | Description | Mandatory |
| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `IsEndCustomerPrimary` | Boolean | Indicates if end customer details are “swapped” with a paying (Global‑e) customer’s details when submitting the order to the Merchant. By default, `IsEndCustomerPrimary` is FALSE.TRUE - The primary customer is the same as the end customer who has placed the orderFALSE - The primary customer denotes the paying (Global‑e) customer and the secondary customer denotes the end customer who has placed the order with Global‑e checkout | Yes |
| `SendConfirmation` | Boolean | Indicates if e-mail confirmation of the respective order’s status change needs to be sent to the paying customer (Global‑e acts as a paying customer). | Yes |
### Merchant.CustomerDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------- | ------------------- | --------------------------------------------------------------------------- | --------- | -------- |
| `Address1` | String | Address line 1 | No | Yes |
| `Address2` | String | Address line 2 | No | Yes |
| `AddressBookId` | String | Id of the current address from within the address book | No | Yes |
| `AddressBookName` | String | Name of the current address from within the address book | No | Yes |
| `City` | String | City name | No | Yes |
| `Company` | String | Company name | No | Yes |
| `CountryCode` | StringCustomerTaxId | 2-char ISO country code | No | Yes |
| `CountryName` | String | Country name | No | Yes |
| `Email` | String | Email address | No | Yes |
| `Fax` | String | Fax | No | Yes |
| `FirstName` | String | First name | No | Yes |
| `FirstNameInLocalCulture` | String | First name in local culture | No | |
| `LastName` | String | Last name | No | Yes |
| `LastNameInLocalCulture` | String | Last name in local culture | No | |
| `MiddleName` | String | Middle name | No | Yes |
| `Phone1` | String | Phone #1 | No | Yes |
| `Phone2` | String | Phone #2 | No | Yes |
| `Salutation` | String | Salutation or title (e.g. Dr., Mr., etc.) | No | Yes |
| `SaveAddress` | Boolean | Indicates that the current address should be saved in the Merchant platform | No | |
| `StateCode` | String | State or province ISO code such as AZ for Arizona (if applicable) | No | Yes |
| `StateOrProvice` | String | State or province name | No | Yes |
| `Zip` | String | Zip or postal code | No | Yes |
### Merchant.Discount
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `CouponCode` | String | Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only) | No | Yes |
| `Description` | String | Discount textual description | No | Yes |
| `DiscountCode` | String | Discount code originally specified in the `Discount.DiscountCode` property of the respective discount in `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `DiscountSource` | Enum | The enum DiscountSource has the following possible values:
1 = Merchant
2 = FixedShippingPrice
3 = PercentageCartPrice
4 = HiddenForceDDP
5 = Amend
6 = RemoteAreaSurchargeSubsidy
7 = LoyaltyPoints
8 = PaymentCharge
9 = ReplacementOrder | Yes | |
| `DiscountType` | Decimal | Discount type (“Cart”, “Shipping”, etc.), as defined in the `DiscountTypeOptions` enumeration described in the Discount class in this document. | | Yes |
| `InternationalPrice` | Decimal | Discount value in end customer’s currency (specified in `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, and `IncludeVAT` handling. | No | Yes |
| `LocalVATRate` | Decimal | The VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if `UseCountryVAT` for the current Country is TRUE and therefore the `VATRate` property denotes the VAT for the target country. | No | Yes |
| `LoyaltyVoucherCode` | String | Loyalty Voucher code originally specified in `Discount.LoyaltyVoucherCode` property of the respective discount in `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Name` | String | Discount name | | Yes |
| `Price` | Decimal | Discount value in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `ProductCartItemId` | String | Identifier of the product cart item related to this discount on the Merchant’s site originally specified in the `Discount.ProductCartItemId` property of the respective discount in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `VATRate` | Decimal | The VAT rate applied to this discount | | Yes |
### Merchant.InternationalDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `CardNumberLastFourDigits` | String | The last 4 digits of the Card number (if applicable). | No | |
| `CashOnDeliveryFee` | Decimal | The additional charge is paid by the end customer when the “Cash on Delivery” payment method has been selected. | No | |
| `ConsignmentFee` | Decimal | The consignment fee is paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `CurrencyCode` | String | 3-char ISO code for the currency selected by the end customer for the order payment. | | |
| `CustomerDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes parts the customer paid for the order in the currency denoted by `CurrencyCode`. | No | Yes |
| `DeliveryDaysFrom` | Decimal | The minimum number of days for delivery to the end customer for the selected shipping method. | No | |
| `DeliveryDaysTo` | Decimal | The maximum number of days for delivery to the end customer for the selected shipping method. | No | |
| `DiscountedShippingPrice` | Decimal | The price paid by the customer in local currency. Total Shipping price reducing Order Discounts International price. | | |
| `DutiesGuaranteed` | Bool | Indicates if the end customer has selected the “guaranteed duties and taxes” option. | | |
| `ExpirationDate` | string | Card expiration date in YYYY-MM-DD format (if applicable). | No | |
| `MerchantDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes parts the Merchant subsidized for the order in the currency denoted by `CurrencyCode`. | No | Yes |
| `OrderTrackingNumber` | String | Tracking number used by the selected international shipping method for this order. | No | |
| `OrderTrackingUrl` | String | Full tracking URL including `OrderTrackingNumber` used by the selected international shipping method for this order. | No | |
| `OrderWaybillNumber` | String | Waybill number used by the selected international shipping method for this order. | No | |
| `ParcelsTracking` | List of `Merchant.ParcelTracking` | List of `Merchant.ParcelTracking` objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number). | | |
| `PaymentMethodCode` | String | Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global‑e payment method code will be specified instead. | | |
| `PaymentMethodName` | String | Name of the selected payment method. | | |
| `RemoteAreaSurcharge` | Decimal | Remote area surcharge paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `SameDayDispatchCost` | Decimal | Cost of the “Same Day Dispatch” option (if selected by the end customer on Global‑e checkout), in the currency denoted by `CurrencyCode`. This value is NOT included in `TotalShippingPrice`. | No | |
| `ShippingMethodCode` | String | Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global‑e shipping method code will be specified instead. | | |
| `ShippingMethodName` | String | Name of the selected international shipping method. | | |
| `ShippingMethodStatusCode` | String | Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on the Global‑e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global‑e shipping status code will be specified instead. | No | |
| `ShippingMethodStatusName` | String | Name of the shipping status. | No | |
| `ShippingMethodTypeCode` | String | Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method type does not exist on the Merchant’s site, the internal Global‑e shipping method type code will be specified instead. | | |
| `ShippingMethodTypeName` | String | Name of the selected international shipping method type. | | |
| `ShippingVATRate` | Decimal | The shipping VAT rate for the customer. This rate is applied to the shipping cost. | | Yes |
| `SizeOverchargeValue` | Decimal | Oversized items charge paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `TotalCCFPrice` | Decimal | Total Customs Clearance Fees value in the currency denoted by `CurrencyCode`. This value is included in `TotalDutiesPrice`. | No | |
| `TotalDutiesPrice` | Decimal | Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by `CurrencyCode`. | | |
| `TotalPrice` | Decimal | Total order price in the currency denoted by `CurrencyCode`. | | |
| `TotalShippingPrice` | Decimal | Total shipping price in the currency denoted by `CurrencyCode`. | | |
| `TotalVATAmount` | Decimal | Amount of VAT paid by the customer to Global‑e | | |
| `TransactionCurrencyCode` | String | 3-char ISO code for the currency actually used for the current order payment. `TransactionCurrencyCode` may differ from `CurrencyCode` if the currency selected by the end customer could not be used with the selected payment method. | | |
| `TransactionTotalPrice` | Decimal | Total order price actually paid by the end customer in the currency denoted by `TransactionCurrencyCode`. | | |
| `USSalesTax` | Decimal | Sales tax value for the USA in the currency denoted by `CurrencyCode`. This value is included in TotalDutiesPrice. | | |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Parcel
| Parameter Name | Type | Description | Mandatory |
| ---------------- | -------------------------------- | ---------------------------------------- | --------- |
| `Code` | String | Parcel code. | |
| `ParcelStatusId` | Decimal | Parcel status id. | |
| `StatusName` | String | Parcel status name. | |
| `TrackingUrl` | String | Direct tracking URL. | |
| `Products` | List of `Merchant.ParcelProduct` | List of products included in the parcel. | |
### Merchant.ParcelProduct
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------- | ---------------------------------------- | --------- |
| `CartItemId` | String | Cart item id of the product. | |
| `Quantity` | Decimal | Product quantity included in the parcel. | |
| `Sku` | String | Product SKU. | |
### Merchant.OriginalOrder
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------- | ------ | ---------------------------------------------------------------------------------- | --------- | -------- |
| `MerchantInternalOrderId` | String | `InternalOrderId` returned from `SendOrderToMerchant` call for the original order. | No | Yes |
| `MerchantOrderId` | String | `OrderId` returned from `SendOrderToMerchant` call for the original order. | No | Yes |
| `OrderId` | String | Global‑e order unique identifier for the original order. | | |
### Merchant.Parcel
| Parameter Name | Type | Description | Mandatory |
| ---------------- | -------------------------------- | ---------------------------------------- | --------- |
| `Code` | String | Parcel code. | |
| `ParcelStatusId` | Decimal | Parcel status id. | |
| `StatusName` | String | Parcel status name. | |
| `TrackingUrl` | String | Direct tracking URL. | |
| `Products` | List of `Merchant.ParcelProduct` | List of products included in the parcel. | |
### Merchant.ParcelProduct
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------- | ---------------------------------------- | --------- |
| `CartItemId` | String | Cart item id of the product. | |
| `Quantity` | Decimal | Product quantity included in the parcel. | |
| `Sku` | String | Product SKU. | |
### Merchant.PaymentDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ----------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -------- |
| `Address1` | String | Address line 1 | No | Yes |
| `Address2` | String | Address line 2 | No | Yes |
| `CardNumber` | String | Card number | | Yes |
| `City` | String | City name | No | Yes |
| `CountryCode` | String | 2-char ISO country code | | Yes |
| `CountryName` | String | Country name | | Yes |
| `CVVNumber` | String | Card CVV number | | Yes |
| `Email` | String | E-mail address | No | Yes |
| `ExpirationDate` | String | Card expiration date (in YYYY-MM-DD format) | | Yes |
| `Fax` | String | Fax | No | Yes |
| `OwnerFirstName` | String | Card owner’s first name | Optional if `OwnerName` is specified | Yes |
| `OwnerLastName` | String | Card owner’s last name | Optional if `OwnerName` is specified | Yes |
| `OwnerName` | String | Card owner’s full name (the Merchant may choose to consider either full name or first name with the last name, according to the existing payment method input validation requirements). | No | Yes |
| `PaymentMethodCode` | String | Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `PaymentMethodName` | String | Payment method name | | Yes |
| `PaymentMethodTypeCode` | String | Payment method type’s code used to identify the payment method type (such as Credit Card or Check) on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `Phone1` | String | Phone #1 | No | Yes |
| `Phone2` | String | Phone #2 | No | Yes |
| `StateCode` | String | State or province ISO code such as AZ for Arizona (if applicable) | No | Yes |
| `StateOrProvice` | String | State or province name | No | Yes |
| `Zip` | String | Zip or postal code | No | Yes |
### Merchant.Product
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------------------------------ | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `Attributes` | List of `Merchant.CartProductAttribute` | Custom attributes describe products that customers can personalize according to what the site offers. Each Attribute holds a key to specify attribute name and Value properties. | No | Yes |
| `BackOrderDate` | String | Estimated date for the backordered item to be in stock | No | Yes |
| `Brand` | Object `Merchant.Brand` | Product’s brandSku | No | |
| `CartItemId` | String | Identifier of the cart item on the Merchant’s site originally specified in the `Product.CartItemId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `CartItemOptionId` | String | Identifier of the child cart item “option” on the Merchant’s site originally specified in the `Product.CartItemOptionId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Categories` | List of `Merchant.Category` | List of product categories | No | |
| `CustomerVATRate` | Decimal | The customer VAT rate applied to this product | | Yes |
| `DiscountedPrice` | Decimal | The product value is in Merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product’s refund. | | Yes |
| `DiscountedPriceForCustoms` | Decimal | Product price in Merchant currency reflects the price after Reverse D\&T calculation. | | Yes |
| `DTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes per item in Merchant currency. | No | Yes |
| `GenericHSCode` | String | Product’s HS code | No | Yes |
| `GiftMessage` | String | Text originally specified in the `Product.GiftMessage` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `HandlingCode` | String | Code originally specified in `Product.HandlingCode` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `InternationalDiscountedPrice` | Decimal | The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product’s refund. | | Yes |
| `InternationalDiscountedPriceForCustoms` | Decimal | Product price in customer currency reflects the price after Reverse D\&T calculation | | Yes |
| `InternationalDiscountedPriceInMerchantCurrency` | Decimal | Product Price in Merchant currency | | Yes |
| `InternationalDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes per item in customer currency. | No | Yes |
| `InternationalListPrice` | Decimal | Single product list price in end customer’s currency (specified in the `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. | No | Yes |
| `InternationalPrice` | Decimal | Single product final sale price in end customer currency (specified in InternationalDetails.CurrencyCode property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. | No | Yes |
| `IsBackOrdered` | Bool | Identifies if the product was ordered as a backed ordered itemTRUE - Product is back-ordered.FALSE - Product is not back-ordered. | No | Yes |
| `LineItemInternationalPrice` | Decimal | Line item (product in ordered quantity) price in end customer’s currency (specified in the `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. If not specified, should be deemed equal to “InternationalPrice \* Quantity”. If specified, should take preference over InternationalPrice. | No | |
| `LineItemPriceBeforeGlobalEDiscount`- DEPRECATED | Decimal | Line item (product in ordered quantity) price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If not specified, should be deemed equal to “PriceBeforeGlobalEDiscount \* Quantity”. If specified, should take preference over `PriceBeforeGlobalEDiscount`. | No | |
| `ListPrice` | Decimal | Single product List price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `Name` | String | Name of the product. Returned by `GetOrdersDetails` API only | No | Yes |
| `ParentCartItemId` | String | Identifier of the current item’s parent cart item on the Merchant’s site originally specified in the `Product.ParentCartItemId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Price` | Decimal | Single product final sale price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `PriceBeforeGlobalEDiscount`- DEPRECATED | Decimal | Single product price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If no Global‑e discount was applied, `PriceBeforeGlobalEDiscount` is equal to Price. | No | Yes |
| `ProductAttributes` | List of `Merchant.ProductAttribute` | Product attributes. Returned by `GetOrdersDetails` API only | No | Yes |
| `Quantity` | Decimal | Product quantity in the order that is currently being submitted to the Merchant. | | Yes |
| `RoundingRate` | Decimal | The conversion rate applied to this product price 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. | | Yes |
| `Sku` | String | SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `VATRate` | Decimal | The VAT rate applied to this product | | Yes |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Brand
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | ----------- | --------- |
| `BrandCode` | String | Brand code | |
| `Name` | String | Brand name | |
### Merchant.Category
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | ---------------------- | --------- |
| `CategoryCode` | String | Merchant category code | |
| `Name` | String | Merchant category name | |
### Merchant.CartProductAttribute
| Parameter Name | Type | Description | Mandatory |
| ---------------- | ------ | --------------------------------------------------------------------------------- | --------- |
| `AttributeKey` | String | Custom product attribute name that is used to describe the personalized product. | |
| `AttributeValue` | String | Custom product attribute value that is used to describe the personalized product. | |
### Merchant.ProductAttribute
| Parameter Name | Type | Description | Mandatory |
| ---------------- | ------ | ----------------------------------------------------------------------------- | --------- |
| `AttributeKey` | String | Customized product attribute name, used to describe the personalized product. | |
| `AttributeValue` | String | Customized product attribute, used to describe the personalized product. | |
### OrderDocument
| Parameter Name | Type | Description | Mandatory | GEM Only |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | -------- |
| `CreationDateTime` | DateTime | The date and time the document was created. | No | |
| `DocumentData` | String | Base64 encoded byte array representing the document file content. | | |
| `DocumentExtension` | String | Document extension (PDF, ZPL, EPL). | | Yes |
| `DocumentReference` | String | The reference provided by the government authorities to this document (such as MRN or ITN number). | No | |
| `DocumentTypeCode` | String | Document type code, this value can be:
CommercialInvoice = 1
PackingList = 2
ShipperManifest = 3
Label = 4
VATInvoice = 5
DangerousGoodDeclarationLink = 6
GELabel = 7
CustomerReceiptInvoice = 8
ArchibeLabel = 9
DeliveryAdvice = 10
EAD = 11 | | Yes |
| `DocumentTypeName` | String | Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`. | | Yes |
| `ErrorMessage` | String | Description of the error for this entity (order/parcel) if it happened. | No | Yes |
| `ParcelCode` | String | The parcel code related to the document. | No | |
| `ShippingServiceName` | String | The name of the shipping service for this document (relevant for `DispatchOrders` and `DispatchConsolidatedShipment`). | No | |
| `TrackingNumber` | String | Shipping tracking number associated with the document. | No | |
| `URL` | String | URL of the document. | | Yes |
### OrderPaymentMethod
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------ | --------- | -------- |
| `GiftCardFields` | String | Gift card fields | | Yes |
| `IsGiftCard` | Boolean | Indicates if the order payment method is a gift card.TRUE if using a gift card for paymentFALSE if not using a gift card | | Yes |
| `PaidAmountInCustomerCurrency` | Decimal | Amount that paid in customer’s currency | | Yes |
| `PaidAmountInMerchantCurrency` | Decimal | Amount paid in Merchant’s currency | | Yes |
| `PaymentMethodId` | Decimal | The ID for the payment method | | Yes |
| `PaymentMethodName` | String | Name of the payment method | | Yes |
### OrderStatusReason
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ----------------------- | ------ | ------------------------------------------------------------------------------------------------ | --------- | -------- |
| `Name` | String | Order status reason name | | Yes |
| `OrderStatusReasonCode` | String | Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side) | | Yes |
**Response**
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. |
### Merchant.ResponseInfo
| Parameter Name | Type | Description | Mandatory | GEM Only |
| --------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -------- |
| `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 | Yes |
| `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 | Yes |
| `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)
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.
* Merchant GUID - In request payload (required)
* Custom header (optional)
* IP whitelist (optional)
* HTTP Basic Authentication (optional)
* JWT (optional)
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.
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 |
### Merchant.Order
| Parameter Name | Type | Mandatory | Description | GEM Only |
| ----------------------------------------------- | -------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `AdditionalRequiredDocuments` | List of `OrderDocument` | | The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment. | Yes |
| `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 emailsFALSE - CustoCurrencyCodemer did not opt to receive emails | |
| `CartHash` | String | No | Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e. | Yes |
| `CartId` | String | No | 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. | Yes |
| `CashOnDeliveryFee` | Decimal | | Cash On Delivery fee amount in Merchant’s currency. | |
| `CCFPrice` | Decimal | | Customs Clearance Fees (CCF), in the Merchant currency. | Yes |
| `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 clearedFALSE - The end customer's cart does not have to be cleare | Yes |
| `CurrencyCode` | StringCustomer | | 3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency. | Yes |
| `CurrencyName` | String | No | Customer currency name. Returned by `GetOrdersDetails` API only | |
| `Customer` | Object `Merchant.Customer` | | The paying customer’s preferences (Global-e acts as a paying customer). | Yes |
| `CustomerComments` | String | | Holds the gift message. In the offline order flow, holds the product comment. | Yes |
| `CustomerComments` | String | No | Comments text entered by the end customer in Global‑e checkout. | |
| `CustomerDTBreakdown` | Object `DTBreakdown` | No | Contains the duties and tax parts the customer paid for the order. | |
| `DateCreated` | String | No | Order creation date and time. Returned by `GetOrdersDetails` API only. | |
| `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). | Yes |
| `Discounts` | List of `Merchant.Discount` | No | 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. | Yes |
| `DoNotChargeVAT` | Boolean | No | 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 chargedTRUE - VAT is charged | Yes |
| `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 | No | 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. | Yes |
| `InternationalDetails` | Object `Merchant.InternationalDetails` | No | 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. | Yes |
| `IsB2B` | Boolean | | Indicates if the order has a Company name and VAT registration number.TRUE - Order contains a company name and VAT registration numberFALSE - Order does not contain a company name and VAT registration number | |
| `IsFreeShipping` | Boolean | No | 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. | Yes |
| `IsMoto` | Boolean | | Indicates if the the customer is a customer support agent and an “Offline order” took placeTRUE - The customer is a customer support agent and an “Offline order” took placeFALSE - The customer is a regular customer | Yes |
| `IsReplacementOrder` | Boolean | | Indicates if the order is a replacement.TRUE - The order is a replacementFALSE - The order is not a replacement | |
| `IsSplitOrder` | Boolean | No | Indicates if the order should be handled as a split order (i.e. without consolidation).TRUE - Order will be splitFALSE - Order is not to be split | Yes |
| `IsTaxExemption` | Boolean | | Indicates if the order has a tax exemption.TRUE - Order has a tax exemptionFALSE - Order does not have a tax exemption | |
| `LoyaltyCode` | String | No | Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout. | Yes |
| `LoyaltyPointsEarned` | Decimal | No | 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. | Yes |
| `LoyaltyPointsSpent` | Decimal | No | 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). | Yes |
| `Markups` | List of `Merchant.Discount` | No | 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. | Yes |
| `MerchantDTBreakdown` | Object `DTBreakdown` | No | Contains the duties and tax parts that the Merchant subsidized for the order. | |
| `MerchantGUID` | String | | Unique identifier of the Merchant on Global-e. | Yes |
| `MerchantOrderId` | String | No | Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order. | |
| `ModifiedProduct` | String | | Holds the product’s SKU | Yes |
| `OrderCreationSource` | Decimal | | One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the [OrderCreationSource Table](/endpoints#UUID-8f008375-0438-09be-14ee-bf93d9f0bffa_N1736933585508). | |
| `OrderDocuments` | List of `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. | Yes |
| `OrderId` | String | | Global‑e order unique identifier. | Yes |
| `OrderPaymentMethods` | List of `OrderPaymentMethod` | | List of payment methods the customer use (Credit card, Gift Cards) | Yes |
| `OrderStatusReason` | Object `OrderStatusReason` | | Reason for the order status, why it was cancelled. | Yes |
| `OriginalOrder` | Object `Merchant.OriginalOrder` | No | Details that refer to the original order if the current order is a replacement. | Yes |
| `OTCurrencyCode` | String | No | Currency of the one-time voucher code used to place the order. | |
| `OTVoucherAmount` | Decimal | No | The amount taken off the voucher when applicable. | Yes |
| `OTVoucherCode` | String | No | One-time voucher code used to place the order | Yes |
| `Parcels` | List of `Merchant.Parcel` | No | The list of parcels created for the order. Returned by `GetOrdersDetails` API only. | |
| `PaymentDetails` | Object `Merchant.PaymentDetails` | | The paying customer’s payment details. | Yes |
| `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. | Yes |
| `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. | Yes |
| `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. | Yes |
| `Products` | List of `Merchant.Product` | | The list of products being purchased. | Yes |
| `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. | Yes |
| `SameDayDispatch` | Boolean | No | 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" | Yes |
| `SameDayDispatchCost` | Decimal | No | Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency. | Yes |
| `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. | Yes |
| `SecondaryShipping` | Object `Merchant.CustomerDetails` | | Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details. | Yes |
| `ShippingMethodCode` | String | No | 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. | Yes |
| `ShipToStoreCode` | StringExporterDetails | No | Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side). | Yes |
| `StatusCode` | String | | Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side). | Yes |
| `Subs` | List of `Merchant.Order` | | Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed. | Yes |
| `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. | Yes |
| `TotalDutiesPaidByCustomerPrice` | DecimalWebStoreInstanceCode | | The total amount of duties paid by the customer in the Merchant’s currency. | Yes |
| `UserId` | String | No | 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. | Yes |
| `USSalesTax` | Decimal | | Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`. | Yes |
| `WebStoreCode` | String | No | 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. | Yes |
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 |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Customer
| Parameter Name | Type | Description | Mandatory |
| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `IsEndCustomerPrimary` | Boolean | Indicates if end customer details are “swapped” with a paying (Global‑e) customer’s details when submitting the order to the Merchant. By default, `IsEndCustomerPrimary` is FALSE.TRUE - The primary customer is the same as the end customer who has placed the orderFALSE - The primary customer denotes the paying (Global‑e) customer and the secondary customer denotes the end customer who has placed the order with Global‑e checkout | Yes |
| `SendConfirmation` | Boolean | Indicates if e-mail confirmation of the respective order’s status change needs to be sent to the paying customer (Global‑e acts as a paying customer). | Yes |
### Merchant.CustomerDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------- | ------------------- | --------------------------------------------------------------------------- | --------- | -------- |
| `Address1` | String | Address line 1 | No | Yes |
| `Address2` | String | Address line 2 | No | Yes |
| `AddressBookId` | String | Id of the current address from within the address book | No | Yes |
| `AddressBookName` | String | Name of the current address from within the address book | No | Yes |
| `City` | String | City name | No | Yes |
| `Company` | String | Company name | No | Yes |
| `CountryCode` | StringCustomerTaxId | 2-char ISO country code | No | Yes |
| `CountryName` | String | Country name | No | Yes |
| `Email` | String | Email address | No | Yes |
| `Fax` | String | Fax | No | Yes |
| `FirstName` | String | First name | No | Yes |
| `FirstNameInLocalCulture` | String | First name in local culture | No | |
| `LastName` | String | Last name | No | Yes |
| `LastNameInLocalCulture` | String | Last name in local culture | No | |
| `MiddleName` | String | Middle name | No | Yes |
| `Phone1` | String | Phone #1 | No | Yes |
| `Phone2` | String | Phone #2 | No | Yes |
| `Salutation` | String | Salutation or title (e.g. Dr., Mr., etc.) | No | Yes |
| `SaveAddress` | Boolean | Indicates that the current address should be saved in the Merchant platform | No | |
| `StateCode` | String | State or province ISO code such as AZ for Arizona (if applicable) | No | Yes |
| `StateOrProvice` | String | State or province name | No | Yes |
| `Zip` | String | Zip or postal code | No | Yes |
### Merchant.Discount
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `CouponCode` | String | Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only) | No | Yes |
| `Description` | String | Discount textual description | No | Yes |
| `DiscountCode` | String | Discount code originally specified in the `Discount.DiscountCode` property of the respective discount in `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `DiscountSource` | Enum | The enum DiscountSource has the following possible values:
1 = Merchant
2 = FixedShippingPrice
3 = PercentageCartPrice
4 = HiddenForceDDP
5 = Amend
6 = RemoteAreaSurchargeSubsidy
7 = LoyaltyPoints
8 = PaymentCharge
9 = ReplacementOrder | Yes | |
| `DiscountType` | Decimal | Discount type (“Cart”, “Shipping”, etc.), as defined in the `DiscountTypeOptions` enumeration described in the Discount class in this document. | | Yes |
| `InternationalPrice` | Decimal | Discount value in end customer’s currency (specified in `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, and `IncludeVAT` handling. | No | Yes |
| `LocalVATRate` | Decimal | The VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if `UseCountryVAT` for the current Country is TRUE and therefore the `VATRate` property denotes the VAT for the target country. | No | Yes |
| `LoyaltyVoucherCode` | String | Loyalty Voucher code originally specified in `Discount.LoyaltyVoucherCode` property of the respective discount in `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Name` | String | Discount name | | Yes |
| `Price` | Decimal | Discount value in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `ProductCartItemId` | String | Identifier of the product cart item related to this discount on the Merchant’s site originally specified in the `Discount.ProductCartItemId` property of the respective discount in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `VATRate` | Decimal | The VAT rate applied to this discount | | Yes |
### Merchant.InternationalDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `CardNumberLastFourDigits` | String | The last 4 digits of the Card number (if applicable). | No | |
| `CashOnDeliveryFee` | Decimal | The additional charge is paid by the end customer when the “Cash on Delivery” payment method has been selected. | No | |
| `ConsignmentFee` | Decimal | The consignment fee is paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `CurrencyCode` | String | 3-char ISO code for the currency selected by the end customer for the order payment. | | |
| `CustomerDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes parts the customer paid for the order in the currency denoted by `CurrencyCode`. | No | Yes |
| `DeliveryDaysFrom` | Decimal | The minimum number of days for delivery to the end customer for the selected shipping method. | No | |
| `DeliveryDaysTo` | Decimal | The maximum number of days for delivery to the end customer for the selected shipping method. | No | |
| `DiscountedShippingPrice` | Decimal | The price paid by the customer in local currency. Total Shipping price reducing Order Discounts International price. | | |
| `DutiesGuaranteed` | Bool | Indicates if the end customer has selected the “guaranteed duties and taxes” option. | | |
| `ExpirationDate` | string | Card expiration date in YYYY-MM-DD format (if applicable). | No | |
| `MerchantDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes parts the Merchant subsidized for the order in the currency denoted by `CurrencyCode`. | No | Yes |
| `OrderTrackingNumber` | String | Tracking number used by the selected international shipping method for this order. | No | |
| `OrderTrackingUrl` | String | Full tracking URL including `OrderTrackingNumber` used by the selected international shipping method for this order. | No | |
| `OrderWaybillNumber` | String | Waybill number used by the selected international shipping method for this order. | No | |
| `ParcelsTracking` | List of `Merchant.ParcelTracking` | List of `Merchant.ParcelTracking` objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number). | | |
| `PaymentMethodCode` | String | Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global‑e payment method code will be specified instead. | | |
| `PaymentMethodName` | String | Name of the selected payment method. | | |
| `RemoteAreaSurcharge` | Decimal | Remote area surcharge paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `SameDayDispatchCost` | Decimal | Cost of the “Same Day Dispatch” option (if selected by the end customer on Global‑e checkout), in the currency denoted by `CurrencyCode`. This value is NOT included in `TotalShippingPrice`. | No | |
| `ShippingMethodCode` | String | Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global‑e shipping method code will be specified instead. | | |
| `ShippingMethodName` | String | Name of the selected international shipping method. | | |
| `ShippingMethodStatusCode` | String | Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on the Global‑e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global‑e shipping status code will be specified instead. | No | |
| `ShippingMethodStatusName` | String | Name of the shipping status. | No | |
| `ShippingMethodTypeCode` | String | Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method type does not exist on the Merchant’s site, the internal Global‑e shipping method type code will be specified instead. | | |
| `ShippingMethodTypeName` | String | Name of the selected international shipping method type. | | |
| `ShippingVATRate` | Decimal | The shipping VAT rate for the customer. This rate is applied to the shipping cost. | | Yes |
| `SizeOverchargeValue` | Decimal | Oversized items charge paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`. | No | |
| `TotalCCFPrice` | Decimal | Total Customs Clearance Fees value in the currency denoted by `CurrencyCode`. This value is included in `TotalDutiesPrice`. | No | |
| `TotalDutiesPrice` | Decimal | Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by `CurrencyCode`. | | |
| `TotalPrice` | Decimal | Total order price in the currency denoted by `CurrencyCode`. | | |
| `TotalShippingPrice` | Decimal | Total shipping price in the currency denoted by `CurrencyCode`. | | |
| `TotalVATAmount` | Decimal | Amount of VAT paid by the customer to Global‑e | | |
| `TransactionCurrencyCode` | String | 3-char ISO code for the currency actually used for the current order payment. `TransactionCurrencyCode` may differ from `CurrencyCode` if the currency selected by the end customer could not be used with the selected payment method. | | |
| `TransactionTotalPrice` | Decimal | Total order price actually paid by the end customer in the currency denoted by `TransactionCurrencyCode`. | | |
| `USSalesTax` | Decimal | Sales tax value for the USA in the currency denoted by `CurrencyCode`. This value is included in TotalDutiesPrice. | | |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Parcel
| Parameter Name | Type | Description | Mandatory |
| ---------------- | -------------------------------- | ---------------------------------------- | --------- |
| `Code` | String | Parcel code. | |
| `ParcelStatusId` | Decimal | Parcel status id. | |
| `StatusName` | String | Parcel status name. | |
| `TrackingUrl` | String | Direct tracking URL. | |
| `Products` | List of `Merchant.ParcelProduct` | List of products included in the parcel. | |
### Merchant.ParcelProduct
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------- | ---------------------------------------- | --------- |
| `CartItemId` | String | Cart item id of the product. | |
| `Quantity` | Decimal | Product quantity included in the parcel. | |
| `Sku` | String | Product SKU. | |
### Merchant.OriginalOrder
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------- | ------ | ---------------------------------------------------------------------------------- | --------- | -------- |
| `MerchantInternalOrderId` | String | `InternalOrderId` returned from `SendOrderToMerchant` call for the original order. | No | Yes |
| `MerchantOrderId` | String | `OrderId` returned from `SendOrderToMerchant` call for the original order. | No | Yes |
| `OrderId` | String | Global‑e order unique identifier for the original order. | | |
### Merchant.Parcel
| Parameter Name | Type | Description | Mandatory |
| ---------------- | -------------------------------- | ---------------------------------------- | --------- |
| `Code` | String | Parcel code. | |
| `ParcelStatusId` | Decimal | Parcel status id. | |
| `StatusName` | String | Parcel status name. | |
| `TrackingUrl` | String | Direct tracking URL. | |
| `Products` | List of `Merchant.ParcelProduct` | List of products included in the parcel. | |
### Merchant.ParcelProduct
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------- | ---------------------------------------- | --------- |
| `CartItemId` | String | Cart item id of the product. | |
| `Quantity` | Decimal | Product quantity included in the parcel. | |
| `Sku` | String | Product SKU. | |
### Merchant.PaymentDetails
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ----------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -------- |
| `Address1` | String | Address line 1 | No | Yes |
| `Address2` | String | Address line 2 | No | Yes |
| `CardNumber` | String | Card number | | Yes |
| `City` | String | City name | No | Yes |
| `CountryCode` | String | 2-char ISO country code | | Yes |
| `CountryName` | String | Country name | | Yes |
| `CVVNumber` | String | Card CVV number | | Yes |
| `Email` | String | E-mail address | No | Yes |
| `ExpirationDate` | String | Card expiration date (in YYYY-MM-DD format) | | Yes |
| `Fax` | String | Fax | No | Yes |
| `OwnerFirstName` | String | Card owner’s first name | Optional if `OwnerName` is specified | Yes |
| `OwnerLastName` | String | Card owner’s last name | Optional if `OwnerName` is specified | Yes |
| `OwnerName` | String | Card owner’s full name (the Merchant may choose to consider either full name or first name with the last name, according to the existing payment method input validation requirements). | No | Yes |
| `PaymentMethodCode` | String | Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `PaymentMethodName` | String | Payment method name | | Yes |
| `PaymentMethodTypeCode` | String | Payment method type’s code used to identify the payment method type (such as Credit Card or Check) on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `Phone1` | String | Phone #1 | No | Yes |
| `Phone2` | String | Phone #2 | No | Yes |
| `StateCode` | String | State or province ISO code such as AZ for Arizona (if applicable) | No | Yes |
| `StateOrProvice` | String | State or province name | No | Yes |
| `Zip` | String | Zip or postal code | No | Yes |
### Merchant.Product
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------------------------------ | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- |
| `Attributes` | List of `Merchant.CartProductAttribute` | Custom attributes describe products that customers can personalize according to what the site offers. Each Attribute holds a key to specify attribute name and Value properties. | No | Yes |
| `BackOrderDate` | String | Estimated date for the backordered item to be in stock | No | Yes |
| `Brand` | Object `Merchant.Brand` | Product’s brandSku | No | |
| `CartItemId` | String | Identifier of the cart item on the Merchant’s site originally specified in the `Product.CartItemId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `CartItemOptionId` | String | Identifier of the child cart item “option” on the Merchant’s site originally specified in the `Product.CartItemOptionId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Categories` | List of `Merchant.Category` | List of product categories | No | |
| `CustomerVATRate` | Decimal | The customer VAT rate applied to this product | | Yes |
| `DiscountedPrice` | Decimal | The product value is in Merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product’s refund. | | Yes |
| `DiscountedPriceForCustoms` | Decimal | Product price in Merchant currency reflects the price after Reverse D\&T calculation. | | Yes |
| `DTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes per item in Merchant currency. | No | Yes |
| `GenericHSCode` | String | Product’s HS code | No | Yes |
| `GiftMessage` | String | Text originally specified in the `Product.GiftMessage` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `HandlingCode` | String | Code originally specified in `Product.HandlingCode` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `InternationalDiscountedPrice` | Decimal | The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product’s refund. | | Yes |
| `InternationalDiscountedPriceForCustoms` | Decimal | Product price in customer currency reflects the price after Reverse D\&T calculation | | Yes |
| `InternationalDiscountedPriceInMerchantCurrency` | Decimal | Product Price in Merchant currency | | Yes |
| `InternationalDTBreakdown` | Object `DTBreakdown` | Contains the duties and taxes per item in customer currency. | No | Yes |
| `InternationalListPrice` | Decimal | Single product list price in end customer’s currency (specified in the `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. | No | Yes |
| `InternationalPrice` | Decimal | Single product final sale price in end customer currency (specified in InternationalDetails.CurrencyCode property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. | No | Yes |
| `IsBackOrdered` | Bool | Identifies if the product was ordered as a backed ordered itemTRUE - Product is back-ordered.FALSE - Product is not back-ordered. | No | Yes |
| `LineItemInternationalPrice` | Decimal | Line item (product in ordered quantity) price in end customer’s currency (specified in the `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, rounding rule (if applicable), and `IncludeVAT` handling. If not specified, should be deemed equal to “InternationalPrice \* Quantity”. If specified, should take preference over InternationalPrice. | No | |
| `LineItemPriceBeforeGlobalEDiscount`- DEPRECATED | Decimal | Line item (product in ordered quantity) price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If not specified, should be deemed equal to “PriceBeforeGlobalEDiscount \* Quantity”. If specified, should take preference over `PriceBeforeGlobalEDiscount`. | No | |
| `ListPrice` | Decimal | Single product List price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `Name` | String | Name of the product. Returned by `GetOrdersDetails` API only | No | Yes |
| `ParentCartItemId` | String | Identifier of the current item’s parent cart item on the Merchant’s site originally specified in the `Product.ParentCartItemId` property of the respective product in the `SendCart` method for the cart converted to this order on Global‑e. | No | Yes |
| `Price` | Decimal | Single product final sale price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant. | | Yes |
| `PriceBeforeGlobalEDiscount`- DEPRECATED | Decimal | Single product price in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If no Global‑e discount was applied, `PriceBeforeGlobalEDiscount` is equal to Price. | No | Yes |
| `ProductAttributes` | List of `Merchant.ProductAttribute` | Product attributes. Returned by `GetOrdersDetails` API only | No | Yes |
| `Quantity` | Decimal | Product quantity in the order that is currently being submitted to the Merchant. | | Yes |
| `RoundingRate` | Decimal | The conversion rate applied to this product price 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. | | Yes |
| `Sku` | String | SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side). | | Yes |
| `VATRate` | Decimal | The VAT rate applied to this product | | Yes |
### DTBreakdown
| Parameter Name | Type | Description | Mandatory | GEM Only |
| -------------- | ------- | ------------------------------- | --------- | -------- |
| `Duties` | Decimal | Duties that are applied. | | Yes |
| `Other` | Decimal | Other DT fees that are applied. | No | Yes |
| `SalesTaxes` | Decimal | Sales taxes that are applied. | | |
### Merchant.Brand
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | ----------- | --------- |
| `BrandCode` | String | Brand code | |
| `Name` | String | Brand name | |
### Merchant.Category
| Parameter Name | Type | Description | Mandatory |
| -------------- | ------ | ---------------------- | --------- |
| `CategoryCode` | String | Merchant category code | |
| `Name` | String | Merchant category name | |
### Merchant.CartProductAttribute
| Parameter Name | Type | Description | Mandatory |
| ---------------- | ------ | --------------------------------------------------------------------------------- | --------- |
| `AttributeKey` | String | Custom product attribute name that is used to describe the personalized product. | |
| `AttributeValue` | String | Custom product attribute value that is used to describe the personalized product. | |
### Merchant.ProductAttribute
| Parameter Name | Type | Description | Mandatory |
| ---------------- | ------ | ----------------------------------------------------------------------------- | --------- |
| `AttributeKey` | String | Customized product attribute name, used to describe the personalized product. | |
| `AttributeValue` | String | Customized product attribute, used to describe the personalized product. | |
### OrderDocument
| Parameter Name | Type | Description | Mandatory | GEM Only |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | -------- |
| `CreationDateTime` | DateTime | The date and time the document was created. | No | |
| `DocumentData` | String | Base64 encoded byte array representing the document file content. | | |
| `DocumentExtension` | String | Document extension (PDF, ZPL, EPL). | | Yes |
| `DocumentReference` | String | The reference provided by the government authorities to this document (such as MRN or ITN number). | No | |
| `DocumentTypeCode` | String | Document type code, this value can be:
CommercialInvoice = 1
PackingList = 2
ShipperManifest = 3
Label = 4
VATInvoice = 5
DangerousGoodDeclarationLink = 6
GELabel = 7
CustomerReceiptInvoice = 8
ArchibeLabel = 9
DeliveryAdvice = 10
EAD = 11 | | Yes |
| `DocumentTypeName` | String | Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`. | | Yes |
| `ErrorMessage` | String | Description of the error for this entity (order/parcel) if it happened. | No | Yes |
| `ParcelCode` | String | The parcel code related to the document. | No | |
| `ShippingServiceName` | String | The name of the shipping service for this document (relevant for `DispatchOrders` and `DispatchConsolidatedShipment`). | No | |
| `TrackingNumber` | String | Shipping tracking number associated with the document. | No | |
| `URL` | String | URL of the document. | | Yes |
### OrderPaymentMethod
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------ | --------- | -------- |
| `GiftCardFields` | String | Gift card fields | | Yes |
| `IsGiftCard` | Boolean | Indicates if the order payment method is a gift card.TRUE if using a gift card for paymentFALSE if not using a gift card | | Yes |
| `PaidAmountInCustomerCurrency` | Decimal | Amount that paid in customer’s currency | | Yes |
| `PaidAmountInMerchantCurrency` | Decimal | Amount paid in Merchant’s currency | | Yes |
| `PaymentMethodId` | Decimal | The ID for the payment method | | Yes |
| `PaymentMethodName` | String | Name of the payment method | | Yes |
### OrderStatusReason
| Parameter Name | Type | Description | Mandatory | GEM Only |
| ----------------------- | ------ | ------------------------------------------------------------------------------------------------ | --------- | -------- |
| `Name` | String | Order status reason name | | Yes |
| `OrderStatusReasonCode` | String | Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side) | | Yes |
### Examples
```
{
"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": ""
}
}
```
```
{
"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":"service@global-e.com",
"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":"test@test.com",
"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":"service@global-e.com",
"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"
}
```