Skip to main content

Documentation Portal

ReturnedProducts

Parameter Name	Type	Description	Mandatory
`CartItemId`	String	Identifier of the cart item. Maximum 50 characters.	No
`MerchantReturnReasonCode`	String	The code of the reason for the product return on the merchant. Maximum 100 characters.	No
`MerchantReturnReasonDescription`	String	The description of the reason for the return on the merchant site. Maximum 100 characters.	Mandatory if no reason code provided
`ProductCode`	String	The ProductCode identifying the product. Maximum 600 characters.	Yes
`ReturnQuantity`	Integer	Quantity of the returned product. Maximum 100 characters.	Yes

Attributes

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

BillingDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1. Length: Unlimited.	No
`Address2`	String	Address line 2. Length: Unlimited.	No
`City`	String	City name. Max length: 500 chars.	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name. Max length: 255 chars.	No
`Email`	String	E-mail address. Max length: 500 chars.	No
`Fax`	String	Fax number. Max length: 250 chars.	No
`FirstName`	String	Customer’s first name. Max length: 40 chars. No length validation. The rest will be truncated.	No
`LastName`	String	Customer’s last name. Max length: 40 chars. No length validation. The rest will be truncated.	No
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	No
`Phone1`	String	Phone #1. Max length: 250 chars.	No
`Phone2`	String	Phone #2. Max length: 250 chars.	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvince`	String	State or province name. Max length: 500 chars.	No
`UserIdNumber`	String	User’s personal ID document number	No
`UserIdNumberType`	Object `UserIdNumberType`	User’s personal ID document type. Includes the following fields: `UserIdNumberTypeCode` `Name`	No
`UserId`	String	Internal User identifier on the Merchant site	No
`Zip`	String	Zip or postal code. Max length: 250 chars.	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)

DiscountsList

Parameter Name	Type	Description	Mandatory
`CouponCode`	String	Merchant `CouponCode` used for this discount (applicable to coupon-based discounts only)	No
`Description`	String	Discount textual description. Length: unlimited.	No
`DiscountCode`	String	Discount 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.	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
`Name`	String	Discount name. Length: unlimited.	Yes
`OriginalDiscountValue`	Currency	Discount 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.	Yes
`ProductCartItemId`	String	Identifier 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.	No

ShippingDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1. Unlimited length.	No
`Address2`	String	Address line 2. Unlimited length.	No
`City`	String	City name. Max length: 500 chars.	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name. Max length: 255 chars.	No
`Email`	String	E-mail address. Max length: 500 chars.	No
`Fax`	String	Fax number. Max length: 250 chars.	No
`FirstName`	String	First name. Max length: 40 chars. No length validation. The rest will be truncated.	No
`LastName`	String	Last name. Max length:40 chars. No length validation. The rest will be truncated.	No
`MiddleName`	String	Middle name. Max length:40 chars. No length validation. The rest will be truncated.	No
`Phone1`	String	Phone #1. Max length: 250 chars.	No
`Phone2`	String	Phone #2. Max length: 250 chars.	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.). Max length: 500 chars.	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable). 2 chars.	No
`StateOrProvince`	String	State or province name. Max length: 500 chars.	No
`UserId`	Decimal	Internal User identifier on the Merchant site	No
`UserIdNumber`	String	User’s personal ID document number	No
`UserIdNumberType`	String	User’s personal ID document type (e.g. Passport, ID card, etc.)	No
`Zip`	String	Zip or postal code. Max length: 250 chars.	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)

Would you like to provide feedback? Just click here to suggest edits.