Pricing Methods

GetCatalogPrices API

Note

This API endpoint is used to pull the catalogue prices for international markets. If the merchant wishes it to be fully automated for new products, we need to make sure that they also upload catalogues through SFTP, otherwise, some new products may not exist in the Global-e Database.

Request sent by the merchant:

A list of countries - two letters country codes (ISO2), for which international prices product feed is required.
A list of products for which international prices product feed is required, with the following details for each product:
- ProductCode (SKU) - ProductCode (SKU) for the product.
- OriginalCurrencyCode - Optional. Currency code for the received product. If left empty, then the default merchant currency will be assumed.
- OriginalSalePrice per product - Price in original currency.
- VATRate - Local VAT rate of the product in the merchant country.
- ProductClassCode - Optional. Product class code used by the merchant to overwrite country coefficient rate.
- IsPriceIncludeVAT- Optional. The default value is True. Indicates whether the price includes the merchant country's local VAT rate.

Response sent by Global‑e:

The Merchant receives back a list of SKUs and related prices in the countries that were sent in the request.

GetCatalogPrices Method

GetCatalogPrices (FullProductCatalogRequest request)

Receives a catalogue conversion request from a merchant and returns the requested list of country and currency prices for the catalogue .

Request URL (link to the QA environment):

http://{globale_api_domain}/Browsing/GetCatalogPrices

Sample

Request Body:

{    
    "Countries": [
        {         
            "CountryCode": "FR"         
        },
        {            
            "CountryCode": "DE"            
        }
    ],    
    "Products": [{            
            "ProductCode": "565571",            
            "OriginalCurrencyCode": "GBP",            
            "OriginalSalePrice": 100.0000,            
            "VATRate": 0.0,            
            "ProductClassCode": null,            
            "IsPriceIncludeVAT": null            
        },
        {            
            "ProductCode": "565571",            
            "OriginalCurrencyCode": "GBP",            
            "OriginalSalePrice": 20.000,            
            "VATRate": 20.0,            
            "ProductClassCode": null,            
            "IsPriceIncludeVAT": null            
        }
    ]    
}

Response:

{    
    "Products": [
        {            
            "ProductCode": "P1",            
            "Countries": [
                {                    
                    "CountryCode": "FR",                    
                    "Currency": {                        
                        "CurrencyCode": "EUR",                        
                        "Price": 142.95                        
                    }                    
                },
                {                    
                    "CountryCode": "DE",                    
                    "Currency": {                        
                        "CurrencyCode": "EUR",                        
                        "Price": 141.95                        
                    }                    
                }                
            ]            
        },
        {            
            "ProductCode": "P2",            
            "Countries": [
                {                    
                    "CountryCode": "FR",                    
                    "Currency": {                        
                        "CurrencyCode": "EUR",                        
                        "Price": 23.95                        
                    }                    
                },
                {                    
                    "CountryCode": "DE",                    
                    "Currency": {                        
                        "CurrencyCode": "EUR",                        
                        "Price": 23.95                        
                    }                    
                }                
            ]            
        }        
    ]    
}

Request Body

FullProductCatalogRequest request

Full request specification.

Includes: Products.

For each product: Countries.

Response Body

FullProductCatalogResponse class

FullProductCatalogRequest

Parameter	Type	Description	Mandatory (Y/N)
`Countries`	List<FullCatalogCountryRequest>	List of countries required for the response	Y
`Products`	List<CatalogProductRequest>	List of product information. Will include the entire catalogue required for the response	Y

CatalogProductRequest

Parameter	Type	Description	Mandatory (Y/N)
`IsPriceIncludeVAT`	Boolean	If not set, the default is True. Indicates whether the price includes merchant VAT rate.	N
`OriginalCurrencyCode`	String	Currency code for the received product. If left empty, the configured merchant currency is assumed	N
`OriginalSalePrice`	Decimal	Price in original currency
`ProductClassCode`	String	Product class code used by the merchant to overwrite country coefficient rate. If not set, the default is True. Indicates whether the price includes merchant VAT rate	N
`ProductCode`	String	ProductCode (SKU) for the product. Returned with the response for product identification
`VATRate`	Deimal	Local VAT rate of the product in the merchant country

FullCatalogCountryRequest

Parameter	Type	Description	Mandatory (Y/N)
`CountryCode`	String	Country code for the requested country

FullProductCatalogResponse

Parameter	Type	Description	Mandatory (Y/N)
`Products`	List<CatalogProductResponse>	List of requested products with a list of prices for each required country

CatalogCountryResponse

Parameter	Type	Description	Mandatory (Y/N)
`CountryCode`	String	CountryCode of the current returned country
`Currency`	List <CatalogCurrencyResponse>	List of relevant currency values for the current product and country

CatalogCurrencyResponse

Parameter	Type	Description	Mandatory (Y/N0
`CurrencyCode`	String	CurrencyCode of the current returned currency
`Price`	Decimal	Price for the specific product in the relevant country and currency

GetMerchantPriceDetails REST API

This API enables merchants to obtain the parameters required to calculate international product prices in a destination country's currency.

Method/URL:

GET https://[GEM_API_URL]/externalapi/GetMerchantPriceDetails?merchantToken=[Merchant id]&Country=[CountryCode]&Currency=[CurrencyCode]

Request query type: string

Parameters:

GEM_API_URL	The API host name, based on the environment (such as sandbox, live, and more).
MerchantToken	Secret token (unique merchant ID) to be provided to the merchant by Global‑e.
Country	2-char ISO destination country code. Example: IL
Currency	3-char ISO currency code of the customer's country (destination country). Example: ILS

Response

{
	"countryCode": "IL",                       
	"countryCode3": "ISR",											
	"countryName": "Israel",										
	"currencySymbol": "₪",										  	
	"currencyCode": "ILS",											
	"currencyFormatSymbol": {										
		"PlaceCurrencySymbolBeforePrice": true,
		"UseCurrencySymbolSpace": false
	},
	"currencyDecimalNominator": ".",					
	"currencyThousandSeparator": ",",						
	"currencyDecimalPlaces": 0,						
	"culture": "he",												    
	"baseCountryCode": "GB",										
	"baseCurrencySymbol": "£",									
	"baseCurrencyCode": "GBP",										
	"baseCurrencyDecimalPlaces": 2,							
	"isOperatedByGlobale": true,							
	"currencyConversionRate": 284.001848944500,	
	"countryCoefficientRate": 1.050000,					
	"productClassCoefficients": {								
		"extra-charge": 1.800000									
	},
	"isGrossPrices": true,										
	"roundingRules": {												
		"RoundingRuleId": 108,
		"CurrencyCode": "ILS",									
		"CountryCode": null,									
		"RoundingRanges": [{									
			"From": 1.0000,
			"To": 100.0000,
			"Threshold": 0.0100,
			"LowerTarget": 1.0000,
			"UpperTarget": 1.0000,
			"RangeBehavior": 3,
			"TargetBehaviorHelperValue": 1.0000,
			"RoundingExceptions": []
		}, {
			"From": 100.0000,
			"To": 1000.0000,
			"Threshold": 5.0100,
			"LowerTarget": 15.0000,
			"UpperTarget": 10.0000,
			"RangeBehavior": 3,
			"TargetBehaviorHelperValue": 10.0000,
			"RoundingExceptions": []
		}, {
			"From": 1000.0000,
			"To": 10000.0000,
			"Threshold": 50.0100,
			"LowerTarget": 150.0000,
			"UpperTarget": 100.0000,
			"RangeBehavior": 3,
			"TargetBehaviorHelperValue": 100.0000,
			"RoundingExceptions": []
		}, {
			"From": 10000.0000,
			"To": 100000000000000.0000,
			"Threshold": 0.0100,
			"LowerTarget": 100.0000,
			"UpperTarget": 100.0000,
			"RangeBehavior": 3,
			"TargetBehaviorHelperValue": 100.0000,
			"RoundingExceptions": []
		}]
	},
	"vatSettings": {												
		"VATTypeId": 0,											
		"LocalVATRate": 20.000000,								
		"DistanceSellingVATRate": 20.000000,						
		"UseDistanceSellingVAT": false								
	}
    }
});

Documentation Portal