Browsing Support Methods

Note

These methods are implemented by the Global-e extensions and plug-ins and do not need to be implemented by the brand.

ActiveHubDetails

Returns the shipping and other details of Global‑e’s Local Hub to where the merchant ships orders. The hubId property of the HubDetails object is returned by this method and must be further provided as an argument to the SendCart method.

Method/URL

https://{server_name}/Browsing/ActiveHubDetails

Parameters

Response

Parameter Name	Type	Description	Mandatory
`HubDetails`	Object `HubDetails`	Details about Global-e's hub

HubDetails

Parameter Name	Type	Description
`Address1`	String	Address line 1
`Address2`	String	Address line 2
`City`	String	City name
`CountryCode`	String	2-char ISO country code
`CountryName`	String	Country name
`Email`	String	E-mail address
`Fax`	String	Fax
`HubId`	Decimal	Hub identifier on Global‑e system
`HubName`	String	Name of the Hub
`Phone1`	String	Phone #1
`Phone2`	String	Phone #2
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)
`StateOrProvice`	String	State or province name
`Zip`	String	Zip or postal code

AppSettings

Returns the lists of client and server-side settings to be used by the Merchant. The original JSON string is returned in the AppSettings.ClientSettings property must be passed back to Global‑e client SDK as received.

The sample string may look like this: {"AllowTracking":{"value":"true"},"Opacity":{"value":"0.8"}}.

Method/URL

https://{server_name}/Browsing/AppSettings

Parameter

Request

Parameter Name	Type	Description	Mandatory
`WebStoreCodes`	Object `WebStoreCodes`	Includes web store code and web store instance code to get the merchant app setting for the specific merchant web store instance/domain	No

Parameter Name	Type	Description	Mandatory
`WebStoreCode`	String	The code of the merchant web store
`WebStoreInstanceCode`	String	The code of the instance of the web store

Return

Parameter Name	Type	Description	Mandatory
`AppSetting`	Object `AppSetting`	Details about API version and client/server settings

AppSettings

Parameter Name	Type	Description	Mandatory
`ClientSettings`	Dictionary <string, `AppSetting`>	Dictionary of client-side settings
`ServerSettings`	Dictionary <string, `AppSetting`>	Dictionary of server-side settings

Parameter Name	Type	Description	Mandatory
`Value`	String	Application setting value

Example

Response

{
    "WebStoreCode": "default",
    "WebStoreInstanceCode": "QA1"
}

AppVersion

Returns identifiers of the current versions of Global‑e API and of the client-side code that may be referenced by the Merchant’s site to render Global‑e-specific screens such as the Welcome Pop-up and Country Switcher.

Method/URL

https://{server_name}/Browsing/AppVersion

Parameters

Response

Parameter Name	Type	Description	Mandatory
`AppVersion`	Object `AppVersion`	Details about API version.

Parameter Name	Type	Description	Mandatory
`Value`	String	Version identifier of Global-e API
`WebClientVersion`	String	Version identifier of Global-e client-side (JS) code

Countries

Returns the list of supported countries including the indication for each country if it is being operated by Global‑e or by the Merchant. If the Merchant’s site already includes its own list of countries, this list must be replaced with the list returned by this method.

Method/URL

https://{server_name}/Browsing/Countries

Parameters

Request

Parameter Name	Type	Description	Mandatory
`countryCode`	String	2-char ISO country code. If not specified, all the countries supported by the merchant will be returned	No
`cultureCode`	String	ISO culture code. If specified, the textual properties (for example `Name`) will be returned in the requested culture’s language. Texts in English will be returned by default for the countries where the texts for the requested culture are unavailable or if the `cultureCode` argument has not been specified.	No

Parameter Name

Type

Description

Mandatory

countryCode

String

2-char ISO country code.

If not specified, all the countries supported by the merchant will be returned

cultureCode

String

ISO culture code.

If specified, the textual properties (for example Name) will be returned in the requested culture’s language. Texts in English will be returned by default for the countries where the texts for the requested culture are unavailable or if the cultureCode argument has not been specified.

Response

Parameter Name	Type	Description	Mandatory
`Country`	List of `Country`	List of supported countries, list of object `Country`

Country

Parameter Name	Type	Description	Mandatory
`Code`	String	2-char ISO country code
`DefaultCurrencyCode`	String	3-char ISO currency code
`DefaultVATRateType`	Object `VATRateType`	Default (most widely used) VAT rate type or class for this country.	No
`IsOperatedByGlobalE`	Boolean	Flag to be used as a Mode indicator. Countries that are not operated by Global‑e can still be available for selection as a shipping destination on the Merchant site. However Global‑e functionality is disabled for such countries. TRUE - Country is operated by Global-e. FALSE - Country is not operated by Global-e.
`IsStateMandatory`	Boolean	Indicates if State or province (region) is mandatory for addresses in this country. TRUE - State is mandatory for address. FALSE - State is not mandatory for address.
`Name`	String	Country name
`SiteURL`	String	URL of a country-specific site owned by the Merchant. Used to allow redirection to the Merchant’s country-specific domain for a selected country.
`SupportsFixedPrices`	Boolean	Indicates if fixed product prices are allowed for this country. Product prices may be fixed only in the Default Currency for this Country. TRUE - Prices can be fixed. FALSE - Prices cannot be fixed.	No
`UseCountryVAT`	Boolean	TRUE if VAT rate specific to this shipping country must be applied to the product prices. Otherwise, VAT rates defined for the products on the Merchant’s site must be used. This setting is used to support trade agreements between the countries such as EEA, when the end customer must pay VAT for the shipping country in certain cases.	No

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)

CountryCoefficients

Returns the list of pricing adjustment settings agreed between Global‑e and the Merchant, for the end customers shipping to the country (if countryCode is specified), or to all the supported countries (if countryCode is not specified).

The list includes both country-level records (where ProductClassCode is empty) and product class-level records (where IncludeVAT is empty but ProductClassCode is not empty).

Method/URL

https://{server_name}/Browsing/CountryCoefficients

Parameters

Request

Parameter Name	Type	Description	Mandatory
`countryCode`	String	2-char ISO country code. If not specified, all the Country Coefficients for the countries supported by the Merchant will be returned	No

Response

Parameter Name	Type	Description	Mandatory
`CountryCoefficient`	List of `CountryCoefficient`	List of country coefficients for calculating prices, list of pricing adjustment settings.

CountryCoefficient

Parameter Name	Type	Description	Mandatory
`CoefficientWithVATType`	Decimal	Depending on VATRateType . This value is calculated as follows: `“HideVAT “`“HideVAT “→ `CoefficientWithVATType` = Country coefficient `VATType` = `“PocketVAT”` → `CoefficientWithVATType` = Country coefficient * Origin Country (Merchant Country) VAT rate `VATType` = `“ForceVAT “` → `CoefficientWithVATType` = Country coefficient * Destination country VAT rate If Merchant Account Settings `“DisableVATAdjustmentForShopifyCoefficient“` = True → `CoefficientWithVATType` = Country Coefficient
`CountryCode`	String	2-char ISO country code
`IncludeVAT`	Decimal	This attribute is applicable only to the Country level (i.e. not applicable to the `Product Class` level). One of the possible values of `IncludeVATOptions` enumeration is designated to control the way VAT is handled in browsing on the Merchant’s site and in checkout on Global‑e. Following is a table with a list of `IncludeVATOptions` values and the expected results for the sample Product.	No
`ProductClassCode`	String	Product class code used by the Merchant to classify products for using different country coefficient rates per classes of products instead of the single country level default (when no rate is defined for a certain product class, the country level default rate should be used by the Merchant for the respective product).
`Rate`	Decimal	Country Coefficient rate decimal value. All the prices displayed to the end customer shipping to the country involved must be multiplied by this value.

The IncludeVATOptions enumeration is designated to control the way VAT is handled in browsing on the Merchant’s site and in checkout on Global‑e.

Following is the list of IncludeVATOptions values and the expected results for the sample Product.

In the table below we are considering a product with the original cost in the UK = 100 GBP before VAT to be shipped to Germany (with country coefficient Rate=1 and user selected currency=GBP, for simplicity).

For this sample product UK VAT=20%, DE Duties Total=17%:

IncludeVAT Option Value	Description	Price In Browsing	Price In Checkout	Price Paid To Merchant (incl. VAT)	Checkout Duties Total	Checkout Total
0	Hide VAT (default)	100	100	120	17	117
2	Show VAT	120	100	120	17	117
4	“Pocket” VAT (increase the original price by the value of the respective product’s VAT)	120	120	144	20.4 (17%)	140.4
6	Force VAT (used to support trade agreements between the countries such as EEA, when the end customer must pay VAT; for simplicity assuming `UseCountryVAT`=false)	120	120	120	0	120
8	Force & Hide VAT (used to support trade agreements between the countries such as EEA, when end customer must pay VAT but VAT is not shown in browsing; for simplicity assuming `UseCountryVAT`=false)	100	120	120	0	120

Currencies

Returns the list of supported currencies

Method/URL

https://{server_name}/Browsing/Currencies

Parameters

Request

Parameter Name	Type	Description	Mandatory
`currencyCode`	String	3-char ISO currency code. If not specified, all the currencies supported by the Merchant will be returned	No
`cultureCode`	String	ISO culture code. If specified, the textual properties (i.e. Name) will be returned in the requested culture’s language. Texts in English will be returned by default for the currencies where the texts for the requested culture are unavailable or if the `cultureCode` argument has not been specified	No

Request

Parameter Name	Type	Description	Mandatory
`Currency`	List of `Currency`	List of currencies

Currency

Parameter Name	Type	Description
`Code`	String	3-char ISO currency code
`MaxDecimalPlaces`	Decimal	The number of decimal places indicating the fractional (“cents”) part of the price. For example, Bahraini Dinar “cents” has 3 decimal places, US Dollar has 2, and Japanese Yen has 0.
`Name`	String	Currency name
`Symbol`	String	Currency symbol (e.g. $ for USD)

CurrencyRates

Returns the list of updated rates between the source and the target currency (if targetCurrencyCode is specified) or all the supported currencies (if targetCurrencyCode is not specified).

Method/URL

https://{server_name}/Browsing/CurrencyRates

Parameters

Request

Parameter Name	Type	Description	Mandatory
`sourceCurrencyCode`	String	3-char ISO currency code. If not specified, the default Merchant’s currency will be used instead	No
`targetCurrencyCode`	String	3-char ISO currency code. If not specified, all the rates for the currencies supported by the Merchant will be returned	No

Response

Parameter Name	Type	Description	Mandatory
`CurrencyRate`	List of `CurrencyRate`	List of `CurrencyRate` objects.

CurrencyRate

Parameter Name	Type	Description
`Rate`	Decimal	Currency rate decimal value
`RateData`	String	Currency data used by Global‑e to verify the rate
`SourceCurrencyCode`	String	3-char ISO currency code.
`TargetCurrencyCode`	String	3-char ISO currency code

LocationByIp

Returns the user’s geo-location by IP address. The merchant’s default location is returned if an IP address cannot be found (for example if a private network IP address has been specified).

The merchant-side caching policy defined by this method should be applied to the whole IP range returned for the IP address specified.

Method/URL

https://{server_name}/Browsing/LocationByIP

Parameter

Request

Parameter Name	Type	Description	Mandatory
`IP`	string	The shopper's IP address

Response

Parameter Name	Type	Description
`City`	Object `City`	The shopper's city.
`Country`	Object `Country`	The shopper's country.
`IPRange`	Object `IPRange`	The shopper's IP range.
`Region`	Object `Region`	The shopper's region.

Parameter Name	Type	Description	Mandatory
`Code`	String	City code (unique in the respective Region)
`Name`	String	City name

Country

Parameter Name	Type	Description	Mandatory
`Code`	String	2-char ISO country code
`DefaultCurrencyCode`	String	3-char ISO currency code
`DefaultVATRateType`	Object `VATRateType`	Default (most widely used) VAT rate type or class for this country.	No
`IsOperatedByGlobalE`	Boolean	Flag to be used as a Mode indicator. Countries that are not operated by Global‑e can still be available for selection as a shipping destination on the Merchant site. However Global‑e functionality is disabled for such countries. TRUE - Country is operated by Global-e. FALSE - Country is not operated by Global-e.
`IsStateMandatory`	Boolean	Indicates if State or province (region) is mandatory for addresses in this country. TRUE - State is mandatory for address. FALSE - State is not mandatory for address.
`Name`	String	Country name
`SiteURL`	String	URL of a country-specific site owned by the Merchant. Used to allow redirection to the Merchant’s country-specific domain for a selected country.
`SupportsFixedPrices`	Boolean	Indicates if fixed product prices are allowed for this country. Product prices may be fixed only in the Default Currency for this Country. TRUE - Prices can be fixed. FALSE - Prices cannot be fixed.	No
`UseCountryVAT`	Boolean	TRUE if VAT rate specific to this shipping country must be applied to the product prices. Otherwise, VAT rates defined for the products on the Merchant’s site must be used. This setting is used to support trade agreements between the countries such as EEA, when the end customer must pay VAT for the shipping country in certain cases.	No

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)

IPRange

A sample code to convert dot-decimal to decimal IPV4 address is available here: http://stackoverflow.com/questions/11548273/convert-an-ip-address-to-its-decimal-equivalent-in-java

Parameter Name	Type	Description
`From`	Decimal	A decimal value of a range start
`To`	Decimal	A decimal value of a range end
`Type`	String	Either IPV4 or IPV6

Region

Parameter Name	Type	Description
`Code`	String	Region code for this state or province (unique in the respective Country)
`CountryCode`	String	2-char ISO country code to which this region belongs
`Name`	String	Region name

LocationDefaultCulture

Returns the default Culture for the user’s location specified.

Method/URL

https://{server_name}/Browsing/LocationDefaultCulture

Parameters

Request

Parameter Name	Type	Description	Mandatory
`cityCode`	String	City code (unique in the respective Region).	No
`countryCode`	String	2-char ISO country code.
`regionCode`	String	Region code (unique in the respective Country)	No

Response

Parameter Name	Type	Description	Mandatory
`Culture`	Object `Culture`	Culture definition for this location.

Culture

Parameter Name	Type	Description
`Code`	String	ISO culture code
`IsRTL`	Boolean	Identifies if language is a “right-to-left” language such as Hebrew and Arabic. TRUE if “right-to-left” language FALSE if not “right-to-left” language
`LocalizedName`	String	Culture name in the respective language, such as “עברית” for he-IL (Hebrew-Israel) culture
`Name`	String	Culture name

LocationsDefaultCulturesList

Returns the list of locations and their respective default Cultures. This method may be used as an alternative for calling LocationDefaultCulture for every user’s geo-location returned by the LocationByIp method.

If LocationsDefaultCulturesList returns no LocationCulture item matching Country, Region, and City determined by LocationByIp, the fallback is to use the LocationCulture item with matching Country, matching Region, and empty value for City.

If there is no LocationCulture with the matching Country and Region as well, the fallback is to use the LocationCulture item with a matching Country, empty value for Region, and empty value for City.

Method/URL

https://{server_name}/Browsing/LocationsDefaultCulturesList

Parameters

Response

Parameter Name	Type	Description	Mandatory
`LocationCulture`	List of `LocationCulture`	Returns the list of locations and their respective cultures

LocationCulture

Parameter Name	Type	Description
`CityCode`	String	City code (unique in the respective Region)
`CountryCode`	String	2-char ISO country code
`Culture`	Object `Culture`	Culture definition for this location
`RegionCode`	String	Region code (unique in the respective `Country`)

Culture

Parameter Name	Type	Description
`Code`	String	ISO culture code
`IsRTL`	Boolean	Identifies if language is a “right-to-left” language such as Hebrew and Arabic. TRUE if “right-to-left” language FALSE if not “right-to-left” language
`LocalizedName`	String	Culture name in the respective language, such as “עברית” for he-IL (Hebrew-Israel) culture
`Name`	String	Culture name

ProductCountryS

Returns the list of ProductCountry objects for the list of products specified.

Method/URL

https://{server_name}/Browsing/ProductCountryS

Parameter

Request

Parameter Name	Type	Description
`countryCode`	String	2-char ISO country code of the end customer’s shipping country.
`cultureCode`	String	ISO culture code. If specified, the textual properties (e.g. `RestrictionMessage`) will be returned in the requested culture’s language if available. Texts in English will be returned by default
`productCode`	List of SKU	List of SKU codes (strings) for the products involved

Response

Parameter Name	Type	Description	Mandatory
`ProductCountry`	List of `ProductCountry`	List of countries and their details for specified products

ProductCountry

Parameter Name	Type	Description	Mandatory
`CountryCode`	String	2-char ISO code of the shipping country
`ForbiddanceMessage`	String	Textual definition of the forbiddance (will be empty if `IsForbidden` is FALSE)
`IsForbidden`	Boolean	Indicates if Global-e supports shipping the product to this country. TRUE - Global-e does not support shipping the product to this country. Adding this product to the cart must be disabled completely. FALSE - The product can be shipped to this country.
`IsRestricted`	Boolean	Indicates if this product has import restrictions for this shipping country. TRUE - Product has import restrictions for this shipping country. If at least one restricted product is included in the Cart, the end customer will not be able to place the order with Global-e until the product is either removed from the Cart or a shipping country with no restrictions for this product is selected. FALSE - Product does not have import restrictions.
`IsVerified`	Boolean	Indicates if product restrictions and other data contained in this object have been verified by Global‑e (i.e. some algorithmic approximations may be used by the system until manually resolved by Global‑e personnel). TRUE - Product restrictions/data have been verified. FALSE - Restrictions not verified.
`ProductCode`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)
`RestrictionMessage`	String	Textual definition of the restriction (will be empty if `IsRestricted` is FALSE)
`TTL`	Decimal	Time-to-live interval (in seconds) before this object must be refreshed from the Global-e server. This property overwrites the “max-age” header returned by any method call which returns the `ProductCountry` object.
`UploadedViaCatalog`	Boolean	Indicates whether the product was uploaded via catalogue or not. TRUE - Product was uploaded via catalogue. FALSE - Product was not uploaded via catalogue.
`VATRateType`	Object `VATRateType`	Product’s VAT rate type or class to be used for this product in this shipping country. If not specified, the respective VATCategoryCountry’s `VATRateType` or Country’s `DefaultVATRateType` must be used if applicable according to the UseCountryVAT value for this country. Otherwise, the VAT rate defined for this product on the Merchant’s site must be used.	No

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)

RecentProductCountryS

Returns the list of ProductCountry objects requested by the Merchant since requestId is specified.

This method may be used by the Merchants to load to their local “cache” ProductCountries storage, product “country exceptions” (product/country combinations that have commercial or regulatory country-specific restrictions, as well as any non-standard VAT rates that should be applied to the respective products in the respective EU countries).

For the first call to RecentProductCountryS, requestId=0 must be specified.

If any ProductCountry object record returned by RecentProductCountryS API is not "restricted", not "forbidden", and VATRateType's rate is equal to the respective country’s default VATRateType's rate, this indicates that this ProductCountry is “reverted” to “default” (no restrictions and default country VAT rate). In such a case, this ProductCountry should not be created in the local "cache" ProductCountries storage. If this ProductCountry already exists in the local "cache" storage, then it has to be deleted from there. Note that the IsForbidden flag actually denotes global restriction that is applied to ALL countries for the respective product. So if IsForbidden is set, it will be set for all countries, although in Global‑e core it’s actually a Product level flag (rather than ProductCountry level).

Method/URL

https://{server_name}/Browsing/RecentProductCountryS

Parameter

Request

Parameter Name	Type	Description	Mandatory
`requestID`	Decimal	Request identifier

Response

Parameter Name	Type	Description	Mandatory
`ProductCountry`	List of `ProductCountry`	List of countries related to products, list of ProductCountry objects
`RequestID`	Decimal	Request identifier

ProductCountry

Parameter Name	Type	Description	Mandatory
`CountryCode`	String	2-char ISO code of the shipping country
`ForbiddanceMessage`	String	Textual definition of the forbiddance (will be empty if `IsForbidden` is FALSE)
`IsForbidden`	Boolean	Indicates if Global-e supports shipping the product to this country. TRUE - Global-e does not support shipping the product to this country. Adding this product to the cart must be disabled completely. FALSE - The product can be shipped to this country.
`IsRestricted`	Boolean	Indicates if this product has import restrictions for this shipping country. TRUE - Product has import restrictions for this shipping country. If at least one restricted product is included in the Cart, the end customer will not be able to place the order with Global-e until the product is either removed from the Cart or a shipping country with no restrictions for this product is selected. FALSE - Product does not have import restrictions.
`IsVerified`	Boolean	Indicates if product restrictions and other data contained in this object have been verified by Global‑e (i.e. some algorithmic approximations may be used by the system until manually resolved by Global‑e personnel). TRUE - Product restrictions/data have been verified. FALSE - Restrictions not verified.
`ProductCode`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)
`RestrictionMessage`	String	Textual definition of the restriction (will be empty if `IsRestricted` is FALSE)
`TTL`	Decimal	Time-to-live interval (in seconds) before this object must be refreshed from the Global-e server. This property overwrites the “max-age” header returned by any method call which returns the `ProductCountry` object.
`UploadedViaCatalog`	Boolean	Indicates whether the product was uploaded via catalogue or not. TRUE - Product was uploaded via catalogue. FALSE - Product was not uploaded via catalogue.
`VATRateType`	Object `VATRateType`	Product’s VAT rate type or class to be used for this product in this shipping country. If not specified, the respective VATCategoryCountry’s `VATRateType` or Country’s `DefaultVATRateType` must be used if applicable according to the UseCountryVAT value for this country. Otherwise, the VAT rate defined for this product on the Merchant’s site must be used.	No

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)

Regions

Returns the list of regions (states or provinces) optionally filtered by Country. The list might include only the regions for the countries where specifying a region in address is mandatory (IsStateMandatory = true).

Method/URL

https://{server_name}/Browsing/Regions

Parameters

Request

Parameter Name	Type	Description	Mandatory
`countryCode`	String	2-char ISO country code. If not specified, all the countries supported by the Merchant will be returned	No
`cultureCode`	String	ISO culture code. If specified, the textual properties (i.e. Name) will be returned in the requested culture’s language. Texts in English will be returned by default for the regions where the texts for the requested culture are unavailable or if the `cultureCode` argument has not been specified	No

Response

Parameter Name	Type	Description	Mandatory
`Region`	List of `Region`	Returns the list of regions (states or provinces), list of Region objects.

Region

Parameter Name	Type	Description
`Code`	String	Region code for this state or province (unique in the respective Country)
`CountryCode`	String	2-char ISO country code to which this region belongs
`Name`	String	Region name

RoundingRules

Returns the list of rounding rules, optionally filtered by currency and country

Method/URL

https://{server_name}/Browsing/RoundingRules

Parameters

Request

Parameter Name	Type	Description	Mandatory
`countryCode`	String	2-char ISO country code. If not specified, rounding rules for all the countries supported by the Merchant will be returned	No
`currencyCode`	String	3-char ISO currency code. If not specified, rounding rules for all the currencies supported by the Merchant will be returned	No

Response

Parameter Name	Type	Description	Mandatory
`RoundingRule`	List of `RoundingRule`	Returns list of rounding rules for currency.

RoundingRule

Parameter Name	Type	Description
`CountryCode`	String	2-char ISO country code
`CurrencyCode`	String	3-char ISO currency code
`RoundingRanges`	List of `RoundingRange`	List of decimal ranges and their respective rounding behavior.
`RoundingRuleId`	Decimal	Rule identifier denoting the respective Rounding Rule on the Global‑e side. This value must be further specified when calling `SaveProductsList` and `SendCart` methods

RoundingRange

Parameter Name	Type	Description
`From`	Decimal	A decimal value of the range start, exclusive of the `From` value itself. If a range must start from 0 inclusive, the `From` value must be set to a negative number.
`LowerTarget`	Decimal	A decimal value used to calculate the target rounded value, for the numbers less than the `Threshold`, according to the defined `Range` behavior. If the `LowerTarget` value violates the `MaxDecimalPlaces` setting for the respective currency, it must be truncated as described in the “Important Notices” below.
`RangeBehavior`	Decimal	One of the possible values of `RangeBehaviors` enumeration defined below which is designed to control the way rounding range is handled. The range behavior is applied to `Threshold`, `LowerTarget`, `UpperTarget` and `Exceptions` in the `RoundingExceptions` list.
`RoundingExceptions`	List of `RoundingException`	List of decimal values used to calculate the exceptions for rounding, i.e. values not to apply rounding for. `RangeBehaviors` enumeration: see Table 1 and Table 2.
`TargetBehaviorHelperValue`	Decimal	A decimal value required for the “nearest target” and “relative whole target” behavior.
`Threshold`	Decimal	A decimal value used to split the range so that the values less than the threshold would be rounded to the Lower target, and values greater than or equal to the threshold would be rounded to the Upper target. For the "Absolute target," the threshold range is an absolute value. Other Ranges are Relative values. See the absolute target in Rounding Range for more information. RoundingRange
`To`	Decimal	A decimal value of the range end, inclusive.
`UpperTarget`	Decimal	A decimal value used to calculate the target rounded value, for the numbers greater than or equal to the Threshold, according to the defined Range behavior. If the `UpperTarget` value violates the `MaxDecimalPlaces` setting for the respective currency, it must be truncated as described in the “Important Notices” below.

Table 1: RoundingException

List of decimal values used to calculate the exceptions for rounding, i.e. values not to apply rounding for.

RangeBehaviors enumeration:

RangeBehaviors Option Value	Name	Description
1	Absolute target	In this behavior all the values within the specified range (`LowerTarget, UpperTarget, Threshold and RoundingExceptions`) denote the values themselves as is, without the need for any additional math operations. Getting rounding result (R) for the source number (S) must be implemented as follows: If (S = Exceptionn) then R = Exceptionn If (S < Threshold) then R = LowerTarget If (S >= Threshold) then R = UpperTarget
2	Relative Decimal target	In this behavior all the values within the specified range (`LowerTarget, UpperTarget, Threshold and RoundingExceptions`) represent floating point numbers between 0 (inclusive) and 1 (inclusive), used to calculate the respective absolute values, relative to the calculation base (B) as follows: For source number (S): B = whole part of S LowerTarget (absolute): LA = B – 1 + LowerTarget UpperTarget (absolute): UA = B + UpperTarget Threshold (absolute): TA = B + Threshold Exceptionn (absolute): EAn = B + Exceptionn If (S = EAn) then Result (R) = EAn If (S < TA) then R = LA If (S >= TA) then R = UA
3	Relative Whole target	In this behavior LL the values within the specified range (`LowerTarget, UpperTarget, Threshold and RoundingExceptions`) represent non-negative whole numbers, while `TargetBehaviorHelperValue (V)` is used to determine the calculation base (B). V must be a power of 10 (10, 100, 1000, etc.) and denotes the order of magnitude for the range “split” by the Threshold. For example, if Threshold = 9 we need to know if this is 9 out of 10 or 9 out of 100. Getting rounding result (R) for the source number (S) must be implemented as follows: For source number (S): B = S rounded down to the closest multiple of V For example if (S = 56789 and V = 1000) then B = 56000 LowerTarget (absolute): LA = B – V + LowerTarget UpperTarget (absolute): UA = B + UpperTarget Threshold (absolute): TA = B + Threshold Exceptionn (absolute): EAn = B + Exceptionn If (S = EAn) then Result (R) = EAn If (S < TA) then R = LA If (S >= TA) then R = UA
4	Nearest target	In this behavior, `LowerTarget` and `UpperTarget` represent non-negative floating-point numbers, while TargetBehaviorHelperValue (V) is used to determine the calculation base (B). V must be a whole divisor of any power of 10 (5, 10, 25, 50, 100, 250, 500, 1000, etc.). The threshold must be any floating-point number between 0 (inclusive) and V (exclusive). Getting rounding result (R) for the source number (S) must be implemented as follows: For source number (S): B = S rounded down to the closest multiple of V For example, if (S = 123 and V = 5) then B = 120 LowerTarget (absolute): LA = B – 1 + LowerTarget UpperTarget (absolute): UA = B – 1 + V + UpperTarget Threshold (absolute): TA = B + Threshold Exceptionn (absolute): EAn = B + Exceptionn If (S = EAn) then Result (R) = EAn If (S < TA) then R = LA If (S >= TA) then R = UA

Important Notices

If the result of rounding is a negative number, it must be set to zero, for any rounding behavior defined in the table above.

If either LowerTarget or UpperTarget value violates MaxDecimalPlaces setting for the respective currency, this value must be truncated accordingly. For example, if UpperTarget is set to 0.999 for USD, it must be truncated to 0.99 before using in any further calculations.

Table 2: Rounding Rules Samples

The following samples indicate how rounding X to Y (X → Y) is implemented using the respective settings.

	0.25 → 0 3 → 0 1.5 → 1.5 2 → 2	22.47 → 21.95 22.48 → 22.99 22.50 → 22.50 33.75 → 33.75	2047 → 1995 2048 → 2100	122.26 → 124.99 122.25 → 119.99 127.26 → 129.99 121.50 → 121.50 127.50 → 127.50 123 → 123 128 → 128	2047 → 1999 2048 → 2100
From	0	1	1000	100	1000
To	3	250	10000	1000	10000
Threshold	3.01	0.48	48	2.26	48
LowerTarget	0	0.95	95	0.99	0
UpperTarget	0	0.99	100	0.99	1
RangeBehavior	1 Absolute	2 Relative Decimal	3 Relative Whole	4 Nearest	4 Nearest
TargetBehaviorHelperValue			100	5	100
RoundingExceptions	1.5	0.50		1.50
	2	0.75		2.50
				3

SaveProductsList

Saves product data on the Global‑e system and returns the list of matching ProductCountry objects for the list of products specified. The caller is responsible for calling this method for every product not found (or invalidated) in the local cache on the Merchant side. Calling this method as soon as possible will allow Global‑e to map the products to their respective customs category and will therefore allow guaranteed landed cost offering for these products. Therefore, this method should be called when creating or updating the products on the Merchant’s back end as well.

Method/URL

https://{server_name}/Browsing/SaveProductsList

Parameters

Request

Parameter Name	Type	Description	Mandatory
`clientIP`	String	End customer’s IP address
`countryCode`	String	2-char ISO country code of the end customer’s shipping country
`cultureCode`	String	ISO culture code. If specified, the textual properties (e.g. RestrictionMessage) will be returned in the requested culture’s language if available. Texts in English will be returned by default.	No
`includeVAT`	Int64	`IncludeVAT` value returned from `CountryCoefficients` method
`inputDataCultureCode`	String	ISO culture code. Denotes the culture for the products’ textual properties being saved (e.g. Description). If not specified, the Merchant’s default culture will be assumed by default.	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
`priceCoefficientRate`	Decimal	Rate returned from `CountryCoefficients` method
`productsList`	List of `Product`	List of Product objects (specified in the request body)
`roundingRuleId`	Int64	The `RoundingRuleId` value returned from the `RoundingRules` method

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

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

MetaData

Parameter Name	Type	Description	Mandatory
`Attributes`	List of `Attributes`	Customer-defined product attributes that allow the personalisation of the product if supported by the merchant’s site (e.g. engraving)

Attributes

Parameter Name	Type	Description
`AttributeCode`	String	Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)
`AttributeTypeCode`	String	Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side)
`Name`	String	Attribute name

VATCategory

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT Category name
`VATCategoryCode`	String	Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side)

VATRateType

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT rate type name	No
`Rate`	Decimal	VAT rate decimal value
`VATRateTypeCode`	String	VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)

Response

Parameter Name	Type	Description	Mandatory
`ProductCountry`	List of `ProductCountry`	List of countries and their details for specified products

ProductCountry

Parameter Name	Type	Description	Mandatory
`CountryCode`	String	2-char ISO code of the shipping country
`ForbiddanceMessage`	String	Textual definition of the forbiddance (will be empty if `IsForbidden` is FALSE)
`IsForbidden`	Boolean	Indicates if Global-e supports shipping the product to this country. TRUE - Global-e does not support shipping the product to this country. Adding this product to the cart must be disabled completely. FALSE - The product can be shipped to this country.
`IsRestricted`	Boolean	Indicates if this product has import restrictions for this shipping country. TRUE - Product has import restrictions for this shipping country. If at least one restricted product is included in the Cart, the end customer will not be able to place the order with Global-e until the product is either removed from the Cart or a shipping country with no restrictions for this product is selected. FALSE - Product does not have import restrictions.
`IsVerified`	Boolean	Indicates if product restrictions and other data contained in this object have been verified by Global‑e (i.e. some algorithmic approximations may be used by the system until manually resolved by Global‑e personnel). TRUE - Product restrictions/data have been verified. FALSE - Restrictions not verified.
`ProductCode`	String	SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)
`RestrictionMessage`	String	Textual definition of the restriction (will be empty if `IsRestricted` is FALSE)
`TTL`	Decimal	Time-to-live interval (in seconds) before this object must be refreshed from the Global-e server. This property overwrites the “max-age” header returned by any method call which returns the `ProductCountry` object.
`UploadedViaCatalog`	Boolean	Indicates whether the product was uploaded via catalogue or not. TRUE - Product was uploaded via catalogue. FALSE - Product was not uploaded via catalogue.
`VATRateType`	Object `VATRateType`	Product’s VAT rate type or class to be used for this product in this shipping country. If not specified, the respective VATCategoryCountry’s `VATRateType` or Country’s `DefaultVATRateType` must be used if applicable according to the UseCountryVAT value for this country. Otherwise, the VAT rate defined for this product on the Merchant’s site must be used.	No

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)

Example

Request

[{
        "ProductCode": "1020872",
        "Name": "Lanolin",
        "Description": "Breast%20Feeding%20Ointment",
        "GenericHSCode": "",
        "OriginCountryCode": "",
        "Weight": "1.0000",
        "Height": null,
        "Length": null,
        "Volume": "60",
        "ImageURL": "\/a\/3\/a3c9ef_ece3bec0467310603bce72e9a58e33d3.jpg",
        "ImageHeight": "",
        "ImageWidth": "",
        "ListPrice": "25.0000",
        "OriginalListPrice": "17.7000",
        "SalePrice": "15.0000",
        "OriginalSalePrice": "17.7000",
        "VATRateType": {
            "VATRateTypeCode": 1,
            "Name": "Low",
            "Rate": "18.0000"
        },
        "VATCategory": {
            "VATCategoryCode": "640211",
            "Name": "Ski-boots"
        },
        "Brand": {
            "BrandCode": "7",
            "Name": "Brand2"
        },
        "Categories": [{
                "CategoryCode": "3",
                "Name": "Maternity"
            }
        ],
        "Attributes": [{
                "AttributeCode": "c034",
                "Name": "Red",
                "AttributeTypeCode": "color"
            }, {
                "AttributeCode": "s23",
                "Name": "XXL",
                "AttributeTypeCode": "size"
            }
        ]
    }
]

SaveProductsBulk

Saves the product data on the Global‑e system. This method is designated to be called from a Merchant’s back-end ERP system before the products are published on the Merchant’s website, to provide the data for duties and taxes calculation as soon as possible. Therefore, no end customer-specific information is expected to be provided (unlike in the SaveProductsList method mentioned in the Browsing section of this document).

Method/URL

https://{server_name}/Bulk/SaveProductsBulk

Parameters

Request

Parameter Name	Type	Description	Mandatory
`inputDataCultureCode`	String	ISO culture code. Denotes the culture for the products’ textual properties being saved (e.g. Description). If not specified, the Merchant’s default culture will be assumed by default	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
`productLists`	List of `Product`	List of Product objects (specified in the request body)

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

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

MetaData

Parameter Name	Type	Description	Mandatory
`Attributes`	List of `Attributes`	Customer-defined product attributes that allow the personalisation of the product if supported by the merchant’s site (e.g. engraving)

Attributes

Parameter Name	Type	Description
`AttributeCode`	String	Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)
`AttributeTypeCode`	String	Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side)
`Name`	String	Attribute name

VATCategory

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT Category name
`VATCategoryCode`	String	Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side)

VATRateType

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT rate type name	No
`Rate`	Decimal	VAT rate decimal value
`VATRateTypeCode`	String	VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)

Response

Parameter Name	Type	Description	Mandatory
`ResponseInfo`	Object `ResponseInfo`	Provides details regarding the API call response

ResponseInfo

Parameter Name

Type

Description

Mandatory

Success

Boolean

Indicates if the call was successful. Success property value may be only TRUE. Otherwise, ErrorInfo will be returned instead.

TRUE - Call was successful

FALSE - Call failed

For more information see ErrorInfo.

Reason

String

Text that optionally describes the reason for Success status.

Example

Request

[
  {
    "ProductCode":"1020872",
    "Name":"Lanolin",
    "Description":"Breast%20Feeding%20Ointment",
    "GenericHSCode":"",
    "OriginCountryCode":"",
    "Weight":"1.0000",
    "Height":null,"Length":null,
    "Volume":"60",
    "ImageURL":"\/a\/3\/a3c9ef_ece3bec0467310603bce72e9a58e33d3.jpg",
    "ImageHeight":"",
    "ImageWidth":"",
    "ListPrice":"25.0000",
    "OriginalListPrice":"17.7000",
    "SalePrice":"15.0000",
    "OriginalSalePrice":"17.7000",
    "VATRateType":{
      "VATRateTypeCode":1,
      "Name":"Low",
      "Rate":"18.0000"},
      "Brand":{
        "BrandCode":"7",
        "Name":"Brand2"
      },
      "Categories":[
         {
           "CategoryCode":"3",
           "Name":"Maternity"
         }
      ],
      "Attributes":[
         {
           "AttributeCode":"c034",
           "Name":"Red",
           "AttributeTypeCode":"colo
         },
         {
           "AttributeCode":"s23",
           "Name":"XXL",
           "AttributeTypeCode":"size"
         }
       ]
   }
]

ShippingOptions

Returns all available shipping options for the cart information specified either by cartToken or by including all the relevant checkoutCartInfo details.

Method/URL

https://{server_name}/Browsing/ShippingOptions

Parameters

Request

Parameter Name	Type	Description	Mandatory
`cartToken`	String	Merchants who implement API checkout only, may specify the Cart token returned by the `SendCart` method preceding the current method call. In this case, all other arguments will be ignored and the information stored in the respective Cart will be used instead	Either `cartToken` or `checkoutCartInfo` must be specified.
`checkoutCartInfo`	Object `CheckoutCartInfo`	Full cart information.	Either `cartToken` or `checkoutCartInfo` must be specified.

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

CartUserDetails

Parameter Name	Type	Description	Mandatory
`AddressDetails`	List of `AddressDetails`	All available addresses are taken from the registered customer address book	No
`UserId`	String	Internal User identifier on the Merchant’s site	No

AddressDetails

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

UserIdNumberType

Parameter Name	Type	Description	Mandatory
`Name`	String	Identification document type name
`UserIdNumberTypeCode`	String	Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side)

Discounts

Parameter Name	Type	Description	Mandatory
`CouponCode`	String	Merchant Coupon Code used for this discount (applicable to coupon-based discounts only). Max length: 100 chars.	No
`Description`	String	Discount textual description. Length: Unlimited.	No
`DiscountType`	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

KeyValuePair

Parameter Name	Type	Description	Mandatory
`Key`	String	Entity key (for example a URL parameter) used on the Merchant’s site (to be mapped on the Global‑e side)
`Value`	String	Entity value for the respective Key

LoyaltyPoints

Parameter Name	Type	Description	Mandatory
`LoyaltyPointsMaxSpend`	Decimal	The limit loyalty points that the user can use in this order – if not exists the `LoyaltyPointsTotal` is taken.	No
`LoyaltyPointsOriginalValueForEarn`	Decimal	Value of one loyalty point for earn, in Merchant currency – optional if `LoyaltyPointsOriginalForEarn` exists.	No
`LoyaltyPointsOriginalValueForSpend`	Decimal	Value of one loyalty point for spending, in Merchant currency – optional if `LoyaltyPointsValueForSpend` exists.	No
`LoyaltyPointsTotal`	Decimal	The total loyalty points the user has on account at the Merchant’s site	No
`LoyaltyPointsValueForEarn`	Decimal	Value of one loyalty point for earn, in customer currency – optional if `LoyaltyPointsOriginalValueForEarn` exists.	No
`LoyaltyPointsValueForSpend`	Decimal	Value of one loyalty point for spending, in customer currency – optional if `LoyaltyPointsOriginalValueForSpend` exists.	No

Product

Parameter Name	Type	Description	Mandatory
`Attributes`	List of `Attributes`	The product’s custom attributes (such as Color, Size, etc.)	No
`AttributesEnglish`	List of `Attributes`	The product’s custom attributes (such as Color, Size, etc.) in English	No
`BackOrderDate`	String	Estimated date for the backordered item to be in stock	No
`Brand`	Object `Brand`	The product’s brand	No
`CartItemId`	String	Identifier of the cart item on the Merchant’s site. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	No
`CartItemOptionId`	String	Identifier of the child cart item “option” on the Merchant’s site. This value must be specified if the current cart item is related to a parent item (`CartItemId` must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a package for the parent item in the same cart. This property may be optionally specified in the `SendCart` method only so that the same value can be posted back when creating the order on the Merchant’s site with the `SendOrderToMerchant` method.	No
`Categories`	List of `Category`	The product’s categories	No
`DeliveryQuantity`	Decimal	The quantity actually set for delivery for the product (to be used in the Order methods described below, as needed)	No
`Description`	String	Description of the Product
`DescriptionEnglish`	String	Description of the Product in English
`GenericHSCode`	String	The product’s generic HS Code (not country-specific). If specified this property may assist in mapping the product for duties and taxes calculation purposes.	No
`GiftMessage`	String	Optional “gift message” text defined by the end customer to be printed on the product.	No
`HandlingCode`	String	Code applicable to the product on the Merchant’s site. This code may be optionally used by the Merchant to trigger a certain business logic when this product is included in the order posted back to the Merchant’s site with the `SendOrderToMerchant` method.	No
`Height`	Decimal	The product’s height in the Merchant’s default unit of length measure (will be converted to CM).	No
`HubCode`	String	The Merchant hub code indicates from which hub the product was sent. Note that the HubCode should be mapped to a Global-e hubId on the Global-e side.	No
`ImageHeight`	Decimal	The product’s image height in pixels	No
`ImageURL`	String	The product’s image URL	No
`ImageWidth`	Decimal	The product’s image width in pixels
`IsBackOrdered`	Boolean	Boolean specifying if the product was ordered as a backed ordered item. TRUE - The item is back 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

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

MetaData

Parameter Name	Type	Description	Mandatory
`Attributes`	List of `Attributes`	Customer-defined product attributes that allow the personalisation of the product if supported by the merchant’s site (e.g. engraving)

Attributes

Parameter Name	Type	Description
`AttributeCode`	String	Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)
`AttributeTypeCode`	String	Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for "colour", etc. (to be mapped on the Global‑e side)
`Name`	String	Attribute name

VATCategory

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT Category name
`VATCategoryCode`	String	Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side)

VATRateType

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT rate type name	No
`Rate`	Decimal	VAT rate decimal value
`VATRateTypeCode`	String	VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)

ShippingOption

Parameter Name	Type	Description
`Carrier`	String	Carrier’s short name
`CarrierName`	String	Carrier’s full name
`CarrierTitle`	String	Carrier’s title
`Code`	String	Shipping method code used to identify the shipping option on the Merchant’s site (to be mapped on the Global‑e side)
`Method`	String	Shipping method name
`MethodTitle`	String	Shipping method title
`MethodDescription`	String	Shipping method description
`Price`	Decimal	Shipping price in Merchant’s original currency defined in the `originalCurrencyCode` argument of the respective method call (i.e. `SendCart`)

UserDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`City`	String	City name	No
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name	No
`Email`	String	E-mail address	No
`Fax`	String	Fax	No
`FirstName`	String	First name	No
`FirstNameInLocalCulture`	String	First name in local culture Ex: Kana Japanese dialect	No
`LastName`	String	Last name	No
`LastNameInLocalCulture`	String	Last name in local culture Ex: Kana Japanese dialect	No
`MiddleName`	String	Middle name	No
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.)	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvice`	String	State or province name	No
`UserId`	String	Internal User identifier on the Merchant site	No
`UserIdNumber`	String	User’s personal ID document number	No
`UserIdNumberType`	Object `UserIdNumberType`	User’s personal ID document type (e.g. Passport, ID card, etc.)	No
`Zip`	String	Zip or postal code	No

UserIdNumberType

Parameter Name	Type	Description	Mandatory
`Name`	String	Identification document type name
`UserIdNumberTypeCode`	String	Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side)

Response

Parameter Name	Type	Description	Mandatory
`CheckoutShippingOption`	List of `CheckoutShippingOption`	List of shipping options

CheckoutShippingOption

Parameter Name	Type	Description	Mandatory
`DeliveryDaysFrom`	Decimal	Minimum number of days for delivery to the end customer’s shipping country for this shipping option	No
`DeliveryDaysTo`	Decimal	Maximum number of delivery days to the end customer’s shipping country for this shipping option	No
`ForceDDP`	Decimal	One of the possible values of `ForceDDPTypes` enumeration denoting a type of DDP enforcement for this shipping option (applicable only if SupportsDDP is set to TRUE) as listed in the table below.
`Price`	Decimal	Shipping price in end customer currency for this cart
`PriceBeforeDiscount`	Decimal	Shipping price in end customer currency for this cart, before applying shipping discounts
`ShippingMethodId`	String	Unique identifier of the shipping method in the Global-e system
`ShippingMethodTypeName`	String	Shipping method type name
`SupportsDDP`	Boolean	Indicates if taxes & duties may be prepaid for this shipping option

ForceDDP

Contains one of the following possible values of the ForceDDPTypes enumeration:

ForceDDPType Option Value	Name	Description
0	Do Not Force DDP	Pre-payment of taxes & duties must NOT be forced.
1	Force DDP	Pre-payment of taxes & duties must be forced. The cost should be paid by the end customer.
2	Hidden Force DDP	Pre-payment of taxes & duties must be forced. The cost should be subsidized by the Merchant.

Example

Request for CheckoutCartInfo

[
  {
        "ProductCode": "1020872",
        "Name": "Lanolin",
        "Description": "Breast%20Feeding%20Ointment",
        "GenericHSCode": "",
        "OriginCountryCode": "",
        "Weight": "1.0000",
        "Height": null,
        "Length": null,
        "Volume": "60",
        "ImageURL": "\/a\/3\/a3c9ef_ece3bec0467310603bce72e9a58e33d3.jpg",
        "ImageHeight": "",
        "ImageWidth": "",
        "ListPrice": "25.0000",
        "OriginalListPrice": "17.7000",
        "SalePrice": "15.0000",
        "OriginalSalePrice": "17.7000",
        "VATRateType": {
            "VATRateTypeCode": 1,
            "Name": "Low",
            "Rate": "18.0000"
        },
        "Brand": {
            "BrandCode": "7",
            "Name": "Brand2"
        },
        "Categories": [{
                "CategoryCode": "3",
                "Name": "Maternity"
            }
        ],
        "OrderedQuantity": 1
    }
]

VATCategoryCountryS

Returns the list of VATCategoryCountry objects for the list of VAT categories specified.

Method/URL

https://{server_name}/Browsing/ProductCountryS

Parameter

Request

Parameter Name	Type	Description	Mandatory
`countryCode`	String	2-char ISO country code of the end customer’s shipping country
`vATCategoryCode`	List of `VATCategory`	List of `VATCategory` codes (strings) for the VAT Categories involved. If not specified, returns the full list of `VATCategoryCountry` records for this country.

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)

Response

Parameter Name	Type	Description	Mandatory
`VATCategoryCountry`	List of `VATCategoryCountry`	Returns the details for countries for the VAT category specified.

VATCategoryCountry

Parameter Name	Type	Description	Mandatory
`CountryCode`	String	2-char ISO code of the shipping country
`VATCategoryCode`	String	Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side)
`VATRateType`	Object `VATRateType`	Product VAT rate type or class to be used for the products related to this VAT Category in this shipping country, unless defined on `ProductCountry` level for the respective product. If `VATRateType` is not defined either on `ProductCountry` or on `VATCategoryCountry` levels, the respective country’s `DefaultVATRateType` must be used if applicable, according to the `UseCountryVAT` value for this country. Otherwise, the VAT rate defined for the respective products on the merchant’s site must be used	No

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)

Documentation Portal

Browsing Support Methods

Note

ActiveHubDetails

Parameters

HubDetails

AppSettings

Parameter

WebStoreCodes

AppSettings

AppSetting

Example

AppVersion

Parameters

AppVersion

Countries

Parameters

Country

VATRateType

CountryCoefficients

Parameters

CountryCoefficient

Currencies

Parameters

Currency

CurrencyRates

Parameters

CurrencyRate

LocationByIp

Parameter

City

Country

VATRateType

IPRange

Region

LocationDefaultCulture

Parameters

Culture

LocationsDefaultCulturesList

Parameters

LocationCulture

Culture

ProductCountryS

Parameter

ProductCountry

VATRateType

RecentProductCountryS

Parameter

ProductCountry

VATRateType

Regions

Parameters

Region

RoundingRules

Parameters

RoundingRule

RoundingRange

RoundingException

SaveProductsList

Parameters

Product

Attributes

Brand

Category

MetaData

Attributes

VATCategory

VATRateType

ProductCountry

VATRateType

Example

SaveProductsBulk

Parameters

Product

Attributes

Brand

Category

MetaData

Attributes

VATCategory