Skip to main content
Global-e reuses a set of standard object definitions across many API endpoints. This page collects those shared objects in one place so endpoint guides can link to them instead of repeating the definitions. It grows as more endpoints are migrated.
These are shared, cross-endpoint object definitions. An individual endpoint uses only the subset its own request or response references — always check that endpoint’s reference page for the fields it actually accepts or returns.

​
Attributes

FieldTypeRequiredDescription
AttributeCodeString—Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)
AttributeTypeCodeString—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)
NameString—Attribute name

​
BillingDetails

FieldTypeRequiredDescription
Address1StringNoAddress line 1. Length: Unlimited.
Address2StringNoAddress line 2. Length: Unlimited.
CityStringNoCity name. Max length: 500 chars.
CountryCodeStringNo2-char ISO country code
CountryNameStringNoCountry name. Max length: 255 chars.
EmailStringNoE-mail address. Max length: 500 chars.
FaxStringNoFax number. Max length: 250 chars.
FirstNameStringNoCustomer’s first name. Max length: 40 chars. No length validation. The rest will be truncated.
LastNameStringNoCustomer’s last name. Max length: 40 chars. No length validation. The rest will be truncated.
MiddleNameStringNoMiddle name. Max length:40 chars. No length validation. The rest will be truncated.
Phone1StringNoPhone #1. Max length: 250 chars.
Phone2StringNoPhone #2. Max length: 250 chars.
SalutationStringNoSalutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.
StateCodeStringNoState or province ISO code such as AZ for Arizona (if applicable)
StateOrProvinceStringNoState or province name. Max length: 500 chars.
UserIdNumberStringNoUser’s personal ID document number
UserIdNumberTypeobject (UserIdNumberType)NoUser’s personal ID document type. Includes the following fields: UserIdNumberTypeCode • Name
UserIdStringNoInternal User identifier on the Merchant site
ZipStringNoZip or postal code. Max length: 250 chars.

​
Brand

FieldTypeRequiredDescription
BrandCodeString—Brand code on the Merchant’s site (to be mapped on the Global‑e side)
NameString—Brand name

​
Category

FieldTypeRequiredDescription
CategoryCodeString—Category code on the Merchant site (to be mapped on the Global‑e side)
NameString—Category name

​
DiscountsList

FieldTypeRequiredDescription
CouponCodeStringNoMerchant CouponCode used for this discount (applicable to coupon-based discounts only)
DescriptionStringNoDiscount textual description. Length: unlimited.
DiscountCodeStringNoDiscount code used to identify the discount on the Merchant’s site. This property may be optionally specified in the SendCart API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API.
DiscountTypeDecimal—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
NameStringYesDiscount name. Length: unlimited.
OriginalDiscountValueCurrencyYesDiscount value in original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country. Max length: 18,4.
ProductCartItemIdStringNoIdentifier of the product cart item related to this discount on the Merchant’s site. This property may be optionally specified in the SendCart API only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant API. Max length: 50 chars.

​
ShippingDetails

FieldTypeRequiredDescription
Address1StringNoAddress line 1. Unlimited length.
Address2StringNoAddress line 2. Unlimited length.
CityStringNoCity name. Max length: 500 chars.
CountryCodeStringNo2-char ISO country code
CountryNameStringNoCountry name. Max length: 255 chars.
EmailStringNoE-mail address. Max length: 500 chars.
FaxStringNoFax number. Max length: 250 chars.
FirstNameStringNoFirst name. Max length: 40 chars. No length validation. The rest will be truncated.
LastNameStringNoLast name. Max length:40 chars. No length validation. The rest will be truncated.
MiddleNameStringNoMiddle name. Max length:40 chars. No length validation. The rest will be truncated.
Phone1StringNoPhone #1. Max length: 250 chars.
Phone2StringNoPhone #2. Max length: 250 chars.
SalutationStringNoSalutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.
StateCodeStringNoState or province ISO code such as AZ for Arizona (if applicable). 2 chars.
StateOrProvinceStringNoState or province name. Max length: 500 chars.
UserIdDecimalNoInternal User identifier on the Merchant site
UserIdNumberStringNoUser’s personal ID document number
UserIdNumberTypeStringNoUser’s personal ID document type (e.g. Passport, ID card, etc.)
ZipStringNoZip or postal code. Max length: 250 chars.

​
UserIdNumberType

FieldTypeRequiredDescription
NameString—Identification document type name
UserIdNumberTypeCodeString—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)

​
VATRateType

FieldTypeRequiredDescription
NameStringNoVAT rate type name
RateDecimal—VAT rate decimal value
VATRateTypeCodeString—VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)