Validate Stock (from Global-e)

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

POST /checkout-validate-cart-stock-url

ValidateStock (Global-e to Merchant)

cURL

curl --request POST \
  --url https://{merchant_site_domain}/checkout-validate-cart-stock-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "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.7,
      "PriceBeforeRoundingRate": null,
      "PriceBeforeGlobalEDiscount": null,
      "Quantity": 1,
      "VATRate": null,
      "CustomerVATRate": null,
      "InternationalPrice": 649,
      "InternationalDiscountedPriceInMerchantCurrency": null,
      "CartItemId": "ci21000088",
      "ParentCartItemId": null,
      "CartItemOptionId": null,
      "HandlingCode": null,
      "GiftMessage": null,
      "RoundingRate": 0,
      "IsBackOrdered": false,
      "BackOrderDate": null,
      "DiscountedPrice": null,
      "InternationalDiscountedPrice": null,
      "ProductCodeSecondary": "MKC1120A~N~040~~NS",
      "Brand": null,
      "Categories": null,
      "ListPrice": 0,
      "InternationalListPrice": 0,
      "GenericHSCode": null,
      "DiscountedPriceForCustoms": 0,
      "InternationalDiscountedPriceForCustoms": 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": "[e-mail]",
    "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,
  "DoNotChargeVAT": false,
  "CustomerComments": null,
  "IsFreeShipping": false,
  "FreeShippingCouponCode": null,
  "ShipToStoreCode": null,
  "RoundingRate": 0,
  "UrlParameters": "[{\"Key\":\"ClientCookie\",\"Value\":\"JSESSIONID=null\"},{\"Key\":\"userId\",\"Value\":\"1148993\"},{\"Key\":\"orderId\",\"Value\":\"w748807\"},{\"Key\":\"locale\",\"Value\":\"en_IL\"}]",
  "OriginalMerchantTotalProductsDiscountedPrice": 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,
  "USSalesTax": 0,
  "CCFPrice": 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,
  "CartHash": "94210A58BAC3B3AB292DE94382910C87",
  "WebStoreCode": "en_IL",
  "WebStoreInstanceCode": "GlobalEDefaultStoreInstance",
  "DiscountedShippingPrice": 0,
  "InternationalDetails": null,
  "GiftCards": null
}
'

200

allInStock

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

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.

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

Body

application/json

Provides information related to the order.

AdditionalRequiredDocuments · OrderDocument · object[]

The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.

Show child attributes

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.

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.

CashOnDeliveryFee · number

Cash On Delivery fee amount in Merchant’s currency.

CCFPrice · number

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

Customer · Merchant.Customer · object

The paying customer’s preferences (Global-e acts as a paying customer).

Show child attributes

CustomerComments · string

Comments text entered by the end customer in Global‑e checkout.

CustomerDTBreakdown · DTBreakdown · object

Contains the duties and tax parts the customer paid for the order.

Show child attributes

DateCreated · string

Order creation date and time. Returned by GetOrdersDetails API only.

DiscountedShippingPrice · number

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 · Merchant.Discount · object[]

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.

Show child attributes

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

ExporterDetails.DestinationRegistrationNumber · number

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.

InternationalDetails · Merchant.InternationalDetails · object

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.

Show child attributes

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.

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

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.

LoyaltyPointsEarned · number

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.

LoyaltyPointsSpent · number

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).

Markups · Merchant.Discount · object[]

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.

Show child attributes

MerchantDTBreakdown · DTBreakdown · object

Contains the duties and tax parts that the Merchant subsidized for the order.

Show child attributes

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.

ModifiedProduct · string

Holds the product’s SKU

OrderCreationSource · number

One of the values of OrderCreationSource enumeration denoting a type of discount shown in the OrderCreationSource Table.

OrderDocuments · OrderDocument · object[]

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.

Show child attributes

OrderId · string

Global‑e order unique identifier.

OrderPaymentMethods · OrderPaymentMethod · object[]

List of payment methods the customer use (Credit card, Gift Cards)

Show child attributes

OrderStatusReason · OrderStatusReason · object

Reason for the order status, why it was cancelled.

Show child attributes

OriginalOrder · Merchant.OriginalOrder · object

Details that refer to the original order if the current order is a replacement.

Show child attributes

OTCurrencyCode · string

Currency of the one-time voucher code used to place the order.

OTVoucherAmount · number

The amount taken off the voucher when applicable.

OTVoucherCode · string

One-time voucher code used to place the order

Parcels · Merchant.Parcel · object[]

The list of parcels created for the order. Returned by GetOrdersDetails API only.

Show child attributes

PaymentDetails · Merchant.PaymentDetails · object

The paying customer’s payment details.

Show child attributes

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 · number

CountryCoefficient rate applied to the prices in this order.

PrimaryBilling · Merchant.CustomerDetails · object

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.

Show child attributes

PrimaryShipping · Merchant.CustomerDetails · object

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.

Show child attributes

Products · Merchant.Product · object[]

The list of products being purchased.

Show child attributes

RoundingRate · number

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"

SameDayDispatchCost · number

Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.

SecondaryBilling · Merchant.CustomerDetails · object

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.

Show child attributes

SecondaryShipping · Merchant.CustomerDetails · object

Secondary customer’s shipping details. If Customer.IsEndCustomerPrimary is FALSE, this field contains the end customers' shipping details.

Show child attributes

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.

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).

StatusCode · string

Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).

Subs · array

Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.

TotalDutiesAndTaxesPrice · number

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 · number

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.

USSalesTax · number

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.

Response

200 - application/json

Provides information related to validating that stock exists.

Provides information related to validating that stock exists.

AmendedProducts · Merchant.StockValidationRowResponse · object[]

The list of products that don’t have full stock availability for the Product.Quantity specified in the respective ValidateStock API request.

Show child attributes

CustomResources · object

Dictionary with custom resources for error and oos popup. Keys for the dictionary: TitleTextResourceId , BodyTextResourceId , ButtonTextResourceId , RedirectUrl.

Show child attributes

Error · string

The error message returned from the Merchant

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.

TextResourcesPlaceholders · object

Dictionary with placeholders which need to be replaced in text resources for error and oos popup which was passed in CustomResources (except RedirectUrl key).

Show child attributes