Documentation Portal

Attributes

List of Merchant.CartProductAttribute

Custom attributes describe products that customers can personalize according to what the site offers. Each Attribute holds a key to specify attribute name and Value properties.

No

BackOrderDate

String

Estimated date for the backordered item to be in stock

No

Brand

Object Merchant.Brand

Product’s brand

No

CartItemId

String

Identifier of the cart item on the Merchant’s site originally specified in the Product.CartItemId property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

No

CartItemOptionId

String

Identifier of the child cart item “option” on the Merchant’s site originally specified in the Product.CartItemOptionId property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

No

Categories

List of Merchant.Category

List of product categories

No

CustomerVATRate

Decimal

The customer VAT rate applied to this product

DiscountedPrice

Decimal

The product value is in Merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product’s refund.

DiscountedPriceForCustoms

Decimal

Product price in Merchant currency reflects the price after Reverse D&T calculation.

DTBreakdown

Object DTBreakdown

Contains the duties and taxes per item in Merchant currency.

No

GenericHSCode

String

Product’s HS code

No

GiftMessage

String

Text originally specified in the Product.GiftMessage property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

No

HandlingCode

String

Code originally specified in Product.HandlingCode property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

No

InternationalDiscountedPrice

Decimal

The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product’s refund.

InternationalDiscountedPriceForCustoms

Decimal

Product price in customer currency reflects the price after Reverse D&T calculation

InternationalDiscountedPriceInMerchantCurrency

Decimal

Product Price in Merchant currency

InternationalDTBreakdown

Object DTBreakdown

Contains the duties and taxes per item in customer currency.

No

InternationalListPrice

Decimal

Single product list price in end customer’s currency (specified in the InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling.

No

InternationalPrice

Decimal

Single product final sale price in end customer currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling.

No

IsBackOrdered

Bool

Identifies if the product was ordered as a backed ordered item

TRUE - Product is back-ordered.

FALSE - Product is not back-ordered.

No

LineItemInternationalPrice

Decimal

Line item (product in ordered quantity) price in end customer’s currency (specified in the InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling. If not specified, should be deemed equal to “InternationalPrice * Quantity”. If specified, should take preference over InternationalPrice.

No

LineItemPriceBeforeGlobalEDiscount - DEPRECATED

Decimal

Line item (product in ordered quantity) price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If not specified, should be deemed equal to “PriceBeforeGlobalEDiscount * Quantity”. If specified, should take preference over PriceBeforeGlobalEDiscount.

No

ListPrice

Decimal

Single product List price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.

Name

String

Name of the product. Returned by GetOrdersDetails API only

No

ParentCartItemId

String

Identifier of the current item’s parent cart item on the Merchant’s site originally specified in the Product.ParentCartItemId property of the respective product in the SendCart method for the cart converted to this order on Global‑e.

No

Price

Decimal

Single product final sale price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.

PriceBeforeGlobalEDiscount - DEPRECATED

Decimal

Single product price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global‑e discounts (such as per-product Shipping discounts). If no Global‑e discount was applied, PriceBeforeGlobalEDiscount is equal to Price.

No

ProductAttributes

List of Merchant.ProductAttribute

Product attributes. Returned by GetOrdersDetails API only

No

Quantity

Decimal

Product quantity in the order that is currently being submitted to the Merchant.

RoundingRate

Decimal

The conversion rate applied to this product price paid by the end customer when calculating the prices paid by Global‑e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.

Sku

String

SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).

VATRate

Decimal

The VAT rate applied to this product