Webhooks

ClientApplyLoyaltyVouchers (Global-e to Merchant)

Note

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

Use this method to validate the Loyalty Vouchers selected by the user from the list that has been provided in the loyaltyVouchersList argument of the SendCart API call for the current user’s checkout page. This method can only be executed from within the context of the current user’s client session. Validates Loyalty Vouchers and applies them to the current user’s cart if all the vouchers in the list are valid and applicable.

If at least one Loyalty Voucher in the list is invalid, Merchant.ResponseInfo.Success is set to FALSE.
If all Loyalty Vouchers are valid, the Merchant’s server should re-calculate the cart pricing and execute before returning a response, the SendCart API call with the CartToken argument value returned from the previous call to SendCart for the current user.

Method/URL

https://www.merchant-site-domain.com/ClientApplyLoyaltyVouchers

Parameters

Request

Name	Type	Description	Mandatory
`cartAction`	Object Merchant.CartAction	Delineates what action to perform with the cart data.	Yes

Response

Name	Type	Description	Mandatory
`Merchant.ResponseInfo`	Object `Merchant.ResponseInfo`	Describes the response to the API call. In case of an error, indicates the error.

Objects for ClientApplyLoyaltyVouchers API

Object Merchant.CartAction

Parameter Name	Type	Description	Mandatory
`CartHash`	String	Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method preceding the current cart action.	No
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in the `merchantCartToken` argument for the `SendCart` method preceding the current cart action.	No
`CartToken`	String	Cart token for the cart generated on the Global‑e side by the `SendCart` method preceding the current cart action. This property is mandatory only for server-side calls.	No
`LoyaltyVouchers`	String	A JSON-serialized array of Loyalty Voucher codes to be applied to the cart. This list is mandatory only in the `ClientApplyLoyaltyVouchers` method.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e. This property is mandatory only for server-side calls.	No
`UserId`	String	Internal User identifier on the Merchant’s site originally specified in the shipping `details.UserId` argument for the `SendCart` method preceding the current cart action.	No

Object Merchant.ResponseInfo

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

Examples

GetCheckoutCartInfo (Global-e to Merchant)

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

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

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

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

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

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

Note

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

Method/URL

Client-side: GET

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

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

Parameters

Request

Requests can contain more parameters than listed.

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

Response

Returns all cart contents, including customer information for logged-in customers.

Note

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

Name	Type	Description
`CheckoutCartInfo`	Object `CheckoutCartInfo`	Retrieves cart information

Object CheckoutCartInfo

Parameter Name	Type	Description	Mandatory
`allowMailsFromMerchant`	Boolean	Indicates if the end customer’s consent to receive emails from merchants should be pre-selected in the Global‑e Checkout. TRUE - Customer consents to receive emails. FALSE - Customer does not consent to receive emails.	No
`billingDetails`	Object `UserDetails`	Billing details of a registered user (if available on the Merchant’s site). If the `userDetails` property mentioned below is specified, then `billingDetails` will be ignored.	No
`clientIP`	String	The end customer’s IP address	No
`CountryCode`	String	2-char ISO country code of the shipping country either pre-defined using geo-location or actively selected by the end customer. This may be different from `shippingDetails.CountryCode` denoting the registered user’s country.	No
`cultureCode`	String	ISO culture code. If specified, the textual properties will be returned in the requested culture’s language if available. Texts in English will be returned by default.	No
`currencyCode`	String	3-char ISO currency code denoting the end customer’s currency. If not specified, the Merchant’s default currency will be assumed by default.	No
`discountList`	List 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
`originalCurrencyCode`	String	3-char ISO currency code denoting the original currency on the Merchant’s site (before applying country coefficient and FX conversion). If not specified, the Merchant’s default currency will be assumed by default.	No
`otVoucherAmount`	Decimal	Amount of the one-time voucher in `otVoucherCurrencyCode` currency.	No
`otVoucherCode`	String	One-time voucher code for the cart (for applicable platforms).	No
`otVoucherCurrencyCode`	String	One-time voucher currency used for the amount.	No
`paymentInstallments`	String	List of available payment instalment amounts. For example: {2,4,6,8} – This indicates that we should allow instalmentsin 2, 4, 6 or 8 instalment options (to be selected by the customer).	No
`prodectsList`	List 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 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 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 call for this cart, `urlParameters` should include the following `KeyValuePair: [{"Key":"locale", "Value":"en-AU"}]`. In this example “locale” parameter should be configured for `SendOrderToMerchant` URL for this merchant on the Global‑e side.	No
`userDetails`	Object `CartUserDetails`	All available details of the user including all relevant addresses. If `userDetails` is not specified, then `shippingDetails` and `billingDetails` properties will be used instead. `userDetails` property can be used by merchants who support multiple shipping and/or multiple billing addresses in the user’s account.	No
`vatRegistrationNumber`	String	VAT Registration Number of the end customer’s business entity validated with the merchant.	No
`webStoreCode`	nvarchar	Code used on the merchant’s side to identify the web store where the current cart is originating. This code should be used when a multi-store setup is on the merchant’s site. Max length: 100	No
`webStoreInstanceCode`	String	Code used on the merchant’s side to identify the web store instance where the current cart is originating from. This code should be used in case of multi-store domains set up on the merchant’s site.	No

Object 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

Object AddressDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1.	No
`Address2`	String	Address line 2.	No
`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
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`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
`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

Object 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)

Object 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`	Decimal	One of the following possible values of `DiscountTypeOptions` enumeration denoting a type of discount: Cart discount Shipping discount Loyalty points discount Duties discount Checkout Loyalty points discount Payment charge	No
`InternationalPrice`	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
`Price`	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	Yes

Object 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

Object 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

Object 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 ordered FALSE - 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 shipping FALSE - 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 checkout TRUE - The product represents a virtual product FALSE - 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
`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

Object Attributes

Parameter Name	Type	Description
`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

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

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

Object 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)

Object Attributes

Parameter Name	Type	Description
`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

Object 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)

Object 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)

Object ShippingOption

Parameter Name	Type	Description
`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`)

Object 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

Object 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": "[email protected]",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "doe",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    },
    "shippingDetails": {
        "UserId": "1144404",
        "Email": "[email protected]",
        "Salutation": "",
        "FirstName": "john",
        "LastName": "winer",
        "Address1": "basel 25",
        "Address2": "",
        "City": "petah tikva",
        "StateOrProvince": "",
        "Zip": "11223344",
        "CountryCode": "ISR",
        "CountryName": "Israel",
        "Phone1": "0000000000",
        "Phone2": ""
    }
}

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

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

NotifyOrderRefund (Global-e to Merchant)

The NotifyOrderRefund method notifies the merchant about Global-e initiated refunds issued to the shopper.

If implemented on the merchant’s site, the Global‑e servers post the information about customer refunds, in cases where such refunds are initiated on the Global‑e side.

Method/URL

https://www.merchant-site-domain/order-refund-url

Parameters

Request

Requests can contain more parameters than listed.

Name	Type	Description	Mandatory
order	Object `Merchant.OrderRefund`	Contains information about order refunds.	Yes

Object Merchant.OrderRefund

Parameter Name	Type	Description	Mandatory
`Components`	List of `Merchant.RefundComponent`	The list of `RefundComponent` objects for this order refund.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.	No
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	No
`MerchantRMANumber`	String	The Merchant’s Returned Merchandize Authorization Number	No
`OrderId`	String	Global‑e order unique identifier.	Yes
`OriginalTotalRefundAmount`	Decimal	The refund amount in the original Merchant currency including the local Merchant’s VAT (currency is specified in `CurrencyCode` property of the respective `Merchant.Order`).	Yes
`Products`	List of `Merchant.RefundProduct`	List of `RefundProduct` objects for this order refund.	No
`RefundComments`	String	Comments for the order refund	No
`RefundReason`	Object `Merchant.OrderRefundReason`	Reason for the order refund	No
`RMANumber`	String	The RMA number taken from the related Return.	No
`ServiceGestureAmount`	Decimal	The “Service gesture” amount in the customer’s currency is included in the `TotalRefundAmount`. “Service gesture” denotes any additional refund granted to the user, on top of the refund related to other components.	No
`TotalRefundAmount`	Decimal	The total refund amount in the end customer’s currency used for this order’s payment (currency is specified in InternationalDetails.`CurrencyCode`property for the respective `Merchant.Order`).	Yes
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store, as specified in the `WebStoreCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No

Object Merchant.OrderRefundReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order refund reason name.
`OrderRefundReasonCode`	String	Code denoting the order refund reason on the Merchant’s site (to be mapped on the Global‑e side). If not mapped, Global‑e internal code will be specified instead.

Object Merchant.RefundComponent

Parameter Name	Type	Description
`Amount`	Decimal	The refund amount in customer currency.
`ComponentType`	String	Products, Shipping, Duties, `PrepaidReturn` or `ServiceGesture`.
`IsChargedToMerchant`	Boolean	Indicates if the component is charged to the Merchant or to Global-e. TRUE - Component is charged to the Merchant (default) FALSE - Component is charged to Global‑e If the same component is split between charged to the Merchant and charged to Global‑e, it should appear twice, each time with a different value in `IsChargedToMerchant`. Exception: A component `PrepaidReturn` – it should always be `IsChargedToMerchant` = TRUE.
`OriginalAmount`	Decimal	The refund amount in Merchant currency.

Object Merchant.RefundProduct

Parameter Name	Type	Description	Mandatory
`CartItemID`	String	Identifier of the line item on the Merchant’s site. This property is mandatory and should be equal to the respective Product’s `CartItemId` originally specified in the `SendCart` API for the order being refunded	Yes
`OriginalRefundAmount`	Decimal	The refund amount in the original Merchant currency including the local Merchant’s VAT for this product line item, before applying any price modifications (i.e. part of or the full value paid by Global-e to the Merchant, as was specified in `Merchant.Product.Price` for the respective order.
`ProductCode`	String	Product SKU or Product Variant ID according to merchant configuration. Can be used as a Product Identifier instead of `CartItemId`. If there are multiple products with the same identifier, we choose one of them arbitrarily.	No
`RefundAmount`	Decimal	The refund amount for this product line item in customer currency used for the payment of this order
`RefundComments`	String	Comments for this product’s refund	No
`RefundQuantity`	Decimal	Product quantity (i.e. a part of the originally ordered quantity) that the refund refers to
`RefundReason`	Object `Merchant.OrderRefundReason`	Reason for this product’s refund	No
`Sku`	String	This field is obsolete. Use `ProductCode` instead.	No

Object Merchant.OrderRefundReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order refund reason name.
`OrderRefundReasonCode`	String	Code denoting the order refund reason on the Merchant’s site (to be mapped on the Global‑e side). If not mapped, Global‑e internal code will be specified instead.

Response

Note

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

Name	Type	Description	Mandatory
Merchant.ResponseInfo	Object `Merchant.ResponseInfo`	Provides response data regarding the API call.

Merchant.ResponseInfo

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

Example

{
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
    "MerchantOrderId": "14123332",
    "Products": [{
            "CartItemId": 12365,
            "RefundQuantity": "3",
            "OriginalRefundAmount": "114.5300",
            "RefundAmount": "170.1000",
            "RefundReason": {
                "OrderRefundReasonCode": "DAMAGED-ITEM-CODE",
                "Name": "Damaged Item"
            },
            "RefundComments": "Fully refunded order"
        }
    ],
    "OrderId": "GE69488861GB",
    "RefundId": 789,
    "RMANumber": 6543,
    "CurrencyCode": “CAD”,
    "OriginalCurrencyCode": “USD”,
    "TotalRefundAmount": "170.10",
    "RefundReason": {
        "OrderRefundReasonCode": "DAMAGED-ITEM-CODE",
        "Name": "Damaged Item"
    },
    "RefundComments": "Fully refunded order",
    "OriginalTotalRefundAmount": "114.53",
    "ServiceGestureAmount": "0.00",
    "WebStoreCode": null
}

PerformOrderPayment (Global-e to Merchant)

Note

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

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

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

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

Method/URL

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

Parameters

Request

Requests can contain more parameters than listed.

Note

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

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

Object Merchant.Order

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

OrderCreationSource

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

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

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Object 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 order FALSE - 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
`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).

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 order

FALSE - 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

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

Object Merchant.CustomerDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`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
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name	No
`Email`	String	Email address	No
`Fax`	String	Fax	No
`FirstName`	String	First name	No
`FirstNameInLocalCulture`	String	First name in local culture	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
`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
`StateOrProvice`	String	State or province name	No
`Zip`	String	Zip or postal code	No

Object Merchant.Discount

Parameter Name	Type	Description	Mandatory
`CouponCode`	String	Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only)	No
`Description`	String	Discount textual description	No
`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
`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.
`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
`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
`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
`Name`	String	Discount name
`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.
`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
`VATRate`	Decimal	The VAT rate applied to this discount

Object Merchant.InternationalDetails

Parameter Name	Type	Description	Mandatory
`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
`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
`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.
`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.

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Object Merchant.Parcel

Parameter Name	Type	Description
`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.

Object Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Object Merchant.OriginalOrder

Parameter Name	Type	Description	Mandatory
`MerchantInternalOrderId`	String	`InternalOrderId` returned from `SendOrderToMerchant` call for the original order.	No
`MerchantOrderId`	String	`OrderId` returned from `SendOrderToMerchant` call for the original order.	No
`OrderId`	String	Global‑e order unique identifier for the original order.

Object Merchant.Parcel

Parameter Name	Type	Description
`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.

Object Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Object Merchant.PaymentDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`CardNumber`	String	Card number
`City`	String	City name	No
`CountryCode`	String	2-char ISO country code
`CountryName`	String	Country name
`CVVNumber`	String	Card CVV number
`Email`	String	E-mail address	No
`ExpirationDate`	String	Card expiration date (in YYYY-MM-DD format)
`Fax`	String	Fax	No
`OwnerFirstName`	String	Card owner’s first name	Optional if `OwnerName` is specified
`OwnerLastName`	String	Card owner’s last name	Optional if `OwnerName` is specified
`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
`PaymentMethodCode`	String	Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side).
`PaymentMethodName`	String	Payment method name
`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).
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvice`	String	State or province name	No
`Zip`	String	Zip or postal code	No

Object Merchant.Product

Parameter Name	Type	Description	Mandatory
`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
`BackOrderDate`	String	Estimated date for the backordered item to be in stock	No
`Brand`	Object `Merchant.Brand`	Product’s brand	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
`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
`Categories`	List of `Merchant.Category`	List of product categories	No
`CustomerVATRate`	Decimal	The customer VAT rate applied to this product
`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.
`DiscountedPriceForCustoms`	Decimal	Product price in Merchant currency reflects the price after Reverse D&T calculation.
`DTBreakdown`	Object `DTBreakdown`	Contains the duties and taxes per item in Merchant currency.	No
`GenericHSCode`	String	Product’s HS code	No
`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
`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
`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.
`InternationalDiscountedPriceForCustoms`	Decimal	Product price in customer currency reflects the price after Reverse D&T calculation
`InternationalDiscountedPriceInMerchantCurrency`	Decimal	Product Price in Merchant currency
`InternationalDTBreakdown`	Object `DTBreakdown`	Contains the duties and taxes per item in customer currency.	No
`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
`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
`IsBackOrdered`	Bool	Identifies if the product was ordered as a backed ordered item TRUE - Product is back-ordered. FALSE - Product is not back-ordered.	No
`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.
`Name`	String	Name of the product. Returned by `GetOrdersDetails` API only	No
`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
P`r`ice	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.
`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
`ProductAttributes`	List of `Merchant.ProductAttribute`	Product attributes. Returned by `GetOrdersDetails` API only	No
`Quantity`	Decimal	Product quantity in the order that is currently being submitted to the Merchant.
`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.
`Sku`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).
`VATRate`	Decimal	The VAT rate applied to this product

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Parameter Name	Type	Description	Mandatory
`BrandCode`	String	Brand code
`Name`	String	Brand name

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

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

Object OrderDocument

Parameter Name	Type	Description	Mandatory
`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).
`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
`DocumentTypeName`	String	Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`.
`ErrorMessage`	String	Description of the error for this entity (order/parcel) if it happened.	No
`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.

Object OrderPaymentMethod

Parameter Name	Type	Description
`GiftCardFields`	String	Gift card fields
`IsGiftCard`	Boolean	Indicates if the order payment method is a gift card. TRUE if using a gift card for payment FALSE if not using a gift card
`PaidAmountInCustomerCurrency`	Decimal	Amount that paid in customer’s currency
`PaidAmountInMerchantCurrency`	Decimal	Amount paid in Merchant’s currency
`PaymentMethodId`	Decimal	The ID for the payment method
`PaymentMethodName`	String	Name of the payment method

Object OrderStatusReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order status reason name
`OrderStatusReasonCode`	String	Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side)

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":"[email protected]",
    "ExpirationDate":"2040-09-22",
    "Fax":null,
    "OwnerFirstName":"Global-e",
    "OwnerLastName":"US Inc.",
    "OwnerName":"Global-e US Inc.",
    "PaymentMethodCode":"OT",
    "PaymentMethodName":"Undefined",
    "PaymentMethodTypeCode":"globaleintegration",
    "Phone1":"+1 (212) 634-3952",
    "Phone2":null,
    "StateCode":"NY",
    "StateOrProvince":"New York",
    "Zip":"10036"
  },
  "PrimaryBilling":{
    "Address1":"t",
    "Address2":null,
    "AddressBookId":null,
    "City":"t",
    "Company":null,
    "CountryCode":"NZ",
    "CountryCode3":"NZL",
    "CountryName":"New+Zealand",
    "Email":"[email protected]",
    "Fax":null,
    "FirstName":"FirstName",
    "LastName":"LastName",
    "MiddleName":null,
    "Phone1":"2125551212",
    "Phone2":null,
    "Salutation":null,
    "StateCode":null,
    "StateOrProvince":null,
    "Zip":"2345",
    "CollectionPointId":null,
    "AddressBookName":null,
    "CustomerTaxId":null
  },
  "SecondaryBilling":{
    "Address1":"200 west 41st street",
    "Address2":"9th floor",
    "AddressBookId":null,
    "City":"New York",
    "Company":"GlobalE",
    "CountryCode":"US",
    "CountryCode3":"USA",
    "CountryName":"United States",
    "Email":"[email protected]",
    "Fax":null,
    "FirstName":"Global-e",
    "LastName":"US Inc.",
    "MiddleName":null,
    "Phone1":"+1 (212) 634-3952",
    "Phone2":null,
    "Salutation":null,
    "StateCode":"NY",
    "StateOrProvince":"New York",
    "Zip":"10036",
    "CollectionPointId":null,
    "AddressBookName":null,
    "CustomerTaxId":null
  },
  "CartHash":"3A29A654B1A5DD8D758D19C827B69E83",
  "CartToken":null,
  "GlobalECartToken":null,
  "CartId":"f9847639-95e8-4e75-b198-9031a205e001:384880634",
  "DiscountedShippingPrice":221.15,
  "InternationalDetails":{
    "ConsignmentFee":0.0000,
    "CurrencyCode":"NZD",
    "DeliveryDaysFrom":9,
    "DeliveryDaysTo":15,
    "DiscountedShippingPrice":369.1900,
    "DutiesGuaranteed":false,
    "OrderTrackingNumber":null,
    "OrderTrackingUrl":"https%3a%2f%2fwww.bglobale.com%2fOrder%2fTrack%2fmZz5%3fOrderId%3dGE01812420US%26ShippingEmail%3dtest%40test.com",
    "OrderWaybillNumber":null,
    "PaymentMethodCode":"1",
    "PaymentMethodName":"Visa",
    "RemoteAreaSurcharge":0.0000,
    "SameDayDispatchCost":0.0000,
    "ShippingMethodCode":"40049745",
    "ShippingMethodName":"DHL api Express Worldwide",
    "ShippingMethodTypeCode":"Express",
    "ShippingMethodTypeName":"Express Courier (Air)",
    "SizeOverchargeValue":17.0000,
    "TotalCCFPrice":0.0000,
    "TotalDutiesPrice":0.000000000,
    "TotalPrice":393.56,
    "TotalShippingPrice":369.1900,
    "TransactionCurrencyCode":"NZD",
    "TransactionTotalPrice":393.5600,
    "ParcelsTracking":null,
    "CardNumberLastFourDigits":null,
    "ExpirationDate":null,
    "ShippingVATRate":0.0000,
    "CashOnDeliveryFee":0.0,
    "CustomerDTBreakdown":null,
    "MerchantDTBreakdown":null,
    "DeliveryDateFrom":"25.03",
    "DeliveryDateTo":"04.04",
    "ShipmentLocation":null,
    "ShipmentStatusUpdateTime":null,
    "ShippingMethodStatusCode":"Undefined",
    "ShippingMethodStatusName":"undefined"
  },
  "MerchantGUID":"12345678-1234-1234-1234-123456789012",
  "MerchantOrderId":"123456789",
  "OrderId":"GE01812420US",
  "PriceCoefficientRate":1.150000,
  "StatusCode":"N/A",
  "WebStoreCode":"en-nz",
  "WebStoreInstanceCode":"en-nz"
}

RedeemGiftCard (Global-e to Merchant)

The RedeemGiftCard API sends the amount of the used card balance. This information is saved on your platform.

Add the GiftCardData.RedeemTransactionId for each gift card during this call.

Method/URL

https://www.merchant-site-domain.com/redeem-gift-card-url

Parameters

Request

Name	Type	Description	Mandatory
RedeemGiftCardRequest	Object Object RedeemGiftCardRequest	Contains information regarding gift card redemption.	Yes

Response

Name	Type	Description	Mandatory
RedeemGiftCardResponse	Object Object RedeemGiftCardResponse	Provides details about response to API call for gift card redemption.

Objects for RedeemGiftCard API

Object RefundGiftCardRequest

Parameter Name	Type	Description
`Cards`	List of `GiftCardData`	List with gift cards data objects
`ConversionRate`	Decimal	Rate of conversion from gift card currency to customer currency
`MerchantGUID`	String	Merchant unique identifier
`OrderId`	String	Global‑e Order ID
`TotalToRefundInCustomerCurrency`	Decimal	The total value to refund for all gift cards in customer currency
`TotalToRefundInGiftCardCurrency`	Decimal	The total value to refund for all gift cards in gift card currency

Object GiftCardData

The GiftCardData model is used for most calls where multiple cards are passed. See Base Gift Card Model.

Parameter Name	Type	Description	Mandatory
`BalanceInCustomerCurrency`	Decimal	Total available amount in customer currency
`BalanceInGiftCardCurrency`	Decimal	Total available amount in gift card currency
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`BalanceUsedInCustomerCurrency`	Decimal	Amount to redeem in gift user currency
`CardFields`	Dictionary<String, String>	Key value pairs of each field defined in the configuration
`CardId`	Decimal	id of the card in the DB table on the Global‑e side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of the error	No
`ErrorText`	String	Error message	No
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	The refund status. TRUE - Refund was successfully applied to the gift card FALSE - Refund failed or there is no refund on the card
`RedeemTransactionId`	String	The value that is set as a result of card redemption (should be provided by the platform)
`RefundedBalanceInCustomerCurrency`	Decimal	The amount of refunded money in customer currency
`RefundedBalanceInGiftCardCurrency`	Decimal	The amount of refunded money in gift card currency

Object BaseGiftCard

The CardData model is used for most calls where multiple cards are passed.

Parameter Name	Type	Description
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`CardFields`	Dictionary<String,String>	The Value of each field is defined in the configuration. Key – defined field name Value – user input data
`CardHash`	String	Unique hash generated for each card
`CardId`	Long	ID of card in DB table on Global-e CORE side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of error which should be set during Redeem and Refund calls
`ErrorText`	String	Text of error message
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	True if the refund is successful False if the refund fails If there is no refund on the card it should be NULL
`RedeemTransactionId`	String	Value which is set as a result of card redemption
`RefundedBalanceInCustomerCurrency`	Decimal	Amount of refunded money in customer currency (should be set in refund API call)
`RefundedBalanceInGiftCardCurrency`	Decimal	Amount of refunded money in gift card currency (should be set in refund API call)

Object RedeemGiftCardResponse

Parameter Name	Type	Description
`Cards`	List of `GiftCardData`	List with gift cards data objects data
`ErrorCode`	String	Code of the error
`ErrorText`	String	Error message

Object GiftCardData

The GiftCardData model is used for most calls where multiple cards are passed. See Base Gift Card Model.

Parameter Name	Type	Description	Mandatory
`BalanceInCustomerCurrency`	Decimal	Total available amount in customer currency
`BalanceInGiftCardCurrency`	Decimal	Total available amount in gift card currency
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`BalanceUsedInCustomerCurrency`	Decimal	Amount to redeem in gift user currency
`CardFields`	Dictionary<String, String>	Key value pairs of each field defined in the configuration
`CardId`	Decimal	id of the card in the DB table on the Global‑e side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of the error	No
`ErrorText`	String	Error message	No
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	The refund status. TRUE - Refund was successfully applied to the gift card FALSE - Refund failed or there is no refund on the card
`RedeemTransactionId`	String	The value that is set as a result of card redemption (should be provided by the platform)
`RefundedBalanceInCustomerCurrency`	Decimal	The amount of refunded money in customer currency
`RefundedBalanceInGiftCardCurrency`	Decimal	The amount of refunded money in gift card currency

Object BaseGiftCard

The CardData model is used for most calls where multiple cards are passed.

Parameter Name	Type	Description
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`CardFields`	Dictionary<String,String>	The Value of each field is defined in the configuration. Key – defined field name Value – user input data
`CardHash`	String	Unique hash generated for each card
`CardId`	Long	ID of card in DB table on Global-e CORE side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of error which should be set during Redeem and Refund calls
`ErrorText`	String	Text of error message
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	True if the refund is successful False if the refund fails If there is no refund on the card it should be NULL
`RedeemTransactionId`	String	Value which is set as a result of card redemption
`RefundedBalanceInCustomerCurrency`	Decimal	Amount of refunded money in customer currency (should be set in refund API call)
`RefundedBalanceInGiftCardCurrency`	Decimal	Amount of refunded money in gift card currency (should be set in refund API call)

Examples

Request

{
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
    "ShippingCountryCode": "IL",
    "Cards": [{
            "CardId": 2864,
            "BalanceInGiftCardCurrency": 365.930000,
            "BalanceInCustomerCurrency": 1286.210000,
            "GiftCardCurrencyCode": "USD",
            "CustomerCurrencyCode": "ILS",
            "BalanceUsedInCardCurrency": 94.910000,
            "BalanceUsedInCustomerCurrency": 333.590000,
            "CardFields": {
                "CardId": "111111"
            }
        }
    ],
    "OrderId": " GE927127",
    "MerchantCartToken": "cf270ce6b2d4ce6d2d882536b8741a01"
}

Response

{
    "Cards": [{
            "CardId": 2864,
            "BalanceInGiftCardCurrency": 365.93,
            "BalanceInCustomerCurrency": 1286.21,
            "GiftCardCurrencyCode": "USD",
            "CustomerCurrencyCode": "ILS",
            "BalanceUsedInCardCurrency": 94.91,
            "BalanceUsedInCustomerCurrency": 333.59,
            "RedeemTransactionId": 2,
            "CardFields": {
                "CardId": "111111"
            }
        }
    ],
    "ErrorCode": null,
    "ErrorText": null
}

RefundGiftCard

Call RefundGiftCard to return the used gift card balance when the order is cancelled or a new Refund has been created.

Global‑e sends the list of all applied gift cards and the total amount to refund for gift cards in both currencies (customer currency and gift card currency), as well as the conversion rate. The Merchant’s platform determines the actual refund values to be refunded for each gift card and returns the respective values in the API response accordingly.

For each gift card, set the following in response:

GiftCardData.RefundedBalanceInGiftCardCurrency – must not exceed the provided value of GiftCardData.BalanceUsedInCardCurrency
GiftCardData.RefundedBalanceInCustomerCurrency – must not exceed the provided value of GiftCardData.BalanceUsedInCustomerCurrency
GiftCardData.IsRefundSuccess
- Set to true: If the two previous values for the card and values are successfully refunded.
- Set to false: If the refund was added but something went wrong.

If no refunds are added for the particular card, do not set these values.

Method/URL

https://www.merchant-site-domain.com/refund-gift-card-url

Parameters

Request

Requests can contain more parameters than listed.

Name	Type	Description	Mandatory
order	Object Object RefundGiftCardRequest	Contains information about the gift card refund.	Yes

Response

Note

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

Name	Type	Description	Mandatory
order	Object RefundGiftCardResponse	Contains information about the response to the API call for gift card refunds.	Yes

Objects for RefundGiftCard API

Object RefundGiftCardRequest

Parameter Name	Type	Description
`Cards`	List of `GiftCardData`	List with gift cards data objects
`ConversionRate`	Decimal	Rate of conversion from gift card currency to customer currency
`MerchantGUID`	String	Merchant unique identifier
`OrderId`	String	Global‑e Order ID
`TotalToRefundInCustomerCurrency`	Decimal	The total value to refund for all gift cards in customer currency
`TotalToRefundInGiftCardCurrency`	Decimal	The total value to refund for all gift cards in gift card currency

Object GiftCardData

The GiftCardData model is used for most calls where multiple cards are passed. See Base Gift Card Model.

Parameter Name	Type	Description	Mandatory
`BalanceInCustomerCurrency`	Decimal	Total available amount in customer currency
`BalanceInGiftCardCurrency`	Decimal	Total available amount in gift card currency
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`BalanceUsedInCustomerCurrency`	Decimal	Amount to redeem in gift user currency
`CardFields`	Dictionary<String, String>	Key value pairs of each field defined in the configuration
`CardId`	Decimal	id of the card in the DB table on the Global‑e side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of the error	No
`ErrorText`	String	Error message	No
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	The refund status. TRUE - Refund was successfully applied to the gift card FALSE - Refund failed or there is no refund on the card
`RedeemTransactionId`	String	The value that is set as a result of card redemption (should be provided by the platform)
`RefundedBalanceInCustomerCurrency`	Decimal	The amount of refunded money in customer currency
`RefundedBalanceInGiftCardCurrency`	Decimal	The amount of refunded money in gift card currency

Object BaseGiftCard

The CardData model is used for most calls where multiple cards are passed.

Parameter Name	Type	Description
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`CardFields`	Dictionary<String,String>	The Value of each field is defined in the configuration. Key – defined field name Value – user input data
`CardHash`	String	Unique hash generated for each card
`CardId`	Long	ID of card in DB table on Global-e CORE side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of error which should be set during Redeem and Refund calls
`ErrorText`	String	Text of error message
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	True if the refund is successful False if the refund fails If there is no refund on the card it should be NULL
`RedeemTransactionId`	String	Value which is set as a result of card redemption
`RefundedBalanceInCustomerCurrency`	Decimal	Amount of refunded money in customer currency (should be set in refund API call)
`RefundedBalanceInGiftCardCurrency`	Decimal	Amount of refunded money in gift card currency (should be set in refund API call)

Object RefundGiftCardResponse

Parameter Name	Type	Description
`Cards`	List of `GiftCardData`	List with gift cards data objects data
`ErrorCode`	String	Code of the error
`ErrorText`	String	Error message
`IsRefunded`	Boolean	Indicates if the amounts of redeemed cards was successfully returned TRUE - Successfully refunded. FALSE - Refund not successful.

Object GiftCardData

The GiftCardData model is used for most calls where multiple cards are passed. See Base Gift Card Model.

Parameter Name	Type	Description	Mandatory
`BalanceInCustomerCurrency`	Decimal	Total available amount in customer currency
`BalanceInGiftCardCurrency`	Decimal	Total available amount in gift card currency
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`BalanceUsedInCustomerCurrency`	Decimal	Amount to redeem in gift user currency
`CardFields`	Dictionary<String, String>	Key value pairs of each field defined in the configuration
`CardId`	Decimal	id of the card in the DB table on the Global‑e side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of the error	No
`ErrorText`	String	Error message	No
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	The refund status. TRUE - Refund was successfully applied to the gift card FALSE - Refund failed or there is no refund on the card
`RedeemTransactionId`	String	The value that is set as a result of card redemption (should be provided by the platform)
`RefundedBalanceInCustomerCurrency`	Decimal	The amount of refunded money in customer currency
`RefundedBalanceInGiftCardCurrency`	Decimal	The amount of refunded money in gift card currency

Object BaseGiftCard

The CardData model is used for most calls where multiple cards are passed.

Parameter Name	Type	Description
`BalanceUsedInCardCurrency`	Decimal	Amount to redeem in gift card currency
`CardFields`	Dictionary<String,String>	The Value of each field is defined in the configuration. Key – defined field name Value – user input data
`CardHash`	String	Unique hash generated for each card
`CardId`	Long	ID of card in DB table on Global-e CORE side
`CustomerCurrencyCode`	String	User currency code (checkout currency)
`ErrorCode`	String	Code of error which should be set during Redeem and Refund calls
`ErrorText`	String	Text of error message
`GiftCardCurrencyCode`	String	Gift card currency code
`IsRefundSuccess`	Boolean	True if the refund is successful False if the refund fails If there is no refund on the card it should be NULL
`RedeemTransactionId`	String	Value which is set as a result of card redemption
`RefundedBalanceInCustomerCurrency`	Decimal	Amount of refunded money in customer currency (should be set in refund API call)
`RefundedBalanceInGiftCardCurrency`	Decimal	Amount of refunded money in gift card currency (should be set in refund API call)

Examples

Request

{
    "MerchantGUID": " abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
    "Cards": [{
            "CardId": 2290,
            "BalanceInGiftCardCurrency": 1000.000000,
            "BalanceInCustomerCurrency": 906.270000,
            "GiftCardCurrencyCode": "USD",
            "CustomerCurrencyCode": "EUR",
            "BalanceUsedInCardCurrency": 273.990000,
            "BalanceUsedInCustomerCurrency": 248.3100,
            "RedeemTransactionId": "TestSuccessRedeemTransaction",
            "CardFields": {
                "CardId": "card1000"
            }
        }
    ],
    "TotalToRefundInCustomerCurrency": 115.0,
    "TotalToRefundInGiftCardCurrency": 126.89,
    "ConversionRate": 0.906269,
    "OrderId": "GE927127"
}

Response

{
    "Cards": [{
            "CardId": 2290,
            "BalanceInGiftCardCurrency": 1000.000000,
            "BalanceInCustomerCurrency": 906.270000,
            "GiftCardCurrencyCode": "USD",
            "CustomerCurrencyCode": "EUR",
            "BalanceUsedInCardCurrency": 273.990000,
            "BalanceUsedInCustomerCurrency": 248.3100,
            "RedeemTransactionId": "TestSuccessRedeemTransaction",
            "CardFields": {
                "CardId": "card1000"
            },
            "RefundedBalanceInGiftCardCurrency": 126.89,
            "RefundedBalanceInCustomerCurrency": 115.0,
            "IsRefundSuccess": true
        }
    ],
    "TotalToRefundInCustomerCurrency": 115.0,
    "TotalToRefundInGiftCardCurrency": 126.89,
    "ConversionRate": 0.906269,
    "OrderId": "GE2991190US"
}

RemoveRestrictedProducts (Global-e to Merchant)

Note

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

This API removes restricted products from the merchant cart; it notifies merchants that restricted products were removed from the cart, then merchants must also update the cart on the merchant side.

Method/URL

https://www.merchant-site-domain.com/remove-restricted-products-url

Parameters

Request

Name	Type	Description	Mandatory
Merchant.RemoveRestrictedProductsRequest	Object Object Merchant.RemoveRestrictedProductsRequest	Contains information related to a request to remove a restricted product.	Yes

Response

Name	Type	Description	Mandatory
Merchant.RemoveRestrictedProductsResponse	Object Object Merchant.RemoveRestrictedProductsResponse	Provides details about response to API call for removal of a restricted product.

Objects for RemoveRestrictedProducts API

Object Merchant.RemoveRestrictedProductsRequest

Parameter Name	Type	Description
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for SendCart method for the cart converted to this order on Global‑e.
`CartToken`	String	The value returned from the previous call to `SendCart` for the same client (must be stored in the client session or persistent cookie on the Merchant’s side). This parameter is used to support cart updates.
`CountryCode`	String	2-char ISO country code
`CurrencyCode`	String	3-char ISO currency code.
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`RemovedProductCodes`	List of String	List of SKU codes for products removal from the cart.
`UserId`	String	Internal User identifier on the Merchant’s site in case it was specified in the `SendCart`call.
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store where the current cart is originating from. This code should be used in case of a multi-store setup on the Merchant’s site.
`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.

Object Merchant.RemoveRestrictedProductsResponse

Parameter Name

Type

Description

Mandatory

ErrorCode

String

Code of the error if it happened

ErrorMessage

String

Description of the error if it happened

IsSuccess

Boolean

Indicates if the result is success.

TRUE - Restricted product removal successful.

FALSE - Restricted product removal not successful.

Examples

Request

{
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd",
     "CartToken": "d3b9d91b-cbc9-4485-9f37-b0490c419338",
     "CartId": "37296D5PJE",
     "UserId": null,
     "CountryCode": "VN",
     "CurrencyCode": "VND",
     "WebStoreCode": null,
     "WebStoreInstanceCode": null,
     "RemovedProductCodes": ["1601893OPK0XS"]
}

Response

{"IsSuccess": true}

SendAdditionalRequiredDocumentsToMerchant (Global-e to Merchant)

SendAdditionalRequiredDocumentsToMerchant ( SendAdditionalRequiredDocumentsToMerchantRequestrequest)

Posts the required shipping documents of the order to the Merchant’s site

This notification informs the Merchant that the documents previously listed in SendorderToMerchant notification (under AdditionalRequiredDcouments), initiated by calling CreateAdditionalRequiredDcouments, are ready.

The document's content is included in this notification.

Security:

IP whitelist
Secret GUID
Authorization header

Method/URL

POST https://www.merchant-site-domain.com/send-additional-required-documents-url

Examples

Request:

{
    "OrderId": "Sample order id",
    "MerchantOrderId": "Sample order id from the merchant’s system",
    "CountryCode": "US",
	"AdditionalRequiredDocuments": [
		{
           "TrackingNumber" "98789723874839",
           "DocumentData": "base 64 string",
           "URL": "URL do download document", 
           "DocumentTypeCode": "11",
           "DocumentTypeName": "EAD",
           "DocumentExtension": "pdf",
           "DocumentReference": "24DE85123822923B8",
           "CreationDateTime": "2024-01-30T10:55:21"
		}
	]
}

Response:

{	
	"StatusCode": "200",
	"Success": "true",
	"Message": "...",
	"ErrorCode": "...",
	"ErrorText": "..."
}

SendOrderToMerchant (Global-e to Merchant)

Note

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

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

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

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

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.

Object Merchant.Order

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

OrderCreationSource

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

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

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Object 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 order

FALSE - 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

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

Object Merchant.CustomerDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`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
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name	No
`Email`	String	Email address	No
`Fax`	String	Fax	No
`FirstName`	String	First name	No
`FirstNameInLocalCulture`	String	First name in local culture	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
`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
`StateOrProvice`	String	State or province name	No
`Zip`	String	Zip or postal code	No

Object Merchant.Discount

Parameter Name	Type	Description	Mandatory
`CouponCode`	String	Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only)	No
`Description`	String	Discount textual description	No
`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
`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.
`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
`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
`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
`Name`	String	Discount name
`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.
`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
`VATRate`	Decimal	The VAT rate applied to this discount

Object Merchant.InternationalDetails

Parameter Name	Type	Description	Mandatory
`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
`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
`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.
`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.

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Object Merchant.Parcel

Parameter Name	Type	Description
`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.

Object Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Object Merchant.OriginalOrder

Parameter Name	Type	Description	Mandatory
`MerchantInternalOrderId`	String	`InternalOrderId` returned from `SendOrderToMerchant` call for the original order.	No
`MerchantOrderId`	String	`OrderId` returned from `SendOrderToMerchant` call for the original order.	No
`OrderId`	String	Global‑e order unique identifier for the original order.

Object Merchant.Parcel

Parameter Name	Type	Description
`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.

Object Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Object Merchant.PaymentDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`CardNumber`	String	Card number
`City`	String	City name	No
`CountryCode`	String	2-char ISO country code
`CountryName`	String	Country name
`CVVNumber`	String	Card CVV number
`Email`	String	E-mail address	No
`ExpirationDate`	String	Card expiration date (in YYYY-MM-DD format)
`Fax`	String	Fax	No
`OwnerFirstName`	String	Card owner’s first name	Optional if `OwnerName` is specified
`OwnerLastName`	String	Card owner’s last name	Optional if `OwnerName` is specified
`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
`PaymentMethodCode`	String	Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side).
`PaymentMethodName`	String	Payment method name
`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).
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvice`	String	State or province name	No
`Zip`	String	Zip or postal code	No

Object Merchant.Product

Parameter Name	Type	Description	Mandatory
`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
`BackOrderDate`	String	Estimated date for the backordered item to be in stock	No
`Brand`	Object `Merchant.Brand`	Product’s brand	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
`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
`Categories`	List of `Merchant.Category`	List of product categories	No
`CustomerVATRate`	Decimal	The customer VAT rate applied to this product
`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.
`DiscountedPriceForCustoms`	Decimal	Product price in Merchant currency reflects the price after Reverse D&T calculation.
`DTBreakdown`	Object `DTBreakdown`	Contains the duties and taxes per item in Merchant currency.	No
`GenericHSCode`	String	Product’s HS code	No
`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
`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
`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.
`InternationalDiscountedPriceForCustoms`	Decimal	Product price in customer currency reflects the price after Reverse D&T calculation
`InternationalDiscountedPriceInMerchantCurrency`	Decimal	Product Price in Merchant currency
`InternationalDTBreakdown`	Object `DTBreakdown`	Contains the duties and taxes per item in customer currency.	No
`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
`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
`IsBackOrdered`	Bool	Identifies if the product was ordered as a backed ordered item TRUE - Product is back-ordered. FALSE - Product is not back-ordered.	No
`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.
`Name`	String	Name of the product. Returned by `GetOrdersDetails` API only	No
`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
P`r`ice	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.
`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
`ProductAttributes`	List of `Merchant.ProductAttribute`	Product attributes. Returned by `GetOrdersDetails` API only	No
`Quantity`	Decimal	Product quantity in the order that is currently being submitted to the Merchant.
`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.
`Sku`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).
`VATRate`	Decimal	The VAT rate applied to this product

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

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

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

Object OrderDocument

Parameter Name	Type	Description	Mandatory
`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).
`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
`DocumentTypeName`	String	Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`.
`ErrorMessage`	String	Description of the error for this entity (order/parcel) if it happened.	No
`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.

Object OrderPaymentMethod

Parameter Name	Type	Description
`GiftCardFields`	String	Gift card fields
`IsGiftCard`	Boolean	Indicates if the order payment method is a gift card. TRUE if using a gift card for payment FALSE if not using a gift card
`PaidAmountInCustomerCurrency`	Decimal	Amount that paid in customer’s currency
`PaidAmountInMerchantCurrency`	Decimal	Amount paid in Merchant’s currency
`PaymentMethodId`	Decimal	The ID for the payment method
`PaymentMethodName`	String	Name of the payment method

Object OrderStatusReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order status reason name
`OrderStatusReasonCode`	String	Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side)

Response

Note

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

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

Object Merchant.ResponseInfo

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

Examples

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

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

SendRMAToMerchant (Global-e to Merchant)

Use the SendRMAToMerchant API to send the Global‑e RMA number to the merchant. Sends MerchantReturn object to the merchant.

This API streamlines the refund process for merchants. Merchants can initiate refunds directly from the Shopify Admin.

MerchantAppSetting, SendRMAInfoToMerchantURI must be set to turn on this feature.

Method/URL

POST https://www.merchant-site-domain.com/rma-info-to-merchant-url

Parameters

Request

Name	Type	Description	Mandatory
merchantOrder	Object merchantOrder	Provides order return details.
merchantReturn	Object merchantReturn	Provides merchant return information. Includes the following information: CreatedBy MerchantGUID MerchantOrderId OrderId ReturnedProducts ReturnShippingCost ReturnTrackingNumber RMANumber ShipperName TrackingURL

Return

Name	Type	Description	Mandatory
merchant.ResponseInfo	Object Merchant.ResponseInfo	Provides API call response info.

Objects for SendRMAToMerchant API

Merchant.Order

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

OrderCreationSource

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

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

Merchant.ResponseInfo

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

MerchantReturn

Parameter Name	Type	Description
`CreatedBy`	String	Who created the return
`MerchantGUID`	String	Merchant’s unique ID
`MerchantOrderId`	String	Merchant Order Id
`OrderId`	String	Order Id
`ReturnedProducts`	List<MerchantReturnProduct>	Products returned
`ReturnShippingCost`	Decimal	The return shipping fee paid by the end customer.
`ReturnTrackingNumber`	String	Return tracking number
`RMANumber`	String	Return Merchandise Authorization number
`ShipperName`	String	Name of shipper
`TrackingURL`	String	Tracking URL

Examples

Request Example

{
    "OrderId": "GE24192321GB",
    "MerchantOrderId": "71144",
    "RMANumber": "223878",
    "ShipperName": "DHL",
    "ReturnTrackingNumber": "857854854778",
    "TrackingURL": "www.dhl.com/Tracking?TrackingNumber=857854854778",
    "CreatedBy": "Customer",
    "ReturnedProducts": [
        {
            "SKU": "ProductD",
            "Name": "Blue jacket",
            "CartItemId": "2",
            "ReturnQuantity": 1,
            "ReturnReasonName": "Arrived too late",
            "MerchantReturnReasonCode": null,
            "MerchantReturnReasonName": null
        }
    ],
    "MerchantGUID": "7e3d5523-d86a-4c56-8f47-5a48b829e3b7",
    "CurrencyCode": "EUR",
    "ReturnShippingCost": 10.00
}

Response Example

{
    "Success": "True",
    "Message": "success message",
    "Description": "success description"
}

UpdateOrderShippingInfo (Global-e to Merchant)

UpdateObject Merchant.Order

Updates the order's international shipping information on the Merchant site.

Only order.OrderId and order.InternationalDetails members are mandatory for this method.

Method/URL

https://www.merchant-site-domain.com/order-shipping-info-update-only-url

Parameters

Request

Name	Type	Description	Mandatory
order	Object Merchant.Order	Object MerchantOrder contains details about the status of the order on the merchant's site.	Yes

Response

Name	Type	Description	Mandatory
ResponseInfo	Object Merchant.ResponInfo	Response details regarding API call.

Objects for UpdateOrderShippingInfo API

Merchant.Order

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

OrderCreationSource

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

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

Merchant.ResponseInfo

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

Examples

Request

{
    "OrderId": "00010000100000000020",
    "InternationalDetails": {
        "OrderTrackingNumber": "1265443",
        " OrderTrackingUrl": "http://www.somecarrier.com/?1265443"
    },
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd"
}

UpdateOrderStatus (Global-e to Merchant)

Note

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

Updates order status of the order on the Merchant’s site. Only order.OrderId and order.StatusCode members are mandatory for this method.

When implementing a Global-e extension or plug-in, this method is required to support order cancellation when it is 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.

Method/URL

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

Parameters

Request

Name	Type	Description	Mandatory
orderStatus	Object MerchantOrder	Object MerchantOrder contains details about the status of the order on the merchant's site.	Yes

Response

Name	Type	Description	Mandatory
ResponseInfo	Object Merchant.ResponInfo	Response details regarding API call.

Objects for UpdateOrderStatus

Merchant.Order

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

OrderCreationSource

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

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

Merchant.ResponseInfo

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

Example

Request

{
    "OrderId": "00010000100000000020",
    "StatusCode": "canceled",
    "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd"
}

ValidateGiftCard (Global-e to Merchant)

The ValidateGiftCard request sends the gift card data to the platform, gets the card amount, and makes sure that the card is valid.

ValidateGiftCard is called when the user fills out all gift card fields on the checkout page.

Method/URL

https://www.merchant-site-domain.com/validate-gift-card-url

Parameters

Request

Name	Type	Description	Mandatory
ValidateGiftCardRequest	Object Object ValidateGiftCardRequest	Provides information related to validating the gift card.

Response

Name	Type	Description	Mandatory
ValidateGiftCardResponse	Object ValidateGiftCardResponse	Provides API call response info.

Objects for ValidateGiftCard API

Object ValidateGiftCardRequest

Parameter Name	Type	Description
`CardFields`	Dictionary<String, String>	Key value pairs of each field defined in the configuration
`MerchantCartToken`	String	Identifier of the cart on the Merchant’s site originally specified in the `merchantCartToken` argument for the respective `SendCart` call
`MerchantGUID`	String	Merchant unique identifier
`ShippingCountryCode`	String	Code of country selected on checkout

Object ValidateGiftCardResponse

Parameter Name	Type	Description
`Balance`	Decimal	The available amount of money on a gift card
`CurrencyCode`	String	Code of card currency
`ErrorCode`	String	Code of the error
`ErrorText`	String	Error message
`IsGlobalEGiftCard`	Boolean	Identifies if the gift card was bought from Global‑e. TRUE - Gift card was purchased from Global-e. FALSE - Gift card was not purchased from Global-e.
`IsValid`	Boolean	The flag which approves that user entered the correct card data. TRUE - Card data is valid. FALSE - Card data is not valid.

Examples

Request

{
    "MerchantGUID": abcdabcd - abcd - abcd - abcd - abcdabcdabcd ",
    	" ShippingCountryCode ":" UA ",
    	" CardFields ":{" CardId ":" 111111 "},
    	" MerchantCartToken ":" 2c5c7b3db2ed101426cba38d9c534086 "
}

Responses

For valid cards:

{
    "IsValid": true,
    "Balance": 1000,
    "CurrencyCode": "GBP",
    "IsGlobalEGiftCard": false,
    "ErrorCode": null,
    "ErrorText": null
}

For invalid cards:

{
    "IsValid": false,
    "Balance": null,
    "CurrencyCode": null,
    "IsGlobalEGiftCard": false,
    "ErrorCode": null,
    "ErrorText": "Invalid Card"
}

ValidateStock (Global-e to Merchant)

Note

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

The Merchant Cart Validation checks basic cart validity and validates the product’s stock availability.

If a product line cart item listed in order.Products does not have full stock availability for the specified quantity, this cart item is included in the AmendedProducts array with an indication of the quantity actually available. If all items are in stock, the AmendedProducts array is empty.

If required, the ValidateStock API is called when the shopper is in the Global‑e checkout. If the AmendedProducts array is not empty, the list of out-of-stock products is displayed to the shopper.

Note

In the GEM integration method, the GetCheckoutCartInfo API may be reused for stock validation purposes.

Method/URL

https://www.merchant-site-domain.com/checkout-validate-cart-stock-url

Parameters

Request

Name	Type	Description	Mandatory
order	Object Object Merchant.Order	Provides information related to the order.

Request

Name	Type	Description	Mandatory
Merchant.StockValidationResponse	Object Object Merchant.StockValidationResponse	Provides information related to validating that stock exists.

Objects for ValidateStock API

Object Merchant.Order

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

OrderCreationSource

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

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

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Object 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 order

FALSE - 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

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

Object Merchant.CustomerDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`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
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name	No
`Email`	String	Email address	No
`Fax`	String	Fax	No
`FirstName`	String	First name	No
`FirstNameInLocalCulture`	String	First name in local culture	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
`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
`StateOrProvice`	String	State or province name	No
`Zip`	String	Zip or postal code	No

Object Merchant.Discount

Parameter Name	Type	Description	Mandatory
`CouponCode`	String	Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only)	No
`Description`	String	Discount textual description	No
`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
`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.
`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
`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
`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
`Name`	String	Discount name
`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.
`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
`VATRate`	Decimal	The VAT rate applied to this discount

Object Merchant.InternationalDetails

Parameter Name	Type	Description	Mandatory
`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
`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
`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.
`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.

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Object Merchant.Parcel

Parameter Name	Type	Description
`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.

Object Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Object Merchant.OriginalOrder

Parameter Name	Type	Description	Mandatory
`MerchantInternalOrderId`	String	`InternalOrderId` returned from `SendOrderToMerchant` call for the original order.	No
`MerchantOrderId`	String	`OrderId` returned from `SendOrderToMerchant` call for the original order.	No
`OrderId`	String	Global‑e order unique identifier for the original order.

Object Merchant.Parcel

Parameter Name	Type	Description
`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.

Object Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Object Merchant.PaymentDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`CardNumber`	String	Card number
`City`	String	City name	No
`CountryCode`	String	2-char ISO country code
`CountryName`	String	Country name
`CVVNumber`	String	Card CVV number
`Email`	String	E-mail address	No
`ExpirationDate`	String	Card expiration date (in YYYY-MM-DD format)
`Fax`	String	Fax	No
`OwnerFirstName`	String	Card owner’s first name	Optional if `OwnerName` is specified
`OwnerLastName`	String	Card owner’s last name	Optional if `OwnerName` is specified
`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
`PaymentMethodCode`	String	Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side).
`PaymentMethodName`	String	Payment method name
`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).
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvice`	String	State or province name	No
`Zip`	String	Zip or postal code	No

Object Merchant.Product

Parameter Name	Type	Description	Mandatory
`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
`BackOrderDate`	String	Estimated date for the backordered item to be in stock	No
`Brand`	Object `Merchant.Brand`	Product’s brand	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
`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
`Categories`	List of `Merchant.Category`	List of product categories	No
`CustomerVATRate`	Decimal	The customer VAT rate applied to this product
`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.
`DiscountedPriceForCustoms`	Decimal	Product price in Merchant currency reflects the price after Reverse D&T calculation.
`DTBreakdown`	Object `DTBreakdown`	Contains the duties and taxes per item in Merchant currency.	No
`GenericHSCode`	String	Product’s HS code	No
`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
`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
`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.
`InternationalDiscountedPriceForCustoms`	Decimal	Product price in customer currency reflects the price after Reverse D&T calculation
`InternationalDiscountedPriceInMerchantCurrency`	Decimal	Product Price in Merchant currency
`InternationalDTBreakdown`	Object `DTBreakdown`	Contains the duties and taxes per item in customer currency.	No
`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
`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
`IsBackOrdered`	Bool	Identifies if the product was ordered as a backed ordered item TRUE - Product is back-ordered. FALSE - Product is not back-ordered.	No
`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.
`Name`	String	Name of the product. Returned by `GetOrdersDetails` API only	No
`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
P`r`ice	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.
`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
`ProductAttributes`	List of `Merchant.ProductAttribute`	Product attributes. Returned by `GetOrdersDetails` API only	No
`Quantity`	Decimal	Product quantity in the order that is currently being submitted to the Merchant.
`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.
`Sku`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).
`VATRate`	Decimal	The VAT rate applied to this product

Object DTBreakdown

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

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

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

Object OrderDocument

Parameter Name	Type	Description	Mandatory
`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).
`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
`DocumentTypeName`	String	Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`.
`ErrorMessage`	String	Description of the error for this entity (order/parcel) if it happened.	No
`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.

Object OrderPaymentMethod

Parameter Name	Type	Description
`GiftCardFields`	String	Gift card fields
`IsGiftCard`	Boolean	Indicates if the order payment method is a gift card. TRUE if using a gift card for payment FALSE if not using a gift card
`PaidAmountInCustomerCurrency`	Decimal	Amount that paid in customer’s currency
`PaidAmountInMerchantCurrency`	Decimal	Amount paid in Merchant’s currency
`PaymentMethodId`	Decimal	The ID for the payment method
`PaymentMethodName`	String	Name of the payment method

Object OrderStatusReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order status reason name
`OrderStatusReasonCode`	String	Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side)

Object Merchant.StockValidationResponse

Parameter Name	Type	Description	Mandatory
`AmendedProducts`	List of `Merchant.StockValidationRowResponse`	The list of products that don’t have full stock availability for the `Product.Quantity` specified in the respective `ValidateStock` API request.	No
`CustomResources`	Dictionary<String, String>	Dictionary with custom resources for error and oos popup. Keys for the dictionary: `TitleTextResourceId`, `BodyTextResourceId`, `ButtonTextResourceId`, `RedirectUrl`.	No
`Error`	String	The error message returned from the Merchant	No
`ReservationRequestId`	String	The stock reservation code returned from the Merchant if the stock has been actually reserved as a result of the `ValidateStock` API call.	No
`TextResourcesPlaceholders`	Dictionary<String, String>	Dictionary with placeholders which need to be replaced in text resources for error and oos popup which was passed in `CustomResources` (except `RedirectUrl` key).	No

Object Merchant.StockValidationRowResponse

Parameter Name	Type	Description	Mandatory
`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 cart
`QuantityInStock`	String	Available product quantity

Examples

Request

{
    "GlobalECartToken": "1da35dc3-cbe6-4cd8-81d6-ce433466d715",
    "PreferredCultureCode": null,
    "AuthToken": "34sdfdg43erfg43234fwsedfsdf423",
    "SessionId": "12345",
    "DateCreated": "0001-01-01T00:00:00",
    "CurrencyName": null,
    "Parcels": null,
    "AllowMailsFromMerchant": false,
    "AllowDirectCommunicationFromMerchant": false,
    "ClearCart": false,
    "UserId": null,
    "CurrencyCode": "ILS",
    "Products": [{
            "Attributes": null,
            "Sku": "648340636",
            "Price": 157.7000,
            "PriceBeforeRoundingRate": null,
            "PriceBeforeGlobalEDiscount": null,
            "Quantity": 1,
            "VATRate": null,
            "CustomerVATRate": null,
            "InternationalPrice": 649.0000,
            "InternationalDiscountedPriceInMerchantCurrency": null,
            "CartItemId": "ci21000088",
            "ParentCartItemId": null,
            "CartItemOptionId": null,
            "HandlingCode": null,
            "GiftMessage": null,
            "RoundingRate": 0.0,
            "IsBackOrdered": false,
            "BackOrderDate": null,
            "DiscountedPrice": null,
            "InternationalDiscountedPrice": null,
            "ProductCodeSecondary": "MKC1120A~N~040~~NS",
            "Brand": null,
            "Categories": null,
            "ListPrice": 0.0,
            "InternationalListPrice": 0.0,
            "GenericHSCode": null,
            "DiscountedPriceForCustoms": 0.0,
            "InternationalDiscountedPriceForCustoms": 0.0,
            "IsGiftCard": false,
            "IsFixedPrice": true
        }
    ],
    "Customer": {
        "EmailAddress": null,
        "IsEndCustomerPrimary": false,
        "SendConfirmation": false
    },
    "PrimaryShipping": {
        "FirstName": "sdfsdf",
        "LastName": "sdfsdf",
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": "asdasd+234",
        "Address2": "",
        "City": "asdasd",
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": "1234567",
        "Email": "sdfsdf%40asdasd.com",
        "Phone1": "0000000000",
        "Phone2": null,
        "Fax": null,
        "CountryCode": "IL",
        "CountryCode3": null,
        "CountryName": null,
        "AddressBookId": null,
        "AddressBookName": null,
        "SaveAddress": false
    },
    "SecondaryShipping": {
        "FirstName": "GlobalE",
        "LastName": "GE-UK@EMA-Norsk",
        "MiddleName": null,
        "Salutation": null,
        "Company": "",
        "Address1": "Building 436, Argosy Road",
        "Address2": "East Midlands Airport",
        "City": "Derby",
        "StateCode": "NN",
        "StateOrProvince": null,
        "Zip": "DE74 2SA",
        "Email": "[email protected]",
        "Phone1": "01332 818723",
        "Phone2": null,
        "Fax": null,
        "CountryCode": "GB",
        "CountryCode3": "GBR",
        "CountryName": "United Kingdom",
        "AddressBookId": null,
        "AddressBookName": null,
        "SaveAddress": false
    },
    "ShippingMethodCode": "Express Courier (Air)",
    "Discounts": [],
    "Markups": [],
    "LoyaltyPointsSpent": null,
    "LoyaltyPointsEarned": null,
    "SameDayDispatch": false,
    "SameDayDispatchCost": 0.0,
    "DoNotChargeVAT": false,
    "CustomerComments": null,
    "IsFreeShipping": false,
    "FreeShippingCouponCode": null,
    "ShipToStoreCode": null,
    "RoundingRate": 0.0,
    "UrlParameters": "[{\"Key\":\"ClientCookie\",\"Value\":\"JSESSIONID=null\"},{\"Key\":\"userId\",\"Value\":\"1148993\"},{\"Key\":\"orderId\",\"Value\":\"w748807\"},{\"Key\":\"locale\",\"Value\":\"en_IL\"}]",
    "OriginalMerchantTotalProductsDiscountedPrice": 0.0,
    "LoyaltyCode": null,
    "OTVoucherCode": null,
    "OTVoucherAmount": null,
    "OTVoucherCurrencyCode": null,
    "IsSplitOrder": false,
    "PrePayOffered": false,
    "InitialCheckoutCultureCode": null,
    "CultureCode": null,
    "HubId": 0,
    "IsReplacementOrder": false,
    "OriginalOrder": null,
    "ReservationRequestId": null,
    "IsSuppressPersonalInformation": false,
    "TotalDutiesAndTaxesPrice": 0.0,
    "USSalesTax": 0.0,
    "CCFPrice": 0.0,
    "PaymentDetails": null,
    "PrimaryBilling": {
        "FirstName": null,
        "LastName": null,
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": null,
        "Address2": null,
        "City": null,
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": null,
        "Email": null,
        "Phone1": null,
        "Phone2": null,
        "Fax": null,
        "CountryCode": null,
        "CountryCode3": null,
        "CountryName": null,
        "AddressBookId": null,
        "AddressBookName": null,
        "SaveAddress": false
    },
    "SecondaryBilling": {
        "FirstName": null,
        "LastName": null,
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": null,
        "Address2": null,
        "City": null,
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": null,
        "Email": null,
        "Phone1": null,
        "Phone2": null,
        "Fax": null,
        "CountryCode": null,
        "CountryCode3": null,
        "CountryName": null,
        "AddressBookId": null,
        "AddressBookName": null,
        "SaveAddress": false
    },
    "OrderId": null,
    "StatusCode": null,
    "MerchantGUID": "7f132fc6-bdbc-420e-a2ce-fd35ab5c06d0",
    "CartId": "_2S0DVucAbjgfHAR-SUmRshWaS3pB5F9Bk7OfgWBR9ujllKrTw5H!17426857!1596453641116",
    "MerchantOrderId": null,
    "PriceCoefficientRate": 0.0,
    "CartHash": "94210A58BAC3B3AB292DE94382910C87",
    "WebStoreCode": "en_IL",
    "WebStoreInstanceCode": "GlobalEDefaultStoreInstance",
    "DiscountedShippingPrice": 0.0,
    "InternationalDetails": null,
    "GiftCards": null
}

Responses

Example of generic error:

Error code 3 is expected. An appropriate error message is shown to the customer and a new clean cart is generated.

{
    "AmendedProducts": [],
    "Error": "3",
    "StackTrace": " at CallSite.Target(Closure , CallSite , Object )\r\n at GlobalE.GEM.BL.GEMProviders.BaseProviders.BaseGEMProvider.ParseReservationInfo(Object reservationInfo) in C:\\jenkins\\workspace\\GEPI\\787e4b5b9a7709ca06b57fcfbeb2bdb2\\GlobalE.GEM.BL\\GEMProviders\\BaseProviders\\BaseGEMProvider.cs:line 844",
    "ReservationRequestId": null
}

Example of invalid email error:

Error code 2 is expected. An appropriate error message is shown to the customer and a new clean cart is generated.

{
    "AmendedProducts": [],
    "Error": "2",
    "StackTrace": null,
    "ReservationRequestId": null
}

Example of invalid cart content error:

Error code 1 is expected. One of the cart fields is invalid. An appropriate error message is shown to the customer and a new clean cart is generated.

{
    "AmendedProducts": [],
    "Error": "1",
    "StackTrace": null,
    "ReservationRequestId": null
}

If all products are in stock:

{
    "AmendedProducts": [],
    "ReservationRequestId": null,
    "Error": null
}

If some products are out of stock:

{
    "AmendedProducts": [{
            "CartItemID": "11007",
            "QuantityInStock": 1
        }
    ],
    "ReservationRequestId": null
}

ValidateVoucher (Global-e to Merchant)

Note

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

This API returns new CartToken in the CartToken attribute. The API call is used to help validate vouchers/coupons used on the Checkout page. If the voucher is valid, the merchant’s platform is responsible for applying this voucher to the shopper's basket and executing a new SendCart / SendCartV2 API call to Global‑e, with an indication of the newly generated discount for this voucher or coupon. The new CartToken returned from this call is returned in the CartToken attribute.

Method/URL

https://www.merchant-site-domain.com/checkout-validate-cart-voucher-url

Parameters

Request

Name	Type	Description	Mandatory
Merchant.CartVoucherValidation	Object Merchant.CartVoucherValidation	Provides information related to validating a voucher in a cart.

Merchant.CartVoucherValidation

Parameter Name	Type	Description	Mandatory
`CartHash`	String	Cart hash originally specified in `merchantCartHash` argument for `SendCart` method for the cart converted to this order on Global‑e.
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for `SendCart` method for the cart converted to this order on Global‑e.
`CartToken`	String	The value returned from the previous call to `SendCart` for the same client (must be stored in the client session or persistent cookie on the Merchant’s side). This parameter is used to support cart updates.
`CountryCode`	String	2-char ISO country code
`CurrencyCode`	String	3-char ISO currency code.
`Discounts`	List of `Merchant.DiscountVoucherValidation`	Cart discounts for voucher validation.
`FreeShippingCouponCode`	String	The Merchant free shipping coupon code applied by the end customer.
`IsFreeShipping`	Bool	Indicates if the Merchant offers free international shipping to the end customer.
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`Products`	List of `Merchant.ProductVoucherValidation`	Cart products for voucher validation.
`UserId`	String	Internal User identifier on the Merchant’s site in case it was specified in the `SendCart` call.	No
`VoucherCode`	String	The voucher code specified on the Merchant site.
`VoucherType`	Decimal	Enumeration of `VoucherTypes`: 1 - `DiscountVoucher`
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store where the current cart is originating from. This code should be used in case of a multi-store setup on the Merchant’s site.
`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.

Object Merchant.DiscountVoucherValidation

Parameter Name	Type	Description	Mandatory
`CouponCode`	String	Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only)	No
`Description`	String	Discount textual description	No
`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
`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.
`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
`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
`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
c	String	Discount name
`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.
`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
`VATRate`	Decimal	The VAT rate applied to this discount

Object Merchant.ProductVoucherValidation

Parameter Name	Type	Description
`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.
`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.
`Categories` - DEPRECATED	List of String	List of categories mapped for current cart product.
`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.
`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.
`Price`	Decimal	Product price.
`Quantity`	Decimal	Product ordered quantity.
`Sku`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).
`VATRate`	Decimal	The VAT rate applied to this product.

Response

Name	Type	Description	Mandatory
Merchant.VoucherValidationResponse	Object Merchant.VoucherValidationResponse	Provides information related to the voucher validation.

Object Merchant.VoucherValidationResponse

Parameter Name	Type	Description
`CartToken`	String	`CartToken` returned from the new `SendCart` / `SendCartV2` API call, executed after the voucher has been applied to the respective user’s basket
`IsVoucherValid`	Boolean	Indicates if the voucher is valid. TRUE - Voucher is valid. FALSE - Voucher is not valid.
`ValidationFaliureMessage`	String	Error message in case voucher is not valid
`VoucherRestrictions`	List of `Merchant.VoucherValidationRestriction`	List of validation restrictions applied to vouchers
`VoucherType`	Decimal	Enumeration of `VoucherTypes`: 1 - DiscountVoucher

Object Merchant.VoucherValidationRestriction

Parameter Name

Type

Description

Mandatory

RestrictionEntityCode

String

Country code value.

VoucherValidationRestrictionType

Decimal

Enumeration of the voucher value restriction type:

0 - Country

Documentation Portal

Webhooks

ClientApplyLoyaltyVouchers (Global-e to Merchant)

Note

Parameters

Objects for ClientApplyLoyaltyVouchers API

Object Merchant.CartAction

Object Merchant.ResponseInfo

Examples

GetCheckoutCartInfo (Global-e to Merchant)

Note

Parameters

Note

Object CheckoutCartInfo

Object CartUserDetails

Object AddressDetails

Object UserIdNumberType

Object Discounts

Object KeyValuePair

Object LoyaltyPoints

Object Product

Object Attributes

Object Brand

Object Category

Object MetaData

Object Attributes

Object VATCategory

Object VATRateType

Object ShippingOption

Object UserDetails

Object UserIdNumberType

Examples

NotifyOrderRefund (Global-e to Merchant)

Parameters

Object Merchant.OrderRefund

Object Merchant.OrderRefundReason

Object Merchant.RefundComponent

Object Merchant.RefundProduct

Object Merchant.OrderRefundReason

Note

Merchant.ResponseInfo

Example

PerformOrderPayment (Global-e to Merchant)

Note

Parameters

Note

Object Merchant.Order

Object DTBreakdown

Object Merchant.Customer

Object Merchant.CustomerDetails

Object Merchant.Discount

Object Merchant.InternationalDetails

Object DTBreakdown

Object Merchant.Parcel

Object Merchant.ParcelProduct

Object Merchant.OriginalOrder

Object Merchant.Parcel

Object Merchant.ParcelProduct

Object Merchant.PaymentDetails

Object Merchant.Product

Object DTBreakdown

Object Merchant.Brand

Object Merchant.Category

Object Merchant.CartProductAttribute

Object Merchant.ProductAttribute

Object OrderDocument

Object OrderPaymentMethod

Object OrderStatusReason

Examples

RedeemGiftCard (Global-e to Merchant)

Parameters

Objects for RedeemGiftCard API

Object RefundGiftCardRequest

Object GiftCardData

Object BaseGiftCard

Object RedeemGiftCardResponse

Object GiftCardData

Object BaseGiftCard

Examples

RefundGiftCard