Skip to main content

Documentation Portal

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