ValidateStock (Global-e to Merchant)

Note

This API is part of Global-e's extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required.

The Merchant Cart Validation checks basic cart validity and validates the product’s stock availability.

If a product line cart item listed in order.Products does not have full stock availability for the specified quantity, this cart item is included in the AmendedProducts array with an indication of the quantity actually available. If all items are in stock, the AmendedProducts array is empty.

If required, the ValidateStock API is called when the shopper is in the Global‑e checkout. If the AmendedProducts array is not empty, the list of out-of-stock products is displayed to the shopper.

Note

In the GEM integration method, the GetCheckoutCartInfo API may be reused for stock validation purposes.

Method/URL

https://www.merchant-site-domain.com/checkout-validate-cart-stock-url

Parameters

Request

Name	Type	Description	Mandatory
order	Object Merchant.Order	Provides information related to the order.

Request

Name	Type	Description	Mandatory
Merchant.StockValidationResponse	Object Merchant.StockValidationResponse	Provides information related to validating that stock exists.

Objects for ValidateStock API

Merchant.Order

Parameter Name	Type	Description	Mandatory
`AdditionalRequiredDocuments`	List of `OrderDocument`	The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.
`AllowMailsFromMerchant`	Boolean	Indicates if the end customer has opted on the Global‑e checkout page to receive emails from the Merchant. TRUE - Customer opted to receive emails FALSE - Customer did not opt to receive emails
`CartHash`	String	Cart hash originally specified in the `merchantCartHash` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`CartId`	String	Identifier of the cart on the Merchant’s site originally specified in `merchantCartToken` argument for `SendCart` method for the cart converted to this order on Global‑e.	No
`CashOnDeliveryFee`	Decimal	Cash On Delivery fee amount in Merchant’s currency.
`CCFPrice`	Decimal	Customs Clearance Fees (CCF), in the Merchant currency.
`ClearCart`	Boolean	Indicates if the end customer’s cart must be cleared before this method finishes execution on the Merchant’s site. TRUE - The end customer’s cart must be cleared FALSE - The end customer's cart does not have to be cleare
`CurrencyCode`	String	3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.
`CurrencyName`	String	Customer currency name. Returned by `GetOrdersDetails` API only	No
`Customer`	Object `Merchant.Customer`	The paying customer’s preferences (Global-e acts as a paying customer).
`CustomerComments`	String	Holds the gift message. In the offline order flow, holds the product comment.
`CustomerComments`	String	Comments text entered by the end customer in Global‑e checkout.	No
`CustomerDTBreakdown`	Object `DTBreakdown`	Contains the duties and tax parts the customer paid for the order.	No
`DateCreated`	String	Order creation date and time. Returned by `GetOrdersDetails` API only.	No
`DiscountedShippingPrice`	Decimal	The shipping price paid by the customer converted to the Merchant’s currency. Total Shipping price reducing Order Discounts (`InternationalDetails.DiscountedShippingPrice` price converted to the Merchant currency).
`Discounts`	List of `Merchant.Discount`	The list of discounts being applied to the order, according to the original list of discounts received in `SendCart` for this order, and to the Merchant shipping configuration on Global‑e.	No
`DoNotChargeVAT`	Boolean	Indicates if the end customer hasn’t been charged VAT in Global‑e checkout, as specified in the `doNotChargeVAT` argument for the `SendCart` method for the cart converted to this order on Global‑e. TRUE - VAT is not charged TRUE - VAT is charged	No
`ExporterDetails.DestinationRegistrationNumber`	Decimal	The Tax reference number of the GE Entity at the destination country. Should only be provided when the order is tax-collected. Otherwise, the field should be Null. The value should be Null if the order destination is for an EU country.
`ExporterDetails.LocalRegistrationClearance`	Boolean	Indicates whether the Merchant can use the destination Registration number. TRUE - Merchant can use destination Registration number (`ExporterDetails.DestinationRegistrationNumber`) FALSE - Merchant cannot use destination Registration number .
`FreeShippingCouponCode`	String	Merchant’s free shipping `CouponCode` applied by the end customer, as specified in the `FreeShippingCouponCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`InternationalDetails`	Object `Merchant.InternationalDetails`	Details referring to the end customer’s order placed on the Global‑e side. These details apply only to the Merchants dealing with international customers’ support themselves.	No
`IsB2B`	Boolean	Indicates if the order has a Company name and VAT registration number. TRUE - Order contains a company name and VAT registration number FALSE - Order does not contain a company name and VAT registration number
`IsFreeShipping`	Boolean	Indicates if the Merchant offers free international shipping to the end customer, as specified in the `IsFreeShipping` argument for the `SendCart` method for the cart converted to this order on Global‑e. TRUE - Shipping is free. FALSE - Shipping is not free.	No
`IsMoto`	Boolean	Indicates if the the customer is a customer support agent and an “Offline order” took place TRUE - The customer is a customer support agent and an “Offline order” took place FALSE - The customer is a regular customer
`IsReplacementOrder`	Boolean	Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - The order is not a replacement
`IsSplitOrder`	Boolean	Indicates if the order should be handled as a split order (i.e. without consolidation). TRUE - Order will be split FALSE - Order is not to be split	No
`IsTaxExemption`	Boolean	Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - Order does not have a tax exemption
`LoyaltyCode`	String	Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout.	No
`LoyaltyPointsEarned`	Decimal	The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in the `loyaltyPointsEarned` argument for the `SendCart` method for the cart converted to this order on Global-e.	No
`LoyaltyPointsSpent`	Decimal	The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, the “Loyalty points” type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (i.e. on the end user’s My Account page).	No
`Markups`	List of `Merchant.Discount`	The list of markups being applied to the order, according to the Merchant shipping configuration on Global‑e. Effectively Markup is a “negative Discount”. The main use case for markups is when the end customer is charged in Global‑e checkout, a flat shipping rate, which is higher than the shipping rate, calculated for the respective order. In this case, Global‑e pays the difference to the Merchant in the form of Markups applied to the order. Unlike Discounts, Markups may be only passed to the Merchant’s back-end ERP system for reconciliation purposes, and may not be displayed to the end customer.	No
`MerchantDTBreakdown`	Object `DTBreakdown`	Contains the duties and tax parts that the Merchant subsidized for the order.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	No
`ModifiedProduct`	String	Holds the product’s SKU
`OrderCreationSource`	Decimal	One of the values of `OrderCreationSource` enumeration denoting a type of discount shown in the OrderCreationSource Table.
`OrderDocuments`	List of `OrderDocument`	Always contains a single document - it can be either a VAT Invoice or a Customer Receipt, depends if it is within the EU or not.
`OrderId`	String	Global‑e order unique identifier.
`OrderPaymentMethods`	List of `OrderPaymentMethod`	List of payment methods the customer use (Credit card, Gift Cards)
`OrderStatusReason`	Object `OrderStatusReason`	Reason for the order status, why it was cancelled.
`OriginalOrder`	Object `Merchant.OriginalOrder`	Details that refer to the original order if the current order is a replacement.	No
`OTCurrencyCode`	String	Currency of the one-time voucher code used to place the order.	No
`OTVoucherAmount`	Decimal	The amount taken off the voucher when applicable.	No
`OTVoucherCode`	String	One-time voucher code used to place the order	No
`Parcels`	List of `Merchant.Parcel`	The list of parcels created for the order. Returned by `GetOrdersDetails` API only.	No
`PaymentDetails`	Object `Merchant.PaymentDetails`	The paying customer’s payment details.
`PrePayOffered`	Boolean	Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.
`PriceCoefficientRate`	Decimal	`CountryCoefficient` rate applied to the prices in this order.
`PrimaryBilling`	Object `Merchant.CustomerDetails`	The primary customer’s billing details. If `IsEndCustomerPrimary` is set to TRUE, then the primary customer is the payer and his details are indicated in the URL-encoded form.
`PrimaryShipping`	Object `Merchant.CustomerDetails`	Primary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is TRUE, this field contains the end customers' shipping details. this field contains the Global-e hub's shipping address in the URL-encoded form.
`Products`	List of `Merchant.Product`	The list of products being purchased.
`RoundingRate`	Decimal	The average conversion rate applied to the prices 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.
`SameDayDispatch`	Boolean	Indicates if the end customer has requested “Same Day Dispatch” on Global‑e checkout. TRUE - Customer requested "Same Day Dispatch" FALSE - Customer did not request "Same Day Dispatch"	No
`SameDayDispatchCost`	Decimal	Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.	No
`SecondaryBilling`	Object `Merchant.CustomerDetails`	Secondary customer’s billing details. If `Customer.IsEndCustomerPrimary` is FALSE, this contains attributes of the end customer’s details indicated in the URL-encoded form.
`SecondaryShipping`	Object `Merchant.CustomerDetails`	Secondary customer’s shipping details. If `Customer.IsEndCustomerPrimary` is FALSE, this field contains the end customers' shipping details.
`ShippingMethodCode`	String	Code denoting the local shipping method selected from the list of available shipping options provided in the `shippingOptionsList` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No
`ShipToStoreCode`	String	Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).
`Subs`	List of `Merchant.Order`	Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.
`TotalDutiesAndTaxesPrice`	Decimal	Total Duties & Taxes value including Customs Clearance Fees, in the Merchant currency. This amount is the total amount, regardless of whether the customer or the Merchant paid it.
`TotalDutiesPaidByCustomerPrice`	Decimal	The total amount of duties paid by the customer in the Merchant’s currency.
`UserId`	String	Internal User identifier on the Merchant’s site originally specified in the `shippingDetails`.`UserId`argument for `SendCart` method for the cart converted to this order on Global‑e.	No
`USSalesTax`	Decimal	Sales tax value for USA in the Merchant currency. This value is included in `TotalDutiesAndTaxesPrice`.
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store, as specified in the `WebStoreCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No

OrderCreationSource

One of the following possible values of OrderCreationSource enumeration denoting a type of discount:

OrderCreationSource Value	Name	Description
0	GECheckout	The default value for orders created in a normal flow via Global‑e Checkout
1	Marketplace	The value for orders that are created at a marketplace and sent to Global-e via your brand

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Merchant.Customer

Parameter Name	Type	Description	Mandatory
`IsEndCustomerPrimary`	Boolean	Indicates if end customer details are “swapped” with a paying (Global‑e) customer’s details when submitting the order to the Merchant. By default, `IsEndCustomerPrimary` is FALSE. TRUE - The primary customer is the same as the end customer who has placed the order FALSE - The primary customer denotes the paying (Global‑e) customer and the secondary customer denotes the end customer who has placed the order with Global‑e checkout
`SendConfirmation`	Boolean	Indicates if e-mail confirmation of the respective order’s status change needs to be sent to the paying customer (Global‑e acts as a paying customer).

Parameter Name

Type

Description

Mandatory

IsEndCustomerPrimary

Boolean

Indicates if end customer details are “swapped” with a paying (Global‑e) customer’s details when submitting the order to the Merchant. By default, IsEndCustomerPrimary is FALSE.

TRUE - The primary customer is the same as the end customer who has placed the order

FALSE - The primary customer denotes the paying (Global‑e) customer and the secondary customer denotes the end customer who has placed the order with Global‑e checkout

SendConfirmation

Boolean

Indicates if e-mail confirmation of the respective order’s status change needs to be sent to the paying customer (Global‑e acts as a paying customer).

Merchant.CustomerDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`AddressBookId`	String	Id of the current address from within the address book	No
`AddressBookName`	String	Name of the current address from within the address book	No
`City`	String	City name	No
`Company`	String	Company name	No
`CountryCode`	String	2-char ISO country code	No
`CountryName`	String	Country name	No
`Email`	String	Email address	No
`Fax`	String	Fax	No
`FirstName`	String	First name	No
`FirstNameInLocalCulture`	String	First name in local culture	No
`LastName`	String	Last name	No
`LastNameInLocalCulture`	String	Last name in local culture	No
`MiddleName`	String	Middle name	No
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`Salutation`	String	Salutation or title (e.g. Dr., Mr., etc.)	No
`SaveAddress`	Boolean	Indicates that the current address should be saved in the Merchant platform	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvice`	String	State or province name	No
`Zip`	String	Zip or postal code	No

Merchant.Discount

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	No
`DiscountCode`	String	Discount code originally specified in the `Discount.DiscountCode` property of the respective discount in `SendCart` method for the cart converted to this order on Global‑e.	No
`DiscountSource`	Enum	The enum DiscountSource has the following possible values: 1 = Merchant 2 = FixedShippingPrice 3 = PercentageCartPrice 4 = HiddenForceDDP 5 = Amend 6 = RemoteAreaSurchargeSubsidy 7 = LoyaltyPoints 8 = PaymentCharge 9 = ReplacementOrder	Yes
`DiscountType`	Decimal	Discount type (“Cart”, “Shipping”, etc.), as defined in the `DiscountTypeOptions` enumeration described in the Discount class in this document.
`InternationalPrice`	Decimal	Discount value in end customer’s currency (specified in `InternationalDetails.CurrencyCode` property for the respective `Merchant.Order`), after applying country coefficient, FX conversion, and `IncludeVAT` handling.	No
`LocalVATRate`	Decimal	The VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if `UseCountryVAT` for the current Country is TRUE and therefore the `VATRate` property denotes the VAT for the target country.	No
`LoyaltyVoucherCode`	String	Loyalty Voucher code originally specified in `Discount.LoyaltyVoucherCode` property of the respective discount in `SendCart` method for the cart converted to this order on Global‑e.	No
`Name`	String	Discount name
`Price`	Decimal	Discount value in the currency defined in the `CurrencyCode` property of the respective `Merchant.Order` object for the order being submitted to the Merchant.
`ProductCartItemId`	String	Identifier of the product cart item related to this discount on the Merchant’s site originally specified in the `Discount.ProductCartItemId` property of the respective discount in the `SendCart` method for the cart converted to this order on Global‑e.	No
`VATRate`	Decimal	The VAT rate applied to this discount

Merchant.InternationalDetails

Parameter Name	Type	Description	Mandatory
`CardNumberLastFourDigits`	String	The last 4 digits of the Card number (if applicable).	No
`CashOnDeliveryFee`	Decimal	The additional charge is paid by the end customer when the “Cash on Delivery” payment method has been selected.	No
`ConsignmentFee`	Decimal	The consignment fee is paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`.	No
`CurrencyCode`	String	3-char ISO code for the currency selected by the end customer for the order payment.
`CustomerDTBreakdown`	Object `DTBreakdown`	Contains the duties and taxes parts the customer paid for the order in the currency denoted by `CurrencyCode`.	No
`DeliveryDaysFrom`	Decimal	The minimum number of days for delivery to the end customer for the selected shipping method.	No
`DeliveryDaysTo`	Decimal	The maximum number of days for delivery to the end customer for the selected shipping method.	No
`DiscountedShippingPrice`	Decimal	The price paid by the customer in local currency. Total Shipping price reducing Order Discounts International price.
`DutiesGuaranteed`	Bool	Indicates if the end customer has selected the “guaranteed duties and taxes” option.
`ExpirationDate`	string	Card expiration date in YYYY-MM-DD format (if applicable).	No
`MerchantDTBreakdown`	Object `DTBreakdown`	Contains the duties and taxes parts the Merchant subsidized for the order in the currency denoted by `CurrencyCode`.	No
`OrderTrackingNumber`	String	Tracking number used by the selected international shipping method for this order.	No
`OrderTrackingUrl`	String	Full tracking URL including `OrderTrackingNumber` used by the selected international shipping method for this order.	No
`OrderWaybillNumber`	String	Waybill number used by the selected international shipping method for this order.	No
`ParcelsTracking`	List of `Merchant.ParcelTracking`	List of `Merchant.ParcelTracking` objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number).
`PaymentMethodCode`	String	Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global‑e payment method code will be specified instead.
`PaymentMethodName`	String	Name of the selected payment method.
`RemoteAreaSurcharge`	Decimal	Remote area surcharge paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`.	No
`SameDayDispatchCost`	Decimal	Cost of the “Same Day Dispatch” option (if selected by the end customer on Global‑e checkout), in the currency denoted by `CurrencyCode`. This value is NOT included in `TotalShippingPrice`.	No
`ShippingMethodCode`	String	Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global‑e shipping method code will be specified instead.
`ShippingMethodName`	String	Name of the selected international shipping method.
`ShippingMethodStatusCode`	String	Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on the Global‑e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global‑e shipping status code will be specified instead.	No
`ShippingMethodStatusName`	String	Name of the shipping status.	No
`ShippingMethodTypeCode`	String	Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on the Global‑e side). If this international shipping method type does not exist on the Merchant’s site, the internal Global‑e shipping method type code will be specified instead.
`ShippingMethodTypeName`	String	Name of the selected international shipping method type.
`ShippingVATRate`	Decimal	The shipping VAT rate for the customer. This rate is applied to the shipping cost.
`SizeOverchargeValue`	Decimal	Oversized items charge paid by the end customer in the currency denoted by `CurrencyCode`. This value is included in `TotalShippingPrice`.	No
`TotalCCFPrice`	Decimal	Total Customs Clearance Fees value in the currency denoted by `CurrencyCode`. This value is included in `TotalDutiesPrice`.	No
`TotalDutiesPrice`	Decimal	Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by `CurrencyCode`.
`TotalPrice`	Decimal	Total order price in the currency denoted by `CurrencyCode`.
`TotalShippingPrice`	Decimal	Total shipping price in the currency denoted by `CurrencyCode`.
`TotalVATAmount`	Decimal	Amount of VAT paid by the customer to Global‑e
`TransactionCurrencyCode`	String	3-char ISO code for the currency actually used for the current order payment. `TransactionCurrencyCode` may differ from `CurrencyCode` if the currency selected by the end customer could not be used with the selected payment method.
`TransactionTotalPrice`	Decimal	Total order price actually paid by the end customer in the currency denoted by `TransactionCurrencyCode`.
`USSalesTax`	Decimal	Sales tax value for the USA in the currency denoted by `CurrencyCode`. This value is included in TotalDutiesPrice.

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Merchant.Parcel

Parameter Name	Type	Description
`Code`	String	Parcel code.
`ParcelStatusId`	Decimal	Parcel status id.
`StatusName`	String	Parcel status name.
`TrackingUrl`	String	Direct tracking URL.
`Products`	List of `Merchant.ParcelProduct`	List of products included in the parcel.

Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Merchant.OriginalOrder

Parameter Name	Type	Description	Mandatory
`MerchantInternalOrderId`	String	`InternalOrderId` returned from `SendOrderToMerchant` call for the original order.	No
`MerchantOrderId`	String	`OrderId` returned from `SendOrderToMerchant` call for the original order.	No
`OrderId`	String	Global‑e order unique identifier for the original order.

Merchant.Parcel

Parameter Name	Type	Description
`Code`	String	Parcel code.
`ParcelStatusId`	Decimal	Parcel status id.
`StatusName`	String	Parcel status name.
`TrackingUrl`	String	Direct tracking URL.
`Products`	List of `Merchant.ParcelProduct`	List of products included in the parcel.

Merchant.ParcelProduct

Parameter Name	Type	Description
`CartItemId`	String	Cart item id of the product.
`Quantity`	Decimal	Product quantity included in the parcel.
`Sku`	String	Product SKU.

Merchant.PaymentDetails

Parameter Name	Type	Description	Mandatory
`Address1`	String	Address line 1	No
`Address2`	String	Address line 2	No
`CardNumber`	String	Card number
`City`	String	City name	No
`CountryCode`	String	2-char ISO country code
`CountryName`	String	Country name
`CVVNumber`	String	Card CVV number
`Email`	String	E-mail address	No
`ExpirationDate`	String	Card expiration date (in YYYY-MM-DD format)
`Fax`	String	Fax	No
`OwnerFirstName`	String	Card owner’s first name	Optional if `OwnerName` is specified
`OwnerLastName`	String	Card owner’s last name	Optional if `OwnerName` is specified
`OwnerName`	String	Card owner’s full name (the Merchant may choose to consider either full name or first name with the last name, according to the existing payment method input validation requirements).	No
`PaymentMethodCode`	String	Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side).
`PaymentMethodName`	String	Payment method name
`PaymentMethodTypeCode`	String	Payment method type’s code used to identify the payment method type (such as Credit Card or Check) on the Merchant’s site (to be mapped on the Global‑e side).
`Phone1`	String	Phone #1	No
`Phone2`	String	Phone #2	No
`StateCode`	String	State or province ISO code such as AZ for Arizona (if applicable)	No
`StateOrProvice`	String	State or province name	No
`Zip`	String	Zip or postal code	No

Merchant.Product

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

Parameter Name	Type	Description	Mandatory
`Duties`	Decimal	Duties that are applied.
`Other`	Decimal	Other DT fees that are applied.	No
`SalesTaxes`	Decimal	Sales taxes that are applied.

Parameter Name	Type	Description	Mandatory
`BrandCode`	String	Brand code
`Name`	String	Brand name

Parameter Name	Type	Description	Mandatory
`CategoryCode`	String	Merchant category code
`Name`	String	Merchant category name

Merchant.CartProductAttribute

Parameter Name	Type	Description	Mandatory
`AttributeKey`	String	Custom product attribute name that is used to describe the personalized product.
`AttributeValue`	String	Custom product attribute value that is used to describe the personalized product.

Merchant.ProductAttribute

Parameter Name	Type	Description	Mandatory
`AttributeKey`	String	Customized product attribute name, used to describe the personalized product.
`AttributeValue`	String	Customized product attribute, used to describe the personalized product.

OrderDocument

Parameter Name	Type	Description	Mandatory
`CreationDateTime`	DateTime	The date and time the document was created.	No
`DocumentData`	String	Base64 encoded byte array representing the document file content.
`DocumentExtension`	String	Document extension (PDF, ZPL, EPL).
`DocumentReference`	String	The reference provided by the government authorities to this document (such as MRN or ITN number).	No
`DocumentTypeCode`	String	Document type code, this value can be: CommercialInvoice = 1 PackingList = 2 ShipperManifest = 3 Label = 4 VATInvoice = 5 DangerousGoodDeclarationLink = 6 GELabel = 7 CustomerReceiptInvoice = 8 ArchibeLabel = 9 DeliveryAdvice = 10 EAD = 11
`DocumentTypeName`	String	Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`.
`ErrorMessage`	String	Description of the error for this entity (order/parcel) if it happened.	No
`ParcelCode`	String	The parcel code related to the document.	No
`ShippingServiceName`	String	The name of the shipping service for this document (relevant for `DispatchOrders` and `DispatchConsolidatedShipment`).	No
`TrackingNumber`	String	Shipping tracking number associated with the document.	No
`URL`	String	URL of the document.

OrderPaymentMethod

Parameter Name	Type	Description
`GiftCardFields`	String	Gift card fields
`IsGiftCard`	Boolean	Indicates if the order payment method is a gift card. TRUE if using a gift card for payment FALSE if not using a gift card
`PaidAmountInCustomerCurrency`	Decimal	Amount that paid in customer’s currency
`PaidAmountInMerchantCurrency`	Decimal	Amount paid in Merchant’s currency
`PaymentMethodId`	Decimal	The ID for the payment method
`PaymentMethodName`	String	Name of the payment method

OrderStatusReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order status reason name
`OrderStatusReasonCode`	String	Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side)

Merchant.StockValidationResponse

Parameter Name	Type	Description	Mandatory
`AmendedProducts`	List of `Merchant.StockValidationRowResponse`	The list of products that don’t have full stock availability for the `Product.Quantity` specified in the respective `ValidateStock` API request.	No
`CustomResources`	Dictionary<String, String>	Dictionary with custom resources for error and oos popup. Keys for the dictionary: `TitleTextResourceId`, `BodyTextResourceId`, `ButtonTextResourceId`, `RedirectUrl`.	No
`Error`	String	The error message returned from the Merchant	No
`ReservationRequestId`	String	The stock reservation code returned from the Merchant if the stock has been actually reserved as a result of the `ValidateStock` API call.	No
`TextResourcesPlaceholders`	Dictionary<String, String>	Dictionary with placeholders which need to be replaced in text resources for error and oos popup which was passed in `CustomResources` (except `RedirectUrl` key).	No

Merchant.StockValidationRowResponse

Parameter Name	Type	Description	Mandatory
`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 cart
`QuantityInStock`	String	Available product quantity

Examples

Request

{
    "GlobalECartToken": "1da35dc3-cbe6-4cd8-81d6-ce433466d715",
    "PreferredCultureCode": null,
    "AuthToken": "34sdfdg43erfg43234fwsedfsdf423",
    "SessionId": "12345",
    "DateCreated": "0001-01-01T00:00:00",
    "CurrencyName": null,
    "Parcels": null,
    "AllowMailsFromMerchant": false,
    "AllowDirectCommunicationFromMerchant": false,
    "ClearCart": false,
    "UserId": null,
    "CurrencyCode": "ILS",
    "Products": [{
            "Attributes": null,
            "Sku": "648340636",
            "Price": 157.7000,
            "PriceBeforeRoundingRate": null,
            "PriceBeforeGlobalEDiscount": null,
            "Quantity": 1,
            "VATRate": null,
            "CustomerVATRate": null,
            "InternationalPrice": 649.0000,
            "InternationalDiscountedPriceInMerchantCurrency": null,
            "CartItemId": "ci21000088",
            "ParentCartItemId": null,
            "CartItemOptionId": null,
            "HandlingCode": null,
            "GiftMessage": null,
            "RoundingRate": 0.0,
            "IsBackOrdered": false,
            "BackOrderDate": null,
            "DiscountedPrice": null,
            "InternationalDiscountedPrice": null,
            "ProductCodeSecondary": "MKC1120A~N~040~~NS",
            "Brand": null,
            "Categories": null,
            "ListPrice": 0.0,
            "InternationalListPrice": 0.0,
            "GenericHSCode": null,
            "DiscountedPriceForCustoms": 0.0,
            "InternationalDiscountedPriceForCustoms": 0.0,
            "IsGiftCard": false,
            "IsFixedPrice": true
        }
    ],
    "Customer": {
        "EmailAddress": null,
        "IsEndCustomerPrimary": false,
        "SendConfirmation": false
    },
    "PrimaryShipping": {
        "FirstName": "sdfsdf",
        "LastName": "sdfsdf",
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": "asdasd+234",
        "Address2": "",
        "City": "asdasd",
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": "1234567",
        "Email": "sdfsdf%40asdasd.com",
        "Phone1": "0000000000",
        "Phone2": null,
        "Fax": null,
        "CountryCode": "IL",
        "CountryCode3": null,
        "CountryName": null,
        "AddressBookId": null,
        "AddressBookName": null,
        "SaveAddress": false
    },
    "SecondaryShipping": {
        "FirstName": "GlobalE",
        "LastName": "GE-UK@EMA-Norsk",
        "MiddleName": null,
        "Salutation": null,
        "Company": "",
        "Address1": "Building 436, Argosy Road",
        "Address2": "East Midlands Airport",
        "City": "Derby",
        "StateCode": "NN",
        "StateOrProvince": null,
        "Zip": "DE74 2SA",
        "Email": "[email protected]",
        "Phone1": "01332 818723",
        "Phone2": null,
        "Fax": null,
        "CountryCode": "GB",
        "CountryCode3": "GBR",
        "CountryName": "United Kingdom",
        "AddressBookId": null,
        "AddressBookName": null,
        "SaveAddress": false
    },
    "ShippingMethodCode": "Express Courier (Air)",
    "Discounts": [],
    "Markups": [],
    "LoyaltyPointsSpent": null,
    "LoyaltyPointsEarned": null,
    "SameDayDispatch": false,
    "SameDayDispatchCost": 0.0,
    "DoNotChargeVAT": false,
    "CustomerComments": null,
    "IsFreeShipping": false,
    "FreeShippingCouponCode": null,
    "ShipToStoreCode": null,
    "RoundingRate": 0.0,
    "UrlParameters": "[{\"Key\":\"ClientCookie\",\"Value\":\"JSESSIONID=null\"},{\"Key\":\"userId\",\"Value\":\"1148993\"},{\"Key\":\"orderId\",\"Value\":\"w748807\"},{\"Key\":\"locale\",\"Value\":\"en_IL\"}]",
    "OriginalMerchantTotalProductsDiscountedPrice": 0.0,
    "LoyaltyCode": null,
    "OTVoucherCode": null,
    "OTVoucherAmount": null,
    "OTVoucherCurrencyCode": null,
    "IsSplitOrder": false,
    "PrePayOffered": false,
    "InitialCheckoutCultureCode": null,
    "CultureCode": null,
    "HubId": 0,
    "IsReplacementOrder": false,
    "OriginalOrder": null,
    "ReservationRequestId": null,
    "IsSuppressPersonalInformation": false,
    "TotalDutiesAndTaxesPrice": 0.0,
    "USSalesTax": 0.0,
    "CCFPrice": 0.0,
    "PaymentDetails": null,
    "PrimaryBilling": {
        "FirstName": null,
        "LastName": null,
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": null,
        "Address2": null,
        "City": null,
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": null,
        "Email": null,
        "Phone1": null,
        "Phone2": null,
        "Fax": null,
        "CountryCode": null,
        "CountryCode3": null,
        "CountryName": null,
        "AddressBookId": null,
        "AddressBookName": null,
        "SaveAddress": false
    },
    "SecondaryBilling": {
        "FirstName": null,
        "LastName": null,
        "MiddleName": null,
        "Salutation": null,
        "Company": null,
        "Address1": null,
        "Address2": null,
        "City": null,
        "StateCode": null,
        "StateOrProvince": null,
        "Zip": null,
        "Email": null,
        "Phone1": null,
        "Phone2": null,
        "Fax": null,
        "CountryCode": null,
        "CountryCode3": null,
        "CountryName": null,
        "AddressBookId": null,
        "AddressBookName": null,
        "SaveAddress": false
    },
    "OrderId": null,
    "StatusCode": null,
    "MerchantGUID": "7f132fc6-bdbc-420e-a2ce-fd35ab5c06d0",
    "CartId": "_2S0DVucAbjgfHAR-SUmRshWaS3pB5F9Bk7OfgWBR9ujllKrTw5H!17426857!1596453641116",
    "MerchantOrderId": null,
    "PriceCoefficientRate": 0.0,
    "CartHash": "94210A58BAC3B3AB292DE94382910C87",
    "WebStoreCode": "en_IL",
    "WebStoreInstanceCode": "GlobalEDefaultStoreInstance",
    "DiscountedShippingPrice": 0.0,
    "InternationalDetails": null,
    "GiftCards": null
}

Responses

Example of generic error:

Error code 3 is expected. An appropriate error message is shown to the customer and a new clean cart is generated.

{
    "AmendedProducts": [],
    "Error": "3",
    "StackTrace": " at CallSite.Target(Closure , CallSite , Object )\r\n at GlobalE.GEM.BL.GEMProviders.BaseProviders.BaseGEMProvider.ParseReservationInfo(Object reservationInfo) in C:\\jenkins\\workspace\\GEPI\\787e4b5b9a7709ca06b57fcfbeb2bdb2\\GlobalE.GEM.BL\\GEMProviders\\BaseProviders\\BaseGEMProvider.cs:line 844",
    "ReservationRequestId": null
}

Example of invalid email error:

Error code 2 is expected. An appropriate error message is shown to the customer and a new clean cart is generated.

{
    "AmendedProducts": [],
    "Error": "2",
    "StackTrace": null,
    "ReservationRequestId": null
}

Example of invalid cart content error:

Error code 1 is expected. One of the cart fields is invalid. An appropriate error message is shown to the customer and a new clean cart is generated.

{
    "AmendedProducts": [],
    "Error": "1",
    "StackTrace": null,
    "ReservationRequestId": null
}

If all products are in stock:

{
    "AmendedProducts": [],
    "ReservationRequestId": null,
    "Error": null
}

If some products are out of stock:

{
    "AmendedProducts": [{
            "CartItemID": "11007",
            "QuantityInStock": 1
        }
    ],
    "ReservationRequestId": null
}

Documentation Portal

ValidateStock (Global-e to Merchant)

Note

Note

Parameters

Objects for ValidateStock API

Merchant.Order

DTBreakdown

Merchant.Customer

Merchant.CustomerDetails

Merchant.Discount

Merchant.InternationalDetails

DTBreakdown

Merchant.Parcel

Merchant.ParcelProduct

Merchant.OriginalOrder

Merchant.Parcel

Merchant.ParcelProduct

Merchant.PaymentDetails

Merchant.Product

DTBreakdown

Merchant.Brand

Merchant.Category

Merchant.CartProductAttribute

Merchant.ProductAttribute

OrderDocument

OrderPaymentMethod

OrderStatusReason

Merchant.StockValidationResponse

Merchant.StockValidationRowResponse

Examples

Search results