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.
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 Global-e Module integration method, the GetCheckoutCartInfo API may be reused for stock validation purposes.
The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.
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
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.
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
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).
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.
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
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.
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.
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.
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.
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
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.
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
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.
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).
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.
Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.
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.
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.
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.
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"
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.
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.
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.
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.
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
Response Parameters
Provides information related to validating that stock exists.
Dictionary with custom resources for error and oos popup. Keys for the dictionary: TitleTextResourceId , BodyTextResourceId , ButtonTextResourceId , RedirectUrl.
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
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Global-e Docs","colors":{"primary":"#F15A2B","light":"#F57C00","dark":"#C2451F"},"logo":{"light":"https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/logo/light.png?fit=max\u0026auto=format\u0026n=xvASI8IP64Cj0kr_\u0026q=85\u0026s=3b5849fa849995b81b219c94b874d44f","dark":"https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/logo/dark.png?fit=max\u0026auto=format\u0026n=xvASI8IP64Cj0kr_\u0026q=85\u0026s=4b3c45ba5ba14d2aadb54b500e20183c","href":"/introduction"},"favicon":"https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/favicon.png?fit=max\u0026auto=format\u0026n=tw35F3WiyJ8sxtxX\u0026q=85\u0026s=261a34ff25dc6eee4c7acf742bba08b5","api":{"playground":{"display":"simple"}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://status.global-e.com/","label":"Status Page"},{"href":"https://trustcenter.global-e.com","label":"Trust Center"},{"href":"/contact-us","label":"Escalating a Ticket"}]},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":[],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"globale-enterprise","hasAudioNarration":false,"actualSubdomain":"globale-enterprise","customDomains":["docs.global-e.com"],"gitSource":{"type":"gitlab","owner":"global-e/product","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"enterprise","isPrivate":true,"projectId":84016925,"mountPath":"","label":""},"chroma":{"collectionId":"512fb028-3e65-4b3e-a3cf-b3550e4b3bb3","liveDeploymentHistoryId":"6ae36b0095eb8a3e5a09981b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae36b0095eb8a3e5a09981b"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae36b0095eb8a3e5a09981b","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Documentation","count":477},{"language":"default","tag":"Topics","count":477},{"language":"default","tag":"eCommerce Integration","count":182},{"language":"default","tag":"API Reference","count":80},{"language":"default","tag":"Global-e: The Basics","count":74},{"language":"default","tag":"SDK and API","count":53},{"language":"default","tag":"SFCC","count":48},{"language":"default","tag":"Merchant Portal","count":44},{"language":"default","tag":"New Returns Portal for All Platforms (Excluding Shopify)","count":44},{"language":"default","tag":"New Returns Portal for Shopify","count":38}],"searchSettings":{"maxResults":15}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/globale-enterprise/bdd88c3538cea5b1/style.css"}],"page":{"pagePath":"api-reference/validate-stock","slug":"/api-reference/validate-stock","pageMetadata":{"contextual":{"options":[{"title":"View YAML","description":"Open the OpenAPI spec for this endpoint","icon":"file-code","href":"/api-reference/specs/validatestock.yaml"},"download-spec","copy","view","chatgpt","claude"]},"title":"Validate Stock (Global-e to Merchant)","sidebarTitle":"Validate Stock","description":"The Merchant Cart Validation checks basic cart validity and validates the product's stock availability.","openapi":"api-reference/specs/validatestock.yaml POST /checkout-validate-cart-stock-url","href":"/api-reference/validate-stock"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The Merchant Cart Validation checks basic cart validity and validates the product’s stock availability.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Info,Note}=_components;if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsx(_components.p,{children:`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.`})}),`\n`,_jsxs(_components.p,{children:[`If a product line cart item listed in `,_jsx(_components.code,{children:`order.Products`}),` does not have full stock availability for the specified quantity, this cart item is included in the `,_jsx(_components.code,{children:`AmendedProducts`}),` array with an indication of the quantity actually available. If all items are in stock, the `,_jsx(_components.code,{children:`AmendedProducts`}),` array is empty.`]}),`\n`,_jsxs(_components.p,{children:[`If required, the `,_jsx(_components.code,{children:`ValidateStock`}),` API is called when the shopper is in the Global‑e checkout. If the `,_jsx(_components.code,{children:`AmendedProducts`}),` array is not empty, the list of out-of-stock products is displayed to the shopper.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`In the Global-e Module integration method, the `,_jsx(_components.code,{children:`GetCheckoutCartInfo`}),` API may be reused for stock validation purposes.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"contextual":{"options":[{"title":"View YAML","description":"Open the OpenAPI spec for this endpoint","icon":"file-code","href":"/api-reference/specs/validatestock.yaml"},"download-spec","copy","view","chatgpt","claude"]},"title":"Validate Stock (Global-e to Merchant)","sidebarTitle":"Validate Stock","description":"The Merchant Cart Validation checks basic cart validity and validates the product's stock availability.","openapi":"api-reference/specs/validatestock.yaml POST /checkout-validate-cart-stock-url","href":"/api-reference/validate-stock"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/globale-enterprise/3a1555eec05adf43/feedback-link.js","/_mintlify/custom/globale-enterprise/07a4be9d6ed97624/footer-legal.js","/_mintlify/custom/globale-enterprise/49711f0bc5d1b97e/country-table.js","/_mintlify/custom/globale-enterprise/d9fcdd3337ee5e98/assistant-open-full.js"],"openApiReferenceData":{"operation":{"summary":"ValidateStock (Global-e to Merchant)","operationId":"validateStock","tags":["ValidateStock (Global-e to Merchant)"],"requestBody":"7f9e2cf4-bacc-4f79-b642-8805f6c8c0c0","responses":{"200":"11ab0935-f7bd-407f-8392-5383ea490595"},"method":"post","type":"path","servers":["d666d6be-9833-4afa-b7a3-b2974057d945"],"security":[],"path":"/checkout-validate-cart-stock-url","baseUrlOptions":["https://{merchant_site_domain}"],"title":"ValidateStock (Global-e to Merchant)","description":"The Merchant Cart Validation checks basic cart validity and validates the product's stock availability.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Merchant.Order","description":"Provides information related to the order.","additionalProperties":true,"properties":{"AdditionalRequiredDocuments":{"type":"array","items":{"type":"object","title":"OrderDocument","properties":{"CreationDateTime":{"type":"string","format":"date-time","description":"The date and time the document was created.","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].CreationDateTime","typeLabel":"string\u003cdate-time>"},"DocumentData":{"type":"string","description":"Base64 encoded byte array representing the document file content.","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].DocumentData","typeLabel":"string"},"DocumentExtension":{"type":"string","description":"Document extension (PDF, ZPL, EPL).","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].DocumentExtension","typeLabel":"string"},"DocumentReference":{"type":"string","description":"The reference provided by the government authorities to this document (such as MRN or ITN number).","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].DocumentReference","typeLabel":"string"},"DocumentTypeCode":{"type":"string","description":"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","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].DocumentTypeCode","typeLabel":"string"},"DocumentTypeName":{"type":"string","description":"Document type name, e.g. AWB , CommercialInvoiceAndPackingList or Manifest.","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].DocumentTypeName","typeLabel":"string"},"ErrorMessage":{"type":"string","description":"Description of the error for this entity (order/parcel) if it happened.","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].ErrorMessage","typeLabel":"string"},"ParcelCode":{"type":"string","description":"The parcel code related to the document.","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].ParcelCode","typeLabel":"string"},"ShippingServiceName":{"type":"string","description":"The name of the shipping service for this document (relevant for DispatchOrders and DispatchConsolidatedShipment).","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].ShippingServiceName","typeLabel":"string"},"TrackingNumber":{"type":"string","description":"Shipping tracking number associated with the document.","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].TrackingNumber","typeLabel":"string"},"URL":{"type":"string","description":"URL of the document.","uniqueKey":"AdditionalRequiredDocuments.items.[INDEX].URL","typeLabel":"string"}},"uniqueKey":"AdditionalRequiredDocuments.items.[INDEX]","typeLabel":"OrderDocument · object"},"description":"The required additional documents for shipping. When the information is provided, the Merchant must wait for the documents to be provided before starting fulfilment.","uniqueKey":"AdditionalRequiredDocuments","typeLabel":"OrderDocument · object[]"},"AllowMailsFromMerchant":{"type":"boolean","description":"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","uniqueKey":"AllowMailsFromMerchant","typeLabel":"boolean"},"CartHash":{"type":"string","description":"Cart hash originally specified in the merchantCartHash argument for the SendCart method for the cart converted to this order on Global‑e.","uniqueKey":"CartHash","typeLabel":"string"},"CartId":{"type":"string","description":"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.","uniqueKey":"CartId","typeLabel":"string"},"CashOnDeliveryFee":{"type":"number","description":"Cash On Delivery fee amount in Merchant’s currency.","uniqueKey":"CashOnDeliveryFee","typeLabel":"number"},"CCFPrice":{"type":"number","description":"Customs Clearance Fees (CCF), in the Merchant currency.","uniqueKey":"CCFPrice","typeLabel":"number"},"ClearCart":{"type":"boolean","description":"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","uniqueKey":"ClearCart","typeLabel":"boolean"},"CurrencyCode":{"type":"string","description":"3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency.","uniqueKey":"CurrencyCode","typeLabel":"string"},"CurrencyName":{"type":"string","description":"Customer currency name.","uniqueKey":"CurrencyName","typeLabel":"string"},"Customer":{"type":"object","title":"Merchant.Customer","description":"The paying customer’s preferences (Global-e acts as a paying customer).","properties":{"IsEndCustomerPrimary":{"type":"boolean","description":"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","uniqueKey":"Customer.IsEndCustomerPrimary","typeLabel":"boolean"},"SendConfirmation":{"type":"boolean","description":"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).","uniqueKey":"Customer.SendConfirmation","typeLabel":"boolean"}},"uniqueKey":"Customer","typeLabel":"Merchant.Customer · object"},"CustomerComments":{"type":"string","description":"Comments text entered by the end customer in Global‑e checkout.","uniqueKey":"CustomerComments","typeLabel":"string"},"CustomerDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and tax parts the customer paid for the order.","properties":{"Duties":{"type":"number","description":"Duties that are applied.","uniqueKey":"CustomerDTBreakdown.Duties","typeLabel":"number"},"Other":{"type":"number","description":"Other DT fees that are applied.","uniqueKey":"CustomerDTBreakdown.Other","typeLabel":"number"},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied.","uniqueKey":"CustomerDTBreakdown.SalesTaxes","typeLabel":"number"}},"uniqueKey":"CustomerDTBreakdown","typeLabel":"DTBreakdown · object"},"DateCreated":{"type":"string","description":"Order creation date and time.","uniqueKey":"DateCreated","typeLabel":"string"},"DiscountedShippingPrice":{"type":"number","description":"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).","uniqueKey":"DiscountedShippingPrice","typeLabel":"number"},"Discounts":{"type":"array","items":{"type":"object","title":"Merchant.Discount","properties":{"CouponCode":{"type":"string","description":"Merchant CouponCode used for this discount (applicable to coupon-based discounts only)","uniqueKey":"Discounts.items.[INDEX].CouponCode","typeLabel":"string"},"Description":{"type":"string","description":"Discount textual description","uniqueKey":"Discounts.items.[INDEX].Description","typeLabel":"string"},"DiscountCode":{"type":"string","description":"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.","uniqueKey":"Discounts.items.[INDEX].DiscountCode","typeLabel":"string"},"DiscountSource":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9],"description":"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","uniqueKey":"Discounts.items.[INDEX].DiscountSource","typeLabel":"enum\u003cinteger>"},"DiscountType":{"type":"number","description":"Discount type (“Cart”, “Shipping”, etc.), as defined in the DiscountTypeOptions enumeration described in the Discount class in this document.","uniqueKey":"Discounts.items.[INDEX].DiscountType","typeLabel":"number"},"InternationalPrice":{"type":"number","description":"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.","uniqueKey":"Discounts.items.[INDEX].InternationalPrice","typeLabel":"number"},"LocalVATRate":{"type":"number","description":"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.","uniqueKey":"Discounts.items.[INDEX].LocalVATRate","typeLabel":"number"},"LoyaltyVoucherCode":{"type":"string","description":"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.","uniqueKey":"Discounts.items.[INDEX].LoyaltyVoucherCode","typeLabel":"string"},"Name":{"type":"string","description":"Discount name","uniqueKey":"Discounts.items.[INDEX].Name","typeLabel":"string"},"Price":{"type":"number","description":"Discount value in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.","uniqueKey":"Discounts.items.[INDEX].Price","typeLabel":"number"},"ProductCartItemId":{"type":"string","description":"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.","uniqueKey":"Discounts.items.[INDEX].ProductCartItemId","typeLabel":"string"},"VATRate":{"type":"number","description":"The VAT rate applied to this discount","uniqueKey":"Discounts.items.[INDEX].VATRate","typeLabel":"number"}},"uniqueKey":"Discounts.items.[INDEX]","typeLabel":"Merchant.Discount · object"},"description":"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.","uniqueKey":"Discounts","typeLabel":"Merchant.Discount · object[]"},"DoNotChargeVAT":{"type":"boolean","description":"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","uniqueKey":"DoNotChargeVAT","typeLabel":"boolean"},"ExporterDetails.DestinationRegistrationNumber":{"type":"number","description":"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.","uniqueKey":"ExporterDetails\\.DestinationRegistrationNumber","typeLabel":"number"},"ExporterDetails.LocalRegistrationClearance":{"type":"boolean","description":"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.","uniqueKey":"ExporterDetails\\.LocalRegistrationClearance","typeLabel":"boolean"},"FreeShippingCouponCode":{"type":"string","description":"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.","uniqueKey":"FreeShippingCouponCode","typeLabel":"string"},"InternationalDetails":{"type":"object","title":"Merchant.InternationalDetails","description":"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.","properties":{"CardNumberLastFourDigits":{"type":"string","description":"The last 4 digits of the Card number (if applicable).","uniqueKey":"InternationalDetails.CardNumberLastFourDigits","typeLabel":"string"},"CashOnDeliveryFee":{"type":"number","description":"The additional charge is paid by the end customer when the “Cash on Delivery” payment method has been selected.","uniqueKey":"InternationalDetails.CashOnDeliveryFee","typeLabel":"number"},"ConsignmentFee":{"type":"number","description":"The consignment fee is paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.","uniqueKey":"InternationalDetails.ConsignmentFee","typeLabel":"number"},"CurrencyCode":{"type":"string","description":"3-char ISO code for the currency selected by the end customer for the order payment.","uniqueKey":"InternationalDetails.CurrencyCode","typeLabel":"string"},"CustomerDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and taxes parts the customer paid for the order in the currency denoted by CurrencyCode.","properties":{"Duties":{"type":"number","description":"Duties that are applied.","uniqueKey":"InternationalDetails.CustomerDTBreakdown.Duties","typeLabel":"number"},"Other":{"type":"number","description":"Other DT fees that are applied.","uniqueKey":"InternationalDetails.CustomerDTBreakdown.Other","typeLabel":"number"},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied.","uniqueKey":"InternationalDetails.CustomerDTBreakdown.SalesTaxes","typeLabel":"number"}},"uniqueKey":"InternationalDetails.CustomerDTBreakdown","typeLabel":"DTBreakdown · object"},"DeliveryDaysFrom":{"type":"number","description":"The minimum number of days for delivery to the end customer for the selected shipping method.","uniqueKey":"InternationalDetails.DeliveryDaysFrom","typeLabel":"number"},"DeliveryDaysTo":{"type":"number","description":"The maximum number of days for delivery to the end customer for the selected shipping method.","uniqueKey":"InternationalDetails.DeliveryDaysTo","typeLabel":"number"},"DiscountedShippingPrice":{"type":"number","description":"The price paid by the customer in local currency. Total Shipping price reducing Order Discounts International price.","uniqueKey":"InternationalDetails.DiscountedShippingPrice","typeLabel":"number"},"DutiesGuaranteed":{"type":"boolean","description":"Indicates if the end customer has selected the “guaranteed duties and taxes” option.","uniqueKey":"InternationalDetails.DutiesGuaranteed","typeLabel":"boolean"},"ExpirationDate":{"type":"string","description":"Card expiration date in YYYY-MM-DD format (if applicable).","uniqueKey":"InternationalDetails.ExpirationDate","typeLabel":"string"},"MerchantDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and taxes parts the Merchant subsidized for the order in the currency denoted by CurrencyCode.","properties":{"Duties":{"type":"number","description":"Duties that are applied.","uniqueKey":"InternationalDetails.MerchantDTBreakdown.Duties","typeLabel":"number"},"Other":{"type":"number","description":"Other DT fees that are applied.","uniqueKey":"InternationalDetails.MerchantDTBreakdown.Other","typeLabel":"number"},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied.","uniqueKey":"InternationalDetails.MerchantDTBreakdown.SalesTaxes","typeLabel":"number"}},"uniqueKey":"InternationalDetails.MerchantDTBreakdown","typeLabel":"DTBreakdown · object"},"OrderTrackingNumber":{"type":"string","description":"Tracking number used by the selected international shipping method for this order.","uniqueKey":"InternationalDetails.OrderTrackingNumber","typeLabel":"string"},"OrderTrackingUrl":{"type":"string","description":"Full tracking URL including OrderTrackingNumber used by the selected international shipping method for this order.","uniqueKey":"InternationalDetails.OrderTrackingUrl","typeLabel":"string"},"OrderWaybillNumber":{"type":"string","description":"Waybill number used by the selected international shipping method for this order.","uniqueKey":"InternationalDetails.OrderWaybillNumber","typeLabel":"string"},"ParcelsTracking":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"InternationalDetails.ParcelsTracking.items.[INDEX]","typeLabel":"any"},"description":"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).","uniqueKey":"InternationalDetails.ParcelsTracking","typeLabel":"any[]"},"PaymentMethodCode":{"type":"string","description":"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.","uniqueKey":"InternationalDetails.PaymentMethodCode","typeLabel":"string"},"PaymentMethodName":{"type":"string","description":"Name of the selected payment method.","uniqueKey":"InternationalDetails.PaymentMethodName","typeLabel":"string"},"RemoteAreaSurcharge":{"type":"number","description":"Remote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.","uniqueKey":"InternationalDetails.RemoteAreaSurcharge","typeLabel":"number"},"SameDayDispatchCost":{"type":"number","description":"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.","uniqueKey":"InternationalDetails.SameDayDispatchCost","typeLabel":"number"},"ShippingMethodCode":{"type":"string","description":"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.","uniqueKey":"InternationalDetails.ShippingMethodCode","typeLabel":"string"},"ShippingMethodName":{"type":"string","description":"Name of the selected international shipping method.","uniqueKey":"InternationalDetails.ShippingMethodName","typeLabel":"string"},"ShippingMethodStatusCode":{"type":"string","description":"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.","uniqueKey":"InternationalDetails.ShippingMethodStatusCode","typeLabel":"string"},"ShippingMethodStatusName":{"type":"string","description":"Name of the shipping status.","uniqueKey":"InternationalDetails.ShippingMethodStatusName","typeLabel":"string"},"ShippingMethodTypeCode":{"type":"string","description":"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.","uniqueKey":"InternationalDetails.ShippingMethodTypeCode","typeLabel":"string"},"ShippingMethodTypeName":{"type":"string","description":"Name of the selected international shipping method type.","uniqueKey":"InternationalDetails.ShippingMethodTypeName","typeLabel":"string"},"ShippingVATRate":{"type":"number","description":"The shipping VAT rate for the customer. This rate is applied to the shipping cost.","uniqueKey":"InternationalDetails.ShippingVATRate","typeLabel":"number"},"SizeOverchargeValue":{"type":"number","description":"Oversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.","uniqueKey":"InternationalDetails.SizeOverchargeValue","typeLabel":"number"},"TotalCCFPrice":{"type":"number","description":"Total Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.","uniqueKey":"InternationalDetails.TotalCCFPrice","typeLabel":"number"},"TotalDutiesPrice":{"type":"number","description":"Total Duties \u0026 Taxes value including Customs Clearance Fees, in the currency denoted by CurrencyCode.","uniqueKey":"InternationalDetails.TotalDutiesPrice","typeLabel":"number"},"TotalPrice":{"type":"number","description":"Total order price in the currency denoted by CurrencyCode.","uniqueKey":"InternationalDetails.TotalPrice","typeLabel":"number"},"TotalShippingPrice":{"type":"number","description":"Total shipping price in the currency denoted by CurrencyCode.","uniqueKey":"InternationalDetails.TotalShippingPrice","typeLabel":"number"},"TotalVATAmount":{"type":"number","description":"Amount of VAT paid by the customer to Global‑e","uniqueKey":"InternationalDetails.TotalVATAmount","typeLabel":"number"},"TransactionCurrencyCode":{"type":"string","description":"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.","uniqueKey":"InternationalDetails.TransactionCurrencyCode","typeLabel":"string"},"TransactionTotalPrice":{"type":"number","description":"Total order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode.","uniqueKey":"InternationalDetails.TransactionTotalPrice","typeLabel":"number"},"USSalesTax":{"type":"number","description":"Sales tax value for the USA in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.","uniqueKey":"InternationalDetails.USSalesTax","typeLabel":"number"}},"uniqueKey":"InternationalDetails","typeLabel":"Merchant.InternationalDetails · object"},"IsB2B":{"type":"boolean","description":"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","uniqueKey":"IsB2B","typeLabel":"boolean"},"IsFreeShipping":{"type":"boolean","description":"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.","uniqueKey":"IsFreeShipping","typeLabel":"boolean"},"IsMoto":{"type":"boolean","description":"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","uniqueKey":"IsMoto","typeLabel":"boolean"},"IsReplacementOrder":{"type":"boolean","description":"Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - The order is not a replacement","uniqueKey":"IsReplacementOrder","typeLabel":"boolean"},"IsSplitOrder":{"type":"boolean","description":"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","uniqueKey":"IsSplitOrder","typeLabel":"boolean"},"IsTaxExemption":{"type":"boolean","description":"Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - Order does not have a tax exemption","uniqueKey":"IsTaxExemption","typeLabel":"boolean"},"LoyaltyCode":{"type":"string","description":"Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout.","uniqueKey":"LoyaltyCode","typeLabel":"string"},"LoyaltyPointsEarned":{"type":"number","description":"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.","uniqueKey":"LoyaltyPointsEarned","typeLabel":"number"},"LoyaltyPointsSpent":{"type":"number","description":"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).","uniqueKey":"LoyaltyPointsSpent","typeLabel":"number"},"Markups":{"type":"array","items":{"type":"object","title":"Merchant.Discount","properties":{"CouponCode":{"type":"string","description":"Merchant CouponCode used for this discount (applicable to coupon-based discounts only)","uniqueKey":"Markups.items.[INDEX].CouponCode","typeLabel":"string"},"Description":{"type":"string","description":"Discount textual description","uniqueKey":"Markups.items.[INDEX].Description","typeLabel":"string"},"DiscountCode":{"type":"string","description":"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.","uniqueKey":"Markups.items.[INDEX].DiscountCode","typeLabel":"string"},"DiscountSource":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9],"description":"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","uniqueKey":"Markups.items.[INDEX].DiscountSource","typeLabel":"enum\u003cinteger>"},"DiscountType":{"type":"number","description":"Discount type (“Cart”, “Shipping”, etc.), as defined in the DiscountTypeOptions enumeration described in the Discount class in this document.","uniqueKey":"Markups.items.[INDEX].DiscountType","typeLabel":"number"},"InternationalPrice":{"type":"number","description":"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.","uniqueKey":"Markups.items.[INDEX].InternationalPrice","typeLabel":"number"},"LocalVATRate":{"type":"number","description":"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.","uniqueKey":"Markups.items.[INDEX].LocalVATRate","typeLabel":"number"},"LoyaltyVoucherCode":{"type":"string","description":"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.","uniqueKey":"Markups.items.[INDEX].LoyaltyVoucherCode","typeLabel":"string"},"Name":{"type":"string","description":"Discount name","uniqueKey":"Markups.items.[INDEX].Name","typeLabel":"string"},"Price":{"type":"number","description":"Discount value in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.","uniqueKey":"Markups.items.[INDEX].Price","typeLabel":"number"},"ProductCartItemId":{"type":"string","description":"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.","uniqueKey":"Markups.items.[INDEX].ProductCartItemId","typeLabel":"string"},"VATRate":{"type":"number","description":"The VAT rate applied to this discount","uniqueKey":"Markups.items.[INDEX].VATRate","typeLabel":"number"}},"uniqueKey":"Markups.items.[INDEX]","typeLabel":"Merchant.Discount · object"},"description":"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.","uniqueKey":"Markups","typeLabel":"Merchant.Discount · object[]"},"MerchantDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and tax parts that the Merchant subsidized for the order.","properties":{"Duties":{"type":"number","description":"Duties that are applied.","uniqueKey":"MerchantDTBreakdown.Duties","typeLabel":"number"},"Other":{"type":"number","description":"Other DT fees that are applied.","uniqueKey":"MerchantDTBreakdown.Other","typeLabel":"number"},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied.","uniqueKey":"MerchantDTBreakdown.SalesTaxes","typeLabel":"number"}},"uniqueKey":"MerchantDTBreakdown","typeLabel":"DTBreakdown · object"},"MerchantGUID":{"type":"string","description":"Unique identifier of the Merchant on Global-e.","uniqueKey":"MerchantGUID","typeLabel":"string"},"MerchantOrderId":{"type":"string","description":"Order unique identifier on the Merchant’s site returned from a previous call to the SendOrderToMerchant method for this order.","uniqueKey":"MerchantOrderId","typeLabel":"string"},"ModifiedProduct":{"type":"string","description":"Holds the product’s SKU","uniqueKey":"ModifiedProduct","typeLabel":"string"},"OrderCreationSource":{"type":"number","description":"One of the values of OrderCreationSource enumeration denoting a type of discount shown in the OrderCreationSource Table.","uniqueKey":"OrderCreationSource","typeLabel":"number"},"OrderDocuments":{"type":"array","items":{"type":"object","title":"OrderDocument","properties":{"CreationDateTime":{"type":"string","format":"date-time","description":"The date and time the document was created.","uniqueKey":"OrderDocuments.items.[INDEX].CreationDateTime","typeLabel":"string\u003cdate-time>"},"DocumentData":{"type":"string","description":"Base64 encoded byte array representing the document file content.","uniqueKey":"OrderDocuments.items.[INDEX].DocumentData","typeLabel":"string"},"DocumentExtension":{"type":"string","description":"Document extension (PDF, ZPL, EPL).","uniqueKey":"OrderDocuments.items.[INDEX].DocumentExtension","typeLabel":"string"},"DocumentReference":{"type":"string","description":"The reference provided by the government authorities to this document (such as MRN or ITN number).","uniqueKey":"OrderDocuments.items.[INDEX].DocumentReference","typeLabel":"string"},"DocumentTypeCode":{"type":"string","description":"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","uniqueKey":"OrderDocuments.items.[INDEX].DocumentTypeCode","typeLabel":"string"},"DocumentTypeName":{"type":"string","description":"Document type name, e.g. AWB , CommercialInvoiceAndPackingList or Manifest.","uniqueKey":"OrderDocuments.items.[INDEX].DocumentTypeName","typeLabel":"string"},"ErrorMessage":{"type":"string","description":"Description of the error for this entity (order/parcel) if it happened.","uniqueKey":"OrderDocuments.items.[INDEX].ErrorMessage","typeLabel":"string"},"ParcelCode":{"type":"string","description":"The parcel code related to the document.","uniqueKey":"OrderDocuments.items.[INDEX].ParcelCode","typeLabel":"string"},"ShippingServiceName":{"type":"string","description":"The name of the shipping service for this document (relevant for DispatchOrders and DispatchConsolidatedShipment).","uniqueKey":"OrderDocuments.items.[INDEX].ShippingServiceName","typeLabel":"string"},"TrackingNumber":{"type":"string","description":"Shipping tracking number associated with the document.","uniqueKey":"OrderDocuments.items.[INDEX].TrackingNumber","typeLabel":"string"},"URL":{"type":"string","description":"URL of the document.","uniqueKey":"OrderDocuments.items.[INDEX].URL","typeLabel":"string"}},"uniqueKey":"OrderDocuments.items.[INDEX]","typeLabel":"OrderDocument · object"},"description":"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.","uniqueKey":"OrderDocuments","typeLabel":"OrderDocument · object[]"},"OrderId":{"type":"string","description":"Global‑e order unique identifier.","uniqueKey":"OrderId","typeLabel":"string"},"OrderPaymentMethods":{"type":"array","items":{"type":"object","title":"OrderPaymentMethod","properties":{"GiftCardFields":{"type":"string","description":"Gift card fields","uniqueKey":"OrderPaymentMethods.items.[INDEX].GiftCardFields","typeLabel":"string"},"IsGiftCard":{"type":"boolean","description":"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","uniqueKey":"OrderPaymentMethods.items.[INDEX].IsGiftCard","typeLabel":"boolean"},"PaidAmountInCustomerCurrency":{"type":"number","description":"Amount that paid in customer’s currency","uniqueKey":"OrderPaymentMethods.items.[INDEX].PaidAmountInCustomerCurrency","typeLabel":"number"},"PaidAmountInMerchantCurrency":{"type":"number","description":"Amount paid in Merchant’s currency","uniqueKey":"OrderPaymentMethods.items.[INDEX].PaidAmountInMerchantCurrency","typeLabel":"number"},"PaymentMethodId":{"type":"number","description":"The ID for the payment method","uniqueKey":"OrderPaymentMethods.items.[INDEX].PaymentMethodId","typeLabel":"number"},"PaymentMethodName":{"type":"string","description":"Name of the payment method","uniqueKey":"OrderPaymentMethods.items.[INDEX].PaymentMethodName","typeLabel":"string"}},"uniqueKey":"OrderPaymentMethods.items.[INDEX]","typeLabel":"OrderPaymentMethod · object"},"description":"List of payment methods the customer use (Credit card, Gift Cards)","uniqueKey":"OrderPaymentMethods","typeLabel":"OrderPaymentMethod · object[]"},"OrderStatusReason":{"type":"object","title":"OrderStatusReason","description":"Reason for the order status, why it was cancelled.","properties":{"Name":{"type":"string","description":"Order status reason name","uniqueKey":"OrderStatusReason.Name","typeLabel":"string"},"OrderStatusReasonCode":{"type":"string","description":"Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"OrderStatusReason.OrderStatusReasonCode","typeLabel":"string"}},"uniqueKey":"OrderStatusReason","typeLabel":"OrderStatusReason · object"},"OriginalOrder":{"type":"object","title":"Merchant.OriginalOrder","description":"Details that refer to the original order if the current order is a replacement.","properties":{"MerchantInternalOrderId":{"type":"string","description":"InternalOrderId returned from SendOrderToMerchant call for the original order.","uniqueKey":"OriginalOrder.MerchantInternalOrderId","typeLabel":"string"},"MerchantOrderId":{"type":"string","description":"OrderId returned from SendOrderToMerchant call for the original order.","uniqueKey":"OriginalOrder.MerchantOrderId","typeLabel":"string"},"OrderId":{"type":"string","description":"Global‑e order unique identifier for the original order.","uniqueKey":"OriginalOrder.OrderId","typeLabel":"string"}},"uniqueKey":"OriginalOrder","typeLabel":"Merchant.OriginalOrder · object"},"OTCurrencyCode":{"type":"string","description":"Currency of the one-time voucher code used to place the order.","uniqueKey":"OTCurrencyCode","typeLabel":"string"},"OTVoucherAmount":{"type":"number","description":"The amount taken off the voucher when applicable.","uniqueKey":"OTVoucherAmount","typeLabel":"number"},"OTVoucherCode":{"type":"string","description":"One-time voucher code used to place the order","uniqueKey":"OTVoucherCode","typeLabel":"string"},"Parcels":{"type":"array","items":{"type":"object","title":"Merchant.Parcel","properties":{"Code":{"type":"string","description":"Parcel code.","uniqueKey":"Parcels.items.[INDEX].Code","typeLabel":"string"},"ParcelStatusId":{"type":"number","description":"Parcel status id.","uniqueKey":"Parcels.items.[INDEX].ParcelStatusId","typeLabel":"number"},"StatusName":{"type":"string","description":"Parcel status name.","uniqueKey":"Parcels.items.[INDEX].StatusName","typeLabel":"string"},"TrackingUrl":{"type":"string","description":"Direct tracking URL.","uniqueKey":"Parcels.items.[INDEX].TrackingUrl","typeLabel":"string"},"Products":{"type":"array","items":{"type":"object","title":"Merchant.ParcelProduct","properties":{"CartItemId":{"type":"string","description":"Cart item id of the product.","uniqueKey":"Parcels.items.[INDEX].Products.items.[INDEX].CartItemId","typeLabel":"string"},"Quantity":{"type":"number","description":"Product quantity included in the parcel.","uniqueKey":"Parcels.items.[INDEX].Products.items.[INDEX].Quantity","typeLabel":"number"},"Sku":{"type":"string","description":"Product SKU.","uniqueKey":"Parcels.items.[INDEX].Products.items.[INDEX].Sku","typeLabel":"string"}},"uniqueKey":"Parcels.items.[INDEX].Products.items.[INDEX]","typeLabel":"Merchant.ParcelProduct · object"},"description":"List of products included in the parcel.","uniqueKey":"Parcels.items.[INDEX].Products","typeLabel":"Merchant.ParcelProduct · object[]"}},"uniqueKey":"Parcels.items.[INDEX]","typeLabel":"Merchant.Parcel · object"},"description":"The list of parcels created for the order.","uniqueKey":"Parcels","typeLabel":"Merchant.Parcel · object[]"},"PaymentDetails":{"type":"object","title":"Merchant.PaymentDetails","description":"The paying customer’s payment details.","properties":{"Address1":{"type":"string","description":"Address line 1","uniqueKey":"PaymentDetails.Address1","typeLabel":"string"},"Address2":{"type":"string","description":"Address line 2","uniqueKey":"PaymentDetails.Address2","typeLabel":"string"},"CardNumber":{"type":"string","description":"Card number","uniqueKey":"PaymentDetails.CardNumber","typeLabel":"string"},"City":{"type":"string","description":"City name","uniqueKey":"PaymentDetails.City","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code","uniqueKey":"PaymentDetails.CountryCode","typeLabel":"string"},"CountryName":{"type":"string","description":"Country name","uniqueKey":"PaymentDetails.CountryName","typeLabel":"string"},"CVVNumber":{"type":"string","description":"Card CVV number","uniqueKey":"PaymentDetails.CVVNumber","typeLabel":"string"},"Email":{"type":"string","description":"E-mail address","uniqueKey":"PaymentDetails.Email","typeLabel":"string"},"ExpirationDate":{"type":"string","description":"Card expiration date (in YYYY-MM-DD format)","uniqueKey":"PaymentDetails.ExpirationDate","typeLabel":"string"},"Fax":{"type":"string","description":"Fax","uniqueKey":"PaymentDetails.Fax","typeLabel":"string"},"OwnerFirstName":{"type":"string","description":"Card owner’s first name","uniqueKey":"PaymentDetails.OwnerFirstName","typeLabel":"string"},"OwnerLastName":{"type":"string","description":"Card owner’s last name","uniqueKey":"PaymentDetails.OwnerLastName","typeLabel":"string"},"OwnerName":{"type":"string","description":"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).","uniqueKey":"PaymentDetails.OwnerName","typeLabel":"string"},"PaymentMethodCode":{"type":"string","description":"Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side).","uniqueKey":"PaymentDetails.PaymentMethodCode","typeLabel":"string"},"PaymentMethodName":{"type":"string","description":"Payment method name","uniqueKey":"PaymentDetails.PaymentMethodName","typeLabel":"string"},"PaymentMethodTypeCode":{"type":"string","description":"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).","uniqueKey":"PaymentDetails.PaymentMethodTypeCode","typeLabel":"string"},"Phone1":{"type":"string","description":"Phone #1","uniqueKey":"PaymentDetails.Phone1","typeLabel":"string"},"Phone2":{"type":"string","description":"Phone #2","uniqueKey":"PaymentDetails.Phone2","typeLabel":"string"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)","uniqueKey":"PaymentDetails.StateCode","typeLabel":"string"},"StateOrProvice":{"type":"string","description":"State or province name","uniqueKey":"PaymentDetails.StateOrProvice","typeLabel":"string"},"Zip":{"type":"string","description":"Zip or postal code","uniqueKey":"PaymentDetails.Zip","typeLabel":"string"}},"uniqueKey":"PaymentDetails","typeLabel":"Merchant.PaymentDetails · object"},"PrePayOffered":{"type":"boolean","description":"Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered.","uniqueKey":"PrePayOffered","typeLabel":"boolean"},"PriceCoefficientRate":{"type":"number","description":"CountryCoefficient rate applied to the prices in this order.","uniqueKey":"PriceCoefficientRate","typeLabel":"number"},"PrimaryBilling":{"type":"object","title":"Merchant.CustomerDetails","description":"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.","properties":{"Address1":{"type":"string","description":"Address line 1","uniqueKey":"PrimaryBilling.Address1","typeLabel":"string"},"Address2":{"type":"string","description":"Address line 2","uniqueKey":"PrimaryBilling.Address2","typeLabel":"string"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book","uniqueKey":"PrimaryBilling.AddressBookId","typeLabel":"string"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book","uniqueKey":"PrimaryBilling.AddressBookName","typeLabel":"string"},"City":{"type":"string","description":"City name","uniqueKey":"PrimaryBilling.City","typeLabel":"string"},"Company":{"type":"string","description":"Company name","uniqueKey":"PrimaryBilling.Company","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code","uniqueKey":"PrimaryBilling.CountryCode","typeLabel":"string"},"CountryName":{"type":"string","description":"Country name","uniqueKey":"PrimaryBilling.CountryName","typeLabel":"string"},"Email":{"type":"string","description":"Email address","uniqueKey":"PrimaryBilling.Email","typeLabel":"string"},"Fax":{"type":"string","description":"Fax","uniqueKey":"PrimaryBilling.Fax","typeLabel":"string"},"FirstName":{"type":"string","description":"First name","uniqueKey":"PrimaryBilling.FirstName","typeLabel":"string"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture","uniqueKey":"PrimaryBilling.FirstNameInLocalCulture","typeLabel":"string"},"LastName":{"type":"string","description":"Last name","uniqueKey":"PrimaryBilling.LastName","typeLabel":"string"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture","uniqueKey":"PrimaryBilling.LastNameInLocalCulture","typeLabel":"string"},"MiddleName":{"type":"string","description":"Middle name","uniqueKey":"PrimaryBilling.MiddleName","typeLabel":"string"},"Phone1":{"type":"string","description":"Phone #1","uniqueKey":"PrimaryBilling.Phone1","typeLabel":"string"},"Phone2":{"type":"string","description":"Phone #2","uniqueKey":"PrimaryBilling.Phone2","typeLabel":"string"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)","uniqueKey":"PrimaryBilling.Salutation","typeLabel":"string"},"SaveAddress":{"type":"boolean","description":"Indicates that the current address should be saved in the Merchant platform","uniqueKey":"PrimaryBilling.SaveAddress","typeLabel":"boolean"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)","uniqueKey":"PrimaryBilling.StateCode","typeLabel":"string"},"StateOrProvice":{"type":"string","description":"State or province name","uniqueKey":"PrimaryBilling.StateOrProvice","typeLabel":"string"},"Zip":{"type":"string","description":"Zip or postal code","uniqueKey":"PrimaryBilling.Zip","typeLabel":"string"}},"uniqueKey":"PrimaryBilling","typeLabel":"Merchant.CustomerDetails · object"},"PrimaryShipping":{"type":"object","title":"Merchant.CustomerDetails","description":"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.","properties":{"Address1":{"type":"string","description":"Address line 1","uniqueKey":"PrimaryShipping.Address1","typeLabel":"string"},"Address2":{"type":"string","description":"Address line 2","uniqueKey":"PrimaryShipping.Address2","typeLabel":"string"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book","uniqueKey":"PrimaryShipping.AddressBookId","typeLabel":"string"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book","uniqueKey":"PrimaryShipping.AddressBookName","typeLabel":"string"},"City":{"type":"string","description":"City name","uniqueKey":"PrimaryShipping.City","typeLabel":"string"},"Company":{"type":"string","description":"Company name","uniqueKey":"PrimaryShipping.Company","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code","uniqueKey":"PrimaryShipping.CountryCode","typeLabel":"string"},"CountryName":{"type":"string","description":"Country name","uniqueKey":"PrimaryShipping.CountryName","typeLabel":"string"},"Email":{"type":"string","description":"Email address","uniqueKey":"PrimaryShipping.Email","typeLabel":"string"},"Fax":{"type":"string","description":"Fax","uniqueKey":"PrimaryShipping.Fax","typeLabel":"string"},"FirstName":{"type":"string","description":"First name","uniqueKey":"PrimaryShipping.FirstName","typeLabel":"string"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture","uniqueKey":"PrimaryShipping.FirstNameInLocalCulture","typeLabel":"string"},"LastName":{"type":"string","description":"Last name","uniqueKey":"PrimaryShipping.LastName","typeLabel":"string"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture","uniqueKey":"PrimaryShipping.LastNameInLocalCulture","typeLabel":"string"},"MiddleName":{"type":"string","description":"Middle name","uniqueKey":"PrimaryShipping.MiddleName","typeLabel":"string"},"Phone1":{"type":"string","description":"Phone #1","uniqueKey":"PrimaryShipping.Phone1","typeLabel":"string"},"Phone2":{"type":"string","description":"Phone #2","uniqueKey":"PrimaryShipping.Phone2","typeLabel":"string"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)","uniqueKey":"PrimaryShipping.Salutation","typeLabel":"string"},"SaveAddress":{"type":"boolean","description":"Indicates that the current address should be saved in the Merchant platform","uniqueKey":"PrimaryShipping.SaveAddress","typeLabel":"boolean"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)","uniqueKey":"PrimaryShipping.StateCode","typeLabel":"string"},"StateOrProvice":{"type":"string","description":"State or province name","uniqueKey":"PrimaryShipping.StateOrProvice","typeLabel":"string"},"Zip":{"type":"string","description":"Zip or postal code","uniqueKey":"PrimaryShipping.Zip","typeLabel":"string"}},"uniqueKey":"PrimaryShipping","typeLabel":"Merchant.CustomerDetails · object"},"Products":{"type":"array","items":{"type":"object","title":"Merchant.Product","properties":{"Attributes":{"type":"array","items":{"type":"object","title":"Merchant.CartProductAttribute","properties":{"AttributeKey":{"type":"string","description":"Custom product attribute name that is used to describe the personalized product.","uniqueKey":"Products.items.[INDEX].Attributes.items.[INDEX].AttributeKey","typeLabel":"string"},"AttributeValue":{"type":"string","description":"Custom product attribute value that is used to describe the personalized product.","uniqueKey":"Products.items.[INDEX].Attributes.items.[INDEX].AttributeValue","typeLabel":"string"}},"uniqueKey":"Products.items.[INDEX].Attributes.items.[INDEX]","typeLabel":"Merchant.CartProductAttribute · object"},"description":"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.","uniqueKey":"Products.items.[INDEX].Attributes","typeLabel":"Merchant.CartProductAttribute · object[]"},"BackOrderDate":{"type":"string","description":"Estimated date for the backordered item to be in stock","uniqueKey":"Products.items.[INDEX].BackOrderDate","typeLabel":"string"},"Brand":{"type":"object","title":"Merchant.Brand","description":"Product’s brandSku","properties":{"BrandCode":{"type":"string","description":"Brand code","uniqueKey":"Products.items.[INDEX].Brand.BrandCode","typeLabel":"string"},"Name":{"type":"string","description":"Brand name","uniqueKey":"Products.items.[INDEX].Brand.Name","typeLabel":"string"}},"uniqueKey":"Products.items.[INDEX].Brand","typeLabel":"Merchant.Brand · object"},"CartItemId":{"type":"string","description":"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.","uniqueKey":"Products.items.[INDEX].CartItemId","typeLabel":"string"},"CartItemOptionId":{"type":"string","description":"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.","uniqueKey":"Products.items.[INDEX].CartItemOptionId","typeLabel":"string"},"Categories":{"type":"array","items":{"type":"object","title":"Merchant.Category","properties":{"CategoryCode":{"type":"string","description":"Merchant category code","uniqueKey":"Products.items.[INDEX].Categories.items.[INDEX].CategoryCode","typeLabel":"string"},"Name":{"type":"string","description":"Merchant category name","uniqueKey":"Products.items.[INDEX].Categories.items.[INDEX].Name","typeLabel":"string"}},"uniqueKey":"Products.items.[INDEX].Categories.items.[INDEX]","typeLabel":"Merchant.Category · object"},"description":"List of product categories","uniqueKey":"Products.items.[INDEX].Categories","typeLabel":"Merchant.Category · object[]"},"CustomerVATRate":{"type":"number","description":"The customer VAT rate applied to this product","uniqueKey":"Products.items.[INDEX].CustomerVATRate","typeLabel":"number"},"DiscountedPrice":{"type":"number","description":"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.","uniqueKey":"Products.items.[INDEX].DiscountedPrice","typeLabel":"number"},"DiscountedPriceForCustoms":{"type":"number","description":"Product price in Merchant currency reflects the price after Reverse D\u0026T calculation.","uniqueKey":"Products.items.[INDEX].DiscountedPriceForCustoms","typeLabel":"number"},"DTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and taxes per item in Merchant currency.","properties":{"Duties":{"type":"number","description":"Duties that are applied.","uniqueKey":"Products.items.[INDEX].DTBreakdown.Duties","typeLabel":"number"},"Other":{"type":"number","description":"Other DT fees that are applied.","uniqueKey":"Products.items.[INDEX].DTBreakdown.Other","typeLabel":"number"},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied.","uniqueKey":"Products.items.[INDEX].DTBreakdown.SalesTaxes","typeLabel":"number"}},"uniqueKey":"Products.items.[INDEX].DTBreakdown","typeLabel":"DTBreakdown · object"},"GenericHSCode":{"type":"string","description":"Product’s HS code","uniqueKey":"Products.items.[INDEX].GenericHSCode","typeLabel":"string"},"GiftMessage":{"type":"string","description":"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.","uniqueKey":"Products.items.[INDEX].GiftMessage","typeLabel":"string"},"HandlingCode":{"type":"string","description":"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.","uniqueKey":"Products.items.[INDEX].HandlingCode","typeLabel":"string"},"InternationalDiscountedPrice":{"type":"number","description":"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.","uniqueKey":"Products.items.[INDEX].InternationalDiscountedPrice","typeLabel":"number"},"InternationalDiscountedPriceForCustoms":{"type":"number","description":"Product price in customer currency reflects the price after Reverse D\u0026T calculation","uniqueKey":"Products.items.[INDEX].InternationalDiscountedPriceForCustoms","typeLabel":"number"},"InternationalDiscountedPriceInMerchantCurrency":{"type":"number","description":"Product Price in Merchant currency","uniqueKey":"Products.items.[INDEX].InternationalDiscountedPriceInMerchantCurrency","typeLabel":"number"},"InternationalDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and taxes per item in customer currency.","properties":{"Duties":{"type":"number","description":"Duties that are applied.","uniqueKey":"Products.items.[INDEX].InternationalDTBreakdown.Duties","typeLabel":"number"},"Other":{"type":"number","description":"Other DT fees that are applied.","uniqueKey":"Products.items.[INDEX].InternationalDTBreakdown.Other","typeLabel":"number"},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied.","uniqueKey":"Products.items.[INDEX].InternationalDTBreakdown.SalesTaxes","typeLabel":"number"}},"uniqueKey":"Products.items.[INDEX].InternationalDTBreakdown","typeLabel":"DTBreakdown · object"},"InternationalListPrice":{"type":"number","description":"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.","uniqueKey":"Products.items.[INDEX].InternationalListPrice","typeLabel":"number"},"InternationalPrice":{"type":"number","description":"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.","uniqueKey":"Products.items.[INDEX].InternationalPrice","typeLabel":"number"},"IsBackOrdered":{"type":"boolean","description":"Identifies if the product was ordered as a backed ordered item TRUE - Product is back-ordered. FALSE - Product is not back-ordered.","uniqueKey":"Products.items.[INDEX].IsBackOrdered","typeLabel":"boolean"},"LineItemInternationalPrice":{"type":"number","description":"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.","uniqueKey":"Products.items.[INDEX].LineItemInternationalPrice","typeLabel":"number"},"LineItemPriceBeforeGlobalEDiscount":{"type":"number","deprecated":true,"description":"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.","uniqueKey":"Products.items.[INDEX].LineItemPriceBeforeGlobalEDiscount","typeLabel":"number"},"ListPrice":{"type":"number","description":"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.","uniqueKey":"Products.items.[INDEX].ListPrice","typeLabel":"number"},"Name":{"type":"string","description":"Name of the product.","uniqueKey":"Products.items.[INDEX].Name","typeLabel":"string"},"ParentCartItemId":{"type":"string","description":"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.","uniqueKey":"Products.items.[INDEX].ParentCartItemId","typeLabel":"string"},"Price":{"type":"number","description":"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.","uniqueKey":"Products.items.[INDEX].Price","typeLabel":"number"},"PriceBeforeGlobalEDiscount":{"type":"number","deprecated":true,"description":"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.","uniqueKey":"Products.items.[INDEX].PriceBeforeGlobalEDiscount","typeLabel":"number"},"ProductAttributes":{"type":"array","items":{"type":"object","title":"Merchant.ProductAttribute","properties":{"AttributeKey":{"type":"string","description":"Customized product attribute name, used to describe the personalized product.","uniqueKey":"Products.items.[INDEX].ProductAttributes.items.[INDEX].AttributeKey","typeLabel":"string"},"AttributeValue":{"type":"string","description":"Customized product attribute, used to describe the personalized product.","uniqueKey":"Products.items.[INDEX].ProductAttributes.items.[INDEX].AttributeValue","typeLabel":"string"}},"uniqueKey":"Products.items.[INDEX].ProductAttributes.items.[INDEX]","typeLabel":"Merchant.ProductAttribute · object"},"description":"Product attributes.","uniqueKey":"Products.items.[INDEX].ProductAttributes","typeLabel":"Merchant.ProductAttribute · object[]"},"Quantity":{"type":"number","description":"Product quantity in the order that is currently being submitted to the Merchant.","uniqueKey":"Products.items.[INDEX].Quantity","typeLabel":"number"},"RoundingRate":{"type":"number","description":"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.","uniqueKey":"Products.items.[INDEX].RoundingRate","typeLabel":"number"},"Sku":{"type":"string","description":"SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side).","uniqueKey":"Products.items.[INDEX].Sku","typeLabel":"string"},"VATRate":{"type":"number","description":"The VAT rate applied to this product","uniqueKey":"Products.items.[INDEX].VATRate","typeLabel":"number"}},"uniqueKey":"Products.items.[INDEX]","typeLabel":"Merchant.Product · object"},"description":"The list of products being purchased.","uniqueKey":"Products","typeLabel":"Merchant.Product · object[]"},"RoundingRate":{"type":"number","description":"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.","uniqueKey":"RoundingRate","typeLabel":"number"},"SameDayDispatch":{"type":"boolean","description":"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\"","uniqueKey":"SameDayDispatch","typeLabel":"boolean"},"SameDayDispatchCost":{"type":"number","description":"Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency.","uniqueKey":"SameDayDispatchCost","typeLabel":"number"},"SecondaryBilling":{"type":"object","title":"Merchant.CustomerDetails","description":"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.","properties":{"Address1":{"type":"string","description":"Address line 1","uniqueKey":"SecondaryBilling.Address1","typeLabel":"string"},"Address2":{"type":"string","description":"Address line 2","uniqueKey":"SecondaryBilling.Address2","typeLabel":"string"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book","uniqueKey":"SecondaryBilling.AddressBookId","typeLabel":"string"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book","uniqueKey":"SecondaryBilling.AddressBookName","typeLabel":"string"},"City":{"type":"string","description":"City name","uniqueKey":"SecondaryBilling.City","typeLabel":"string"},"Company":{"type":"string","description":"Company name","uniqueKey":"SecondaryBilling.Company","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code","uniqueKey":"SecondaryBilling.CountryCode","typeLabel":"string"},"CountryName":{"type":"string","description":"Country name","uniqueKey":"SecondaryBilling.CountryName","typeLabel":"string"},"Email":{"type":"string","description":"Email address","uniqueKey":"SecondaryBilling.Email","typeLabel":"string"},"Fax":{"type":"string","description":"Fax","uniqueKey":"SecondaryBilling.Fax","typeLabel":"string"},"FirstName":{"type":"string","description":"First name","uniqueKey":"SecondaryBilling.FirstName","typeLabel":"string"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture","uniqueKey":"SecondaryBilling.FirstNameInLocalCulture","typeLabel":"string"},"LastName":{"type":"string","description":"Last name","uniqueKey":"SecondaryBilling.LastName","typeLabel":"string"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture","uniqueKey":"SecondaryBilling.LastNameInLocalCulture","typeLabel":"string"},"MiddleName":{"type":"string","description":"Middle name","uniqueKey":"SecondaryBilling.MiddleName","typeLabel":"string"},"Phone1":{"type":"string","description":"Phone #1","uniqueKey":"SecondaryBilling.Phone1","typeLabel":"string"},"Phone2":{"type":"string","description":"Phone #2","uniqueKey":"SecondaryBilling.Phone2","typeLabel":"string"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)","uniqueKey":"SecondaryBilling.Salutation","typeLabel":"string"},"SaveAddress":{"type":"boolean","description":"Indicates that the current address should be saved in the Merchant platform","uniqueKey":"SecondaryBilling.SaveAddress","typeLabel":"boolean"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)","uniqueKey":"SecondaryBilling.StateCode","typeLabel":"string"},"StateOrProvice":{"type":"string","description":"State or province name","uniqueKey":"SecondaryBilling.StateOrProvice","typeLabel":"string"},"Zip":{"type":"string","description":"Zip or postal code","uniqueKey":"SecondaryBilling.Zip","typeLabel":"string"}},"uniqueKey":"SecondaryBilling","typeLabel":"Merchant.CustomerDetails · object"},"SecondaryShipping":{"type":"object","title":"Merchant.CustomerDetails","description":"Secondary customer’s shipping details. If Customer.IsEndCustomerPrimary is FALSE, this field contains the end customers' shipping details.","properties":{"Address1":{"type":"string","description":"Address line 1","uniqueKey":"SecondaryShipping.Address1","typeLabel":"string"},"Address2":{"type":"string","description":"Address line 2","uniqueKey":"SecondaryShipping.Address2","typeLabel":"string"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book","uniqueKey":"SecondaryShipping.AddressBookId","typeLabel":"string"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book","uniqueKey":"SecondaryShipping.AddressBookName","typeLabel":"string"},"City":{"type":"string","description":"City name","uniqueKey":"SecondaryShipping.City","typeLabel":"string"},"Company":{"type":"string","description":"Company name","uniqueKey":"SecondaryShipping.Company","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code","uniqueKey":"SecondaryShipping.CountryCode","typeLabel":"string"},"CountryName":{"type":"string","description":"Country name","uniqueKey":"SecondaryShipping.CountryName","typeLabel":"string"},"Email":{"type":"string","description":"Email address","uniqueKey":"SecondaryShipping.Email","typeLabel":"string"},"Fax":{"type":"string","description":"Fax","uniqueKey":"SecondaryShipping.Fax","typeLabel":"string"},"FirstName":{"type":"string","description":"First name","uniqueKey":"SecondaryShipping.FirstName","typeLabel":"string"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture","uniqueKey":"SecondaryShipping.FirstNameInLocalCulture","typeLabel":"string"},"LastName":{"type":"string","description":"Last name","uniqueKey":"SecondaryShipping.LastName","typeLabel":"string"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture","uniqueKey":"SecondaryShipping.LastNameInLocalCulture","typeLabel":"string"},"MiddleName":{"type":"string","description":"Middle name","uniqueKey":"SecondaryShipping.MiddleName","typeLabel":"string"},"Phone1":{"type":"string","description":"Phone #1","uniqueKey":"SecondaryShipping.Phone1","typeLabel":"string"},"Phone2":{"type":"string","description":"Phone #2","uniqueKey":"SecondaryShipping.Phone2","typeLabel":"string"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)","uniqueKey":"SecondaryShipping.Salutation","typeLabel":"string"},"SaveAddress":{"type":"boolean","description":"Indicates that the current address should be saved in the Merchant platform","uniqueKey":"SecondaryShipping.SaveAddress","typeLabel":"boolean"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)","uniqueKey":"SecondaryShipping.StateCode","typeLabel":"string"},"StateOrProvice":{"type":"string","description":"State or province name","uniqueKey":"SecondaryShipping.StateOrProvice","typeLabel":"string"},"Zip":{"type":"string","description":"Zip or postal code","uniqueKey":"SecondaryShipping.Zip","typeLabel":"string"}},"uniqueKey":"SecondaryShipping","typeLabel":"Merchant.CustomerDetails · object"},"ShippingMethodCode":{"type":"string","description":"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.","uniqueKey":"ShippingMethodCode","typeLabel":"string"},"ShipToStoreCode":{"type":"string","description":"Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on the Global‑e side).","uniqueKey":"ShipToStoreCode","typeLabel":"string"},"StatusCode":{"type":"string","description":"Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).","uniqueKey":"StatusCode","typeLabel":"string"},"Subs":{"type":"array","items":{"$circularRef":"143bc517-7005-44b5-af7f-dce30d75c9a5"},"description":"Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed.","uniqueKey":"Subs","typeLabel":"array"},"TotalDutiesAndTaxesPrice":{"type":"number","description":"Total Duties \u0026 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.","uniqueKey":"TotalDutiesAndTaxesPrice","typeLabel":"number"},"TotalDutiesPaidByCustomerPrice":{"type":"number","description":"The total amount of duties paid by the customer in the Merchant’s currency.","uniqueKey":"TotalDutiesPaidByCustomerPrice","typeLabel":"number"},"UserId":{"type":"string","description":"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.","uniqueKey":"UserId","typeLabel":"string"},"USSalesTax":{"type":"number","description":"Sales tax value for USA in the Merchant currency. This value is included in TotalDutiesAndTaxesPrice.","uniqueKey":"USSalesTax","typeLabel":"number"},"WebStoreCode":{"type":"string","description":"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.","uniqueKey":"WebStoreCode","typeLabel":"string"}},"uniqueKey":"","typeLabel":"Merchant.Order · object"},"example":{"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":"ema.hub@norsk-global.com","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},"examples":{"Example":{"title":"Example","value":{"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":"ema.hub@norsk-global.com","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}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"11ab0935-f7bd-407f-8392-5383ea490595":{"description":"Response Parameters","content":{"application/json":{"schema":{"type":"object","title":"Merchant.StockValidationResponse","description":"Provides information related to validating that stock exists.","properties":{"AmendedProducts":{"type":"array","items":{"type":"object","title":"Merchant.StockValidationRowResponse","properties":{"CartItemId":{"type":"string","description":"Identifier of the cart item on the Merchant’s site originally specified in the Product.CartItemId property of the respective product in the cart","uniqueKey":"AmendedProducts.items.[INDEX].CartItemId","typeLabel":"string"},"QuantityInStock":{"type":"string","description":"Available product quantity","uniqueKey":"AmendedProducts.items.[INDEX].QuantityInStock","typeLabel":"string"}},"uniqueKey":"AmendedProducts.items.[INDEX]","typeLabel":"Merchant.StockValidationRowResponse · object"},"description":"The list of products that don’t have full stock availability for the Product.Quantity specified in the respective ValidateStock API request.","uniqueKey":"AmendedProducts","typeLabel":"Merchant.StockValidationRowResponse · object[]"},"CustomResources":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"CustomResources.additionalProperties","typeLabel":"string"},"description":"Dictionary with custom resources for error and oos popup. Keys for the dictionary: TitleTextResourceId , BodyTextResourceId , ButtonTextResourceId , RedirectUrl.","uniqueKey":"CustomResources","typeLabel":"object"},"Error":{"type":"string","description":"The error message returned from the Merchant","uniqueKey":"Error","typeLabel":"string"},"ReservationRequestId":{"type":"string","description":"The stock reservation code returned from the Merchant if the stock has been actually reserved as a result of the ValidateStock API call.","uniqueKey":"ReservationRequestId","typeLabel":"string"},"TextResourcesPlaceholders":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"TextResourcesPlaceholders.additionalProperties","typeLabel":"string"},"description":"Dictionary with placeholders which need to be replaced in text resources for error and oos popup which was passed in CustomResources (except RedirectUrl key).","uniqueKey":"TextResourcesPlaceholders","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Merchant.StockValidationResponse · object"},"examples":{"allInStock":{"title":"allInStock","value":{"AmendedProducts":[],"ReservationRequestId":null,"Error":null}},"someOutOfStock":{"title":"someOutOfStock","value":{"AmendedProducts":[{"CartItemID":"11007","QuantityInStock":1}],"ReservationRequestId":null}},"genericError":{"title":"genericError","value":{"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}},"invalidEmailError":{"title":"invalidEmailError","value":{"AmendedProducts":[],"Error":"2","StackTrace":null,"ReservationRequestId":null}},"invalidCartContentError":{"title":"invalidCartContentError","value":{"AmendedProducts":[],"Error":"1","StackTrace":null,"ReservationRequestId":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"d666d6be-9833-4afa-b7a3-b2974057d945":{"url":"https://{merchant_site_domain}","variables":{"merchant_site_domain":{"default":"www.merchant-site-domain.com","description":"The merchant-hosted domain that exposes the checkout-validate-cart-stock endpoint."}}}},"schemas":{"143bc517-7005-44b5-af7f-dce30d75c9a5":{"type":"object","title":"Merchant.Order","description":"Provides information related to the order.","additionalProperties":true,"properties":{"AdditionalRequiredDocuments":{"type":"array","items":{"type":"object","title":"OrderDocument","properties":{"CreationDateTime":{"type":"string","format":"date-time","description":"The date and time the document was created."},"DocumentData":{"type":"string","description":"Base64 encoded byte array representing the document file content."},"DocumentExtension":{"type":"string","description":"Document extension (PDF, ZPL, EPL)."},"DocumentReference":{"type":"string","description":"The reference provided by the government authorities to this document (such as MRN or ITN number)."},"DocumentTypeCode":{"type":"string","description":"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":{"type":"string","description":"Document type name, e.g. AWB , CommercialInvoiceAndPackingList or Manifest."},"ErrorMessage":{"type":"string","description":"Description of the error for this entity (order/parcel) if it happened."},"ParcelCode":{"type":"string","description":"The parcel code related to the document."},"ShippingServiceName":{"type":"string","description":"The name of the shipping service for this document (relevant for DispatchOrders and DispatchConsolidatedShipment)."},"TrackingNumber":{"type":"string","description":"Shipping tracking number associated with the document."},"URL":{"type":"string","description":"URL of the document."}}},"description":"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":{"type":"boolean","description":"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":{"type":"string","description":"Cart hash originally specified in the merchantCartHash argument for the SendCart method for the cart converted to this order on Global‑e."},"CartId":{"type":"string","description":"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":{"type":"number","description":"Cash On Delivery fee amount in Merchant’s currency."},"CCFPrice":{"type":"number","description":"Customs Clearance Fees (CCF), in the Merchant currency."},"ClearCart":{"type":"boolean","description":"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":{"type":"string","description":"3-char ISO currency code for the order being posted. By default, this is set to the original Merchant’s currency."},"CurrencyName":{"type":"string","description":"Customer currency name."},"Customer":{"type":"object","title":"Merchant.Customer","description":"The paying customer’s preferences (Global-e acts as a paying customer).","properties":{"IsEndCustomerPrimary":{"type":"boolean","description":"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":{"type":"boolean","description":"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)."}}},"CustomerComments":{"type":"string","description":"Comments text entered by the end customer in Global‑e checkout."},"CustomerDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and tax parts the customer paid for the order.","properties":{"Duties":{"type":"number","description":"Duties that are applied."},"Other":{"type":"number","description":"Other DT fees that are applied."},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied."}}},"DateCreated":{"type":"string","description":"Order creation date and time."},"DiscountedShippingPrice":{"type":"number","description":"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":{"type":"array","items":{"type":"object","title":"Merchant.Discount","properties":{"CouponCode":{"type":"string","description":"Merchant CouponCode used for this discount (applicable to coupon-based discounts only)"},"Description":{"type":"string","description":"Discount textual description"},"DiscountCode":{"type":"string","description":"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."},"DiscountSource":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9],"description":"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"},"DiscountType":{"type":"number","description":"Discount type (“Cart”, “Shipping”, etc.), as defined in the DiscountTypeOptions enumeration described in the Discount class in this document."},"InternationalPrice":{"type":"number","description":"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."},"LocalVATRate":{"type":"number","description":"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."},"LoyaltyVoucherCode":{"type":"string","description":"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."},"Name":{"type":"string","description":"Discount name"},"Price":{"type":"number","description":"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":{"type":"string","description":"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."},"VATRate":{"type":"number","description":"The VAT rate applied to this discount"}}},"description":"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."},"DoNotChargeVAT":{"type":"boolean","description":"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":{"type":"number","description":"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":{"type":"boolean","description":"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":{"type":"string","description":"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":{"type":"object","title":"Merchant.InternationalDetails","description":"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.","properties":{"CardNumberLastFourDigits":{"type":"string","description":"The last 4 digits of the Card number (if applicable)."},"CashOnDeliveryFee":{"type":"number","description":"The additional charge is paid by the end customer when the “Cash on Delivery” payment method has been selected."},"ConsignmentFee":{"type":"number","description":"The consignment fee is paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice."},"CurrencyCode":{"type":"string","description":"3-char ISO code for the currency selected by the end customer for the order payment."},"CustomerDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and taxes parts the customer paid for the order in the currency denoted by CurrencyCode.","properties":{"Duties":{"type":"number","description":"Duties that are applied."},"Other":{"type":"number","description":"Other DT fees that are applied."},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied."}}},"DeliveryDaysFrom":{"type":"number","description":"The minimum number of days for delivery to the end customer for the selected shipping method."},"DeliveryDaysTo":{"type":"number","description":"The maximum number of days for delivery to the end customer for the selected shipping method."},"DiscountedShippingPrice":{"type":"number","description":"The price paid by the customer in local currency. Total Shipping price reducing Order Discounts International price."},"DutiesGuaranteed":{"type":"boolean","description":"Indicates if the end customer has selected the “guaranteed duties and taxes” option."},"ExpirationDate":{"type":"string","description":"Card expiration date in YYYY-MM-DD format (if applicable)."},"MerchantDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and taxes parts the Merchant subsidized for the order in the currency denoted by CurrencyCode.","properties":{"Duties":{"type":"number","description":"Duties that are applied."},"Other":{"type":"number","description":"Other DT fees that are applied."},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied."}}},"OrderTrackingNumber":{"type":"string","description":"Tracking number used by the selected international shipping method for this order."},"OrderTrackingUrl":{"type":"string","description":"Full tracking URL including OrderTrackingNumber used by the selected international shipping method for this order."},"OrderWaybillNumber":{"type":"string","description":"Waybill number used by the selected international shipping method for this order."},"ParcelsTracking":{"type":"array","items":{"oneOf":[{}]},"description":"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":{"type":"string","description":"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":{"type":"string","description":"Name of the selected payment method."},"RemoteAreaSurcharge":{"type":"number","description":"Remote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice."},"SameDayDispatchCost":{"type":"number","description":"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."},"ShippingMethodCode":{"type":"string","description":"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":{"type":"string","description":"Name of the selected international shipping method."},"ShippingMethodStatusCode":{"type":"string","description":"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."},"ShippingMethodStatusName":{"type":"string","description":"Name of the shipping status."},"ShippingMethodTypeCode":{"type":"string","description":"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":{"type":"string","description":"Name of the selected international shipping method type."},"ShippingVATRate":{"type":"number","description":"The shipping VAT rate for the customer. This rate is applied to the shipping cost."},"SizeOverchargeValue":{"type":"number","description":"Oversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice."},"TotalCCFPrice":{"type":"number","description":"Total Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice."},"TotalDutiesPrice":{"type":"number","description":"Total Duties \u0026 Taxes value including Customs Clearance Fees, in the currency denoted by CurrencyCode."},"TotalPrice":{"type":"number","description":"Total order price in the currency denoted by CurrencyCode."},"TotalShippingPrice":{"type":"number","description":"Total shipping price in the currency denoted by CurrencyCode."},"TotalVATAmount":{"type":"number","description":"Amount of VAT paid by the customer to Global‑e"},"TransactionCurrencyCode":{"type":"string","description":"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":{"type":"number","description":"Total order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode."},"USSalesTax":{"type":"number","description":"Sales tax value for the USA in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice."}}},"IsB2B":{"type":"boolean","description":"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":{"type":"boolean","description":"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":{"type":"boolean","description":"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":{"type":"boolean","description":"Indicates if the order is a replacement. TRUE - The order is a replacement FALSE - The order is not a replacement"},"IsSplitOrder":{"type":"boolean","description":"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":{"type":"boolean","description":"Indicates if the order has a tax exemption. TRUE - Order has a tax exemption FALSE - Order does not have a tax exemption"},"LoyaltyCode":{"type":"string","description":"Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout."},"LoyaltyPointsEarned":{"type":"number","description":"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":{"type":"number","description":"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":{"type":"array","items":{"type":"object","title":"Merchant.Discount","properties":{"CouponCode":{"type":"string","description":"Merchant CouponCode used for this discount (applicable to coupon-based discounts only)"},"Description":{"type":"string","description":"Discount textual description"},"DiscountCode":{"type":"string","description":"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."},"DiscountSource":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9],"description":"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"},"DiscountType":{"type":"number","description":"Discount type (“Cart”, “Shipping”, etc.), as defined in the DiscountTypeOptions enumeration described in the Discount class in this document."},"InternationalPrice":{"type":"number","description":"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."},"LocalVATRate":{"type":"number","description":"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."},"LoyaltyVoucherCode":{"type":"string","description":"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."},"Name":{"type":"string","description":"Discount name"},"Price":{"type":"number","description":"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":{"type":"string","description":"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."},"VATRate":{"type":"number","description":"The VAT rate applied to this discount"}}},"description":"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."},"MerchantDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and tax parts that the Merchant subsidized for the order.","properties":{"Duties":{"type":"number","description":"Duties that are applied."},"Other":{"type":"number","description":"Other DT fees that are applied."},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied."}}},"MerchantGUID":{"type":"string","description":"Unique identifier of the Merchant on Global-e."},"MerchantOrderId":{"type":"string","description":"Order unique identifier on the Merchant’s site returned from a previous call to the SendOrderToMerchant method for this order."},"ModifiedProduct":{"type":"string","description":"Holds the product’s SKU"},"OrderCreationSource":{"type":"number","description":"One of the values of OrderCreationSource enumeration denoting a type of discount shown in the OrderCreationSource Table."},"OrderDocuments":{"type":"array","items":{"type":"object","title":"OrderDocument","properties":{"CreationDateTime":{"type":"string","format":"date-time","description":"The date and time the document was created."},"DocumentData":{"type":"string","description":"Base64 encoded byte array representing the document file content."},"DocumentExtension":{"type":"string","description":"Document extension (PDF, ZPL, EPL)."},"DocumentReference":{"type":"string","description":"The reference provided by the government authorities to this document (such as MRN or ITN number)."},"DocumentTypeCode":{"type":"string","description":"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":{"type":"string","description":"Document type name, e.g. AWB , CommercialInvoiceAndPackingList or Manifest."},"ErrorMessage":{"type":"string","description":"Description of the error for this entity (order/parcel) if it happened."},"ParcelCode":{"type":"string","description":"The parcel code related to the document."},"ShippingServiceName":{"type":"string","description":"The name of the shipping service for this document (relevant for DispatchOrders and DispatchConsolidatedShipment)."},"TrackingNumber":{"type":"string","description":"Shipping tracking number associated with the document."},"URL":{"type":"string","description":"URL of the document."}}},"description":"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":{"type":"string","description":"Global‑e order unique identifier."},"OrderPaymentMethods":{"type":"array","items":{"type":"object","title":"OrderPaymentMethod","properties":{"GiftCardFields":{"type":"string","description":"Gift card fields"},"IsGiftCard":{"type":"boolean","description":"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":{"type":"number","description":"Amount that paid in customer’s currency"},"PaidAmountInMerchantCurrency":{"type":"number","description":"Amount paid in Merchant’s currency"},"PaymentMethodId":{"type":"number","description":"The ID for the payment method"},"PaymentMethodName":{"type":"string","description":"Name of the payment method"}}},"description":"List of payment methods the customer use (Credit card, Gift Cards)"},"OrderStatusReason":{"type":"object","title":"OrderStatusReason","description":"Reason for the order status, why it was cancelled.","properties":{"Name":{"type":"string","description":"Order status reason name"},"OrderStatusReasonCode":{"type":"string","description":"Code denoting the order status reason on the Merchant’s site (to be mapped on the Global‑e side)"}}},"OriginalOrder":{"type":"object","title":"Merchant.OriginalOrder","description":"Details that refer to the original order if the current order is a replacement.","properties":{"MerchantInternalOrderId":{"type":"string","description":"InternalOrderId returned from SendOrderToMerchant call for the original order."},"MerchantOrderId":{"type":"string","description":"OrderId returned from SendOrderToMerchant call for the original order."},"OrderId":{"type":"string","description":"Global‑e order unique identifier for the original order."}}},"OTCurrencyCode":{"type":"string","description":"Currency of the one-time voucher code used to place the order."},"OTVoucherAmount":{"type":"number","description":"The amount taken off the voucher when applicable."},"OTVoucherCode":{"type":"string","description":"One-time voucher code used to place the order"},"Parcels":{"type":"array","items":{"type":"object","title":"Merchant.Parcel","properties":{"Code":{"type":"string","description":"Parcel code."},"ParcelStatusId":{"type":"number","description":"Parcel status id."},"StatusName":{"type":"string","description":"Parcel status name."},"TrackingUrl":{"type":"string","description":"Direct tracking URL."},"Products":{"type":"array","items":{"type":"object","title":"Merchant.ParcelProduct","properties":{"CartItemId":{"type":"string","description":"Cart item id of the product."},"Quantity":{"type":"number","description":"Product quantity included in the parcel."},"Sku":{"type":"string","description":"Product SKU."}}},"description":"List of products included in the parcel."}}},"description":"The list of parcels created for the order."},"PaymentDetails":{"type":"object","title":"Merchant.PaymentDetails","description":"The paying customer’s payment details.","properties":{"Address1":{"type":"string","description":"Address line 1"},"Address2":{"type":"string","description":"Address line 2"},"CardNumber":{"type":"string","description":"Card number"},"City":{"type":"string","description":"City name"},"CountryCode":{"type":"string","description":"2-char ISO country code"},"CountryName":{"type":"string","description":"Country name"},"CVVNumber":{"type":"string","description":"Card CVV number"},"Email":{"type":"string","description":"E-mail address"},"ExpirationDate":{"type":"string","description":"Card expiration date (in YYYY-MM-DD format)"},"Fax":{"type":"string","description":"Fax"},"OwnerFirstName":{"type":"string","description":"Card owner’s first name"},"OwnerLastName":{"type":"string","description":"Card owner’s last name"},"OwnerName":{"type":"string","description":"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)."},"PaymentMethodCode":{"type":"string","description":"Payment method code used to identify the payment method on the Merchant’s site (to be mapped on the Global‑e side)."},"PaymentMethodName":{"type":"string","description":"Payment method name"},"PaymentMethodTypeCode":{"type":"string","description":"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":{"type":"string","description":"Phone #1"},"Phone2":{"type":"string","description":"Phone #2"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)"},"StateOrProvice":{"type":"string","description":"State or province name"},"Zip":{"type":"string","description":"Zip or postal code"}}},"PrePayOffered":{"type":"boolean","description":"Indicates if the prepayment option for duties and taxes was offered to the customer. TRUE - Prepayment option offered. FALSE - Prepayment option not offered."},"PriceCoefficientRate":{"type":"number","description":"CountryCoefficient rate applied to the prices in this order."},"PrimaryBilling":{"type":"object","title":"Merchant.CustomerDetails","description":"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.","properties":{"Address1":{"type":"string","description":"Address line 1"},"Address2":{"type":"string","description":"Address line 2"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book"},"City":{"type":"string","description":"City name"},"Company":{"type":"string","description":"Company name"},"CountryCode":{"type":"string","description":"2-char ISO country code"},"CountryName":{"type":"string","description":"Country name"},"Email":{"type":"string","description":"Email address"},"Fax":{"type":"string","description":"Fax"},"FirstName":{"type":"string","description":"First name"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture"},"LastName":{"type":"string","description":"Last name"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture"},"MiddleName":{"type":"string","description":"Middle name"},"Phone1":{"type":"string","description":"Phone #1"},"Phone2":{"type":"string","description":"Phone #2"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)"},"SaveAddress":{"type":"boolean","description":"Indicates that the current address should be saved in the Merchant platform"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)"},"StateOrProvice":{"type":"string","description":"State or province name"},"Zip":{"type":"string","description":"Zip or postal code"}}},"PrimaryShipping":{"type":"object","title":"Merchant.CustomerDetails","description":"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.","properties":{"Address1":{"type":"string","description":"Address line 1"},"Address2":{"type":"string","description":"Address line 2"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book"},"City":{"type":"string","description":"City name"},"Company":{"type":"string","description":"Company name"},"CountryCode":{"type":"string","description":"2-char ISO country code"},"CountryName":{"type":"string","description":"Country name"},"Email":{"type":"string","description":"Email address"},"Fax":{"type":"string","description":"Fax"},"FirstName":{"type":"string","description":"First name"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture"},"LastName":{"type":"string","description":"Last name"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture"},"MiddleName":{"type":"string","description":"Middle name"},"Phone1":{"type":"string","description":"Phone #1"},"Phone2":{"type":"string","description":"Phone #2"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)"},"SaveAddress":{"type":"boolean","description":"Indicates that the current address should be saved in the Merchant platform"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)"},"StateOrProvice":{"type":"string","description":"State or province name"},"Zip":{"type":"string","description":"Zip or postal code"}}},"Products":{"type":"array","items":{"type":"object","title":"Merchant.Product","properties":{"Attributes":{"type":"array","items":{"type":"object","title":"Merchant.CartProductAttribute","properties":{"AttributeKey":{"type":"string","description":"Custom product attribute name that is used to describe the personalized product."},"AttributeValue":{"type":"string","description":"Custom product attribute value that is used to describe the personalized product."}}},"description":"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."},"BackOrderDate":{"type":"string","description":"Estimated date for the backordered item to be in stock"},"Brand":{"type":"object","title":"Merchant.Brand","description":"Product’s brandSku","properties":{"BrandCode":{"type":"string","description":"Brand code"},"Name":{"type":"string","description":"Brand name"}}},"CartItemId":{"type":"string","description":"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."},"CartItemOptionId":{"type":"string","description":"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."},"Categories":{"type":"array","items":{"type":"object","title":"Merchant.Category","properties":{"CategoryCode":{"type":"string","description":"Merchant category code"},"Name":{"type":"string","description":"Merchant category name"}}},"description":"List of product categories"},"CustomerVATRate":{"type":"number","description":"The customer VAT rate applied to this product"},"DiscountedPrice":{"type":"number","description":"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":{"type":"number","description":"Product price in Merchant currency reflects the price after Reverse D\u0026T calculation."},"DTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and taxes per item in Merchant currency.","properties":{"Duties":{"type":"number","description":"Duties that are applied."},"Other":{"type":"number","description":"Other DT fees that are applied."},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied."}}},"GenericHSCode":{"type":"string","description":"Product’s HS code"},"GiftMessage":{"type":"string","description":"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."},"HandlingCode":{"type":"string","description":"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."},"InternationalDiscountedPrice":{"type":"number","description":"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":{"type":"number","description":"Product price in customer currency reflects the price after Reverse D\u0026T calculation"},"InternationalDiscountedPriceInMerchantCurrency":{"type":"number","description":"Product Price in Merchant currency"},"InternationalDTBreakdown":{"type":"object","title":"DTBreakdown","description":"Contains the duties and taxes per item in customer currency.","properties":{"Duties":{"type":"number","description":"Duties that are applied."},"Other":{"type":"number","description":"Other DT fees that are applied."},"SalesTaxes":{"type":"number","description":"Sales taxes that are applied."}}},"InternationalListPrice":{"type":"number","description":"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."},"InternationalPrice":{"type":"number","description":"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."},"IsBackOrdered":{"type":"boolean","description":"Identifies if the product was ordered as a backed ordered item TRUE - Product is back-ordered. FALSE - Product is not back-ordered."},"LineItemInternationalPrice":{"type":"number","description":"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."},"LineItemPriceBeforeGlobalEDiscount":{"type":"number","deprecated":true,"description":"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."},"ListPrice":{"type":"number","description":"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":{"type":"string","description":"Name of the product."},"ParentCartItemId":{"type":"string","description":"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."},"Price":{"type":"number","description":"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":{"type":"number","deprecated":true,"description":"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."},"ProductAttributes":{"type":"array","items":{"type":"object","title":"Merchant.ProductAttribute","properties":{"AttributeKey":{"type":"string","description":"Customized product attribute name, used to describe the personalized product."},"AttributeValue":{"type":"string","description":"Customized product attribute, used to describe the personalized product."}}},"description":"Product attributes."},"Quantity":{"type":"number","description":"Product quantity in the order that is currently being submitted to the Merchant."},"RoundingRate":{"type":"number","description":"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":{"type":"string","description":"SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)."},"VATRate":{"type":"number","description":"The VAT rate applied to this product"}}},"description":"The list of products being purchased."},"RoundingRate":{"type":"number","description":"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":{"type":"boolean","description":"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":{"type":"number","description":"Cost of the “Same Day Dispatch” option selected by the end customer on Global‑e checkout, in the original Merchant’s currency."},"SecondaryBilling":{"type":"object","title":"Merchant.CustomerDetails","description":"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.","properties":{"Address1":{"type":"string","description":"Address line 1"},"Address2":{"type":"string","description":"Address line 2"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book"},"City":{"type":"string","description":"City name"},"Company":{"type":"string","description":"Company name"},"CountryCode":{"type":"string","description":"2-char ISO country code"},"CountryName":{"type":"string","description":"Country name"},"Email":{"type":"string","description":"Email address"},"Fax":{"type":"string","description":"Fax"},"FirstName":{"type":"string","description":"First name"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture"},"LastName":{"type":"string","description":"Last name"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture"},"MiddleName":{"type":"string","description":"Middle name"},"Phone1":{"type":"string","description":"Phone #1"},"Phone2":{"type":"string","description":"Phone #2"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)"},"SaveAddress":{"type":"boolean","description":"Indicates that the current address should be saved in the Merchant platform"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)"},"StateOrProvice":{"type":"string","description":"State or province name"},"Zip":{"type":"string","description":"Zip or postal code"}}},"SecondaryShipping":{"type":"object","title":"Merchant.CustomerDetails","description":"Secondary customer’s shipping details. If Customer.IsEndCustomerPrimary is FALSE, this field contains the end customers' shipping details.","properties":{"Address1":{"type":"string","description":"Address line 1"},"Address2":{"type":"string","description":"Address line 2"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book"},"City":{"type":"string","description":"City name"},"Company":{"type":"string","description":"Company name"},"CountryCode":{"type":"string","description":"2-char ISO country code"},"CountryName":{"type":"string","description":"Country name"},"Email":{"type":"string","description":"Email address"},"Fax":{"type":"string","description":"Fax"},"FirstName":{"type":"string","description":"First name"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture"},"LastName":{"type":"string","description":"Last name"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture"},"MiddleName":{"type":"string","description":"Middle name"},"Phone1":{"type":"string","description":"Phone #1"},"Phone2":{"type":"string","description":"Phone #2"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)"},"SaveAddress":{"type":"boolean","description":"Indicates that the current address should be saved in the Merchant platform"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)"},"StateOrProvice":{"type":"string","description":"State or province name"},"Zip":{"type":"string","description":"Zip or postal code"}}},"ShippingMethodCode":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side)."},"Subs":{"type":"array","items":{"$circularRef":"143bc517-7005-44b5-af7f-dce30d75c9a5"},"description":"Contains Sub orders related to Mixed order. This list is defined only in case the order is Mixed."},"TotalDutiesAndTaxesPrice":{"type":"number","description":"Total Duties \u0026 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":{"type":"number","description":"The total amount of duties paid by the customer in the Merchant’s currency."},"UserId":{"type":"string","description":"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":{"type":"number","description":"Sales tax value for USA in the Merchant currency. This value is included in TotalDutiesAndTaxesPrice."},"WebStoreCode":{"type":"string","description":"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."}}}}},"originalFileLocation":"api-reference/specs/validatestock.yaml"},"subdomain":"globale-enterprise","siteName":"Global-e Docs","title":"Validate Stock (Global-e to Merchant) - Global-e Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-30T13:30:59.569Z","originalFileLocation":"api-reference/validate-stock.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The Merchant Cart Validation checks basic cart validity and validates the product\u0026#x27;s stock availability.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Global-e Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Validate Stock (Global-e to Merchant) - Global-e Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Merchant Cart Validation checks basic cart validity and validates the product\u0026#x27;s stock availability.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Global-e Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.global-e.com/api-reference/validate-stock\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://globale-enterprise.mintlify.app/_mintlify/api/og/v2?division=Checkout+%26+Cart\u0026amp;title=Validate+Stock+%28Global-e+to+Merchant%29\u0026amp;description=The+Merchant+Cart+Validation+checks+basic+cart+validity+and+validates+the+product%27s+stock+availability.\u0026amp;theme=ba448c405b24dd48494124de\u0026amp;signature=00db0acdb503759f3cde409e684c40136cf633c0eabebfc751fec14bda886a7d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Validate Stock (Global-e to Merchant) - Global-e Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Merchant Cart Validation checks basic cart validity and validates the product\u0026#x27;s stock availability.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://globale-enterprise.mintlify.app/_mintlify/api/og/v2?division=Checkout+%26+Cart\u0026amp;title=Validate+Stock+%28Global-e+to+Merchant%29\u0026amp;description=The+Merchant+Cart+Validation+checks+basic+cart+validity+and+validates+the+product%27s+stock+availability.\u0026amp;theme=ba448c405b24dd48494124de\u0026amp;signature=00db0acdb503759f3cde409e684c40136cf633c0eabebfc751fec14bda886a7d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Global-e Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F15A2B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.global-e.com/api-reference/validate-stock\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/validate-stock.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.global-e.com/#organization\",\"name\":\"Global-e Docs\",\"url\":\"https://docs.global-e.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/logo/light.png?fit=max\u0026auto=format\u0026n=xvASI8IP64Cj0kr_\u0026q=85\u0026s=3b5849fa849995b81b219c94b874d44f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.global-e.com#website\",\"name\":\"Global-e Docs\",\"url\":\"https://docs.global-e.com\",\"publisher\":{\"@id\":\"https://docs.global-e.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.global-e.com/api-reference/validate-stock#webpage\",\"url\":\"https://docs.global-e.com/api-reference/validate-stock\",\"name\":\"Validate Stock (Global-e to Merchant)\",\"description\":\"The Merchant Cart Validation checks basic cart validity and validates the product's stock availability.\",\"dateModified\":\"2026-09-30T13:30:59.569Z\",\"isPartOf\":{\"@id\":\"https://docs.global-e.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.global-e.com/api-reference/validate-stock#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.global-e.com/api-reference/validate-stock#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.global-e.com/api-reference/send-order-to-merchant\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Checkout \u0026 Cart\",\"item\":\"https://docs.global-e.com/api-reference/get-checkout-cart-info\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Validate Stock (Global-e to Merchant)\",\"item\":\"https://docs.global-e.com/api-reference/validate-stock\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.global-e.com/api-reference/validate-stock#apireference\",\"headline\":\"Validate Stock (Global-e to Merchant)\",\"name\":\"Validate Stock (Global-e to Merchant)\",\"description\":\"The Merchant Cart Validation checks basic cart validity and validates the product's stock availability.\",\"url\":\"https://docs.global-e.com/api-reference/validate-stock\",\"mainEntityOfPage\":{\"@id\":\"https://docs.global-e.com/api-reference/validate-stock#webpage\"},\"dateModified\":\"2026-09-30T13:30:59.569Z\",\"publisher\":{\"@id\":\"https://docs.global-e.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.global-e.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Global-e Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Global-e Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/global-e-enablement-platform"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"},{"title":"API Authentication","href":"/api-authentication"}]},{"group":"Shipping","pages":[{"title":"Get shipping documents (Merchant to Global-e)","sidebarTitle":"Get shipping documents","openapi":"api-reference/specs/getshippingdocuments.yaml POST /Order/GetShippingDocuments","href":"/api-reference/get-shipping-documents"},{"title":"Get shipping details (Merchant to Global-e)","sidebarTitle":"Get shipping details","openapi":"api-reference/specs/getshippingdetails.yaml POST /ShippingDetails/GetShippingDetails","href":"/api-reference/get-shipping-details"},{"title":"Get shipping details extended (Merchant to Global-e)","sidebarTitle":"Get shipping details extended","openapi":"api-reference/specs/getshippingdetailsextended.yaml POST /ShippingDetails/GetShippingDetailsExtended","href":"/api-reference/get-shipping-details-extended"},{"title":"Dispatch orders (Merchant to Global-e)","sidebarTitle":"Dispatch orders","openapi":"api-reference/specs/dispatchorders.yaml POST /Order/DispatchOrders","href":"/api-reference/dispatch-orders"},{"title":"Dispatch consolidated shipment (Merchant to Global-e)","sidebarTitle":"Dispatch consolidated shipment","openapi":"api-reference/specs/dispatchconsolidatedshipment.yaml POST /Order/DispatchConsolidatedShipment","href":"/api-reference/dispatch-consolidated-shipment"},{"title":"Get tracking events (Merchant to Global-e)","sidebarTitle":"Get tracking events","openapi":"api-reference/specs/gettrackingevents.yaml POST /Shipment/GetTrackingEvents","href":"/api-reference/get-tracking-events"},{"title":"Void parcel (Merchant to Global-e)","sidebarTitle":"Void parcel","openapi":"api-reference/specs/voidparcel.yaml POST /Parcel/VoidParcel","href":"/api-reference/void-parcel"},{"title":"Submit bonded information (Merchant to Global-e)","sidebarTitle":"Submit bonded information","openapi":"api-reference/specs/submitbondedinformation.yaml POST /api/merchant/parcels/bonded-information","href":"/api-reference/submit-bonded-information"},{"title":"Upload shipment documents (Merchant to Global-e)","sidebarTitle":"Upload shipment documents","openapi":"api-reference/specs/uploadshipmentdocuments.yaml POST /api/shipments/documents/upload","href":"/api-reference/upload-shipment-documents"},{"title":"Get shipment information (Merchant to Global-e)","sidebarTitle":"Get shipment information","openapi":"api-reference/specs/getshipmentinformation.yaml GET /api/shipments/{trackingNumber}","href":"/api-reference/get-shipment-information"}]},{"group":"Orders","pages":[{"title":"Create order (Merchant to Global-e)","sidebarTitle":"Create order","openapi":"api-reference/specs/createorder.yaml POST /checkout/CreateOrder","href":"/api-reference/create-order"},{"title":"Edit order (Merchant to Global-e)","sidebarTitle":"Edit order","openapi":"api-reference/specs/editorder.yaml POST /api/orders/changes","href":"/api-reference/edit-order"},{"title":"Quote order changes (Merchant to Global-e)","sidebarTitle":"Quote order changes","openapi":"api-reference/specs/editorder.yaml POST /api/orders/changes/quote","href":"/api-reference/edit-order-quote"},{"title":"Update Order Dispatch","openapi":"api-reference/specs/updateorderdispatch.yaml POST /Order/UpdateOrderDispatch","href":"/api-reference/update-order-dispatch"},{"title":"Update parcel status (Merchant to Global-e)","sidebarTitle":"Update parcel status","openapi":"api-reference/specs/updateparcelstatus.yaml POST /orders/{orderId}/parcels/{parcelCode}/statuses","href":"/api-reference/update-parcel-status"},{"title":"Update Order Status","openapi":"api-reference/specs/updateorderstatus.yaml POST /Order/UpdateOrderStatus","href":"/api-reference/update-order-status"},{"title":"Create order refund (Merchant to Global-e)","sidebarTitle":"Create order refund","openapi":"api-reference/specs/createorderrefund.yaml POST /Order/CreateOrderRefund","href":"/api-reference/create-order-refund"},{"title":"Create order platform (Merchant to Global-e)","sidebarTitle":"Create order platform","openapi":"api-reference/specs/createorderplatform.yaml POST /Checkout/CreateOrderPlatform","href":"/api-reference/create-order-platform"},{"title":"Update Order Products (Merchant to Global-e)","sidebarTitle":"Update Order Products","openapi":"api-reference/specs/updateorderproducts.yaml POST /Order/UpdateOrderProducts","href":"/api-reference/update-order-products"},{"title":"UpdateOrderDispatchV2","openapi":"api-reference/specs/updateorderdispatchv2.yaml POST /Order/UpdateOrderDispatchV2","href":"/api-reference/update-order-dispatch-v2"},{"title":"Create Additional Required Documents (Merchant to Global-e)","sidebarTitle":"Create Additional Required Documents","openapi":"api-reference/specs/createadditionalrequireddocuments.yaml POST /additional-required-documents","href":"/api-reference/create-additional-required-documents"},{"title":"Get refund details (Merchant to Global-e)","sidebarTitle":"Get refund details","openapi":"api-reference/specs/getrefunddetails.yaml GET /v1/orders/{orderId}/refunds","href":"/api-reference/get-refund-details"},{"title":"Sending Bulk Emails (Merchant to Global-e)","sidebarTitle":"Sending Bulk Emails","openapi":"api-reference/specs/sendbulkemails.yaml POST /emails","href":"/api-reference/send-bulk-emails"}]},{"group":"Returns","pages":[{"title":"Get return shipping options (Merchant to Global-e)","sidebarTitle":"Get return shipping options","openapi":"api-reference/specs/getreturnshippingoptions.yaml POST /Return/GetReturnShippingOptions","href":"/api-reference/get-return-shipping-options"},{"title":"Get return documents (Merchant to Global-e)","sidebarTitle":"Get return documents","openapi":"api-reference/specs/getreturndocuments.yaml POST /Return/GetReturnDocuments","href":"/api-reference/get-return-documents"},{"title":"Update RMA (Merchant to Global-e)","sidebarTitle":"Update RMA","openapi":"api-reference/specs/updaterma.yaml POST /Return/UpdateRMA","href":"/api-reference/update-rma"}]},{"group":"Gift Cards","pages":[{"title":"Validate gift card","openapi":"api-reference/specs/giftcards.yaml POST /ValidateGiftCard","href":"/api-reference/validate-gift-card"},{"title":"Redeem gift card","openapi":"api-reference/specs/giftcards.yaml POST /RedeemGiftCard","href":"/api-reference/redeem-gift-card"},{"title":"Refund gift card","openapi":"api-reference/specs/giftcards.yaml POST /RefundGiftCard","href":"/api-reference/refund-gift-card"}]},{"group":"Checkout","pages":[{"title":"SendCartV2 (Merchant to Global-e)","sidebarTitle":"SendCartV2","openapi":"api-reference/specs/sendcartv2.yaml POST /Checkout/SendCartV2","href":"/api-reference/send-cart-v2"}]},{"group":"Pricing","pages":[{"title":"Get catalog prices (Merchant to Global-e)","sidebarTitle":"Get catalog prices","openapi":"api-reference/specs/getcatalogprices.yaml POST /Browsing/GetCatalogPrices","href":"/api-reference/get-catalog-prices"},{"title":"GetMerchantPriceDetails (Merchant to Global-e)","sidebarTitle":"GetMerchantPriceDetails","openapi":"api-reference/specs/getmerchantpricedetails.yaml GET /externalapi/GetMerchantPriceDetails","href":"/api-reference/get-merchant-price-details"}]},{"group":"Browsing \u0026 Catalog","pages":[{"title":"Active hub details (Merchant to Global-e)","sidebarTitle":"Active hub details","openapi":"api-reference/specs/activehubdetails.yaml POST /Browsing/ActiveHubDetails","href":"/api-reference/active-hub-details"},{"title":"App settings (Merchant to Global-e)","sidebarTitle":"App settings","openapi":"api-reference/specs/appsettings.yaml POST /Browsing/AppSettings","href":"/api-reference/app-settings"},{"title":"App version (Merchant to Global-e)","sidebarTitle":"App version","openapi":"api-reference/specs/appversion.yaml POST /Browsing/AppVersion","href":"/api-reference/app-version"},{"title":"Countries (Merchant to Global-e)","sidebarTitle":"Countries","openapi":"api-reference/specs/countries.yaml POST /Browsing/Countries","href":"/api-reference/countries"},{"title":"Country coefficients (Merchant to Global-e)","sidebarTitle":"Country coefficients","openapi":"api-reference/specs/countrycoefficients.yaml POST /Browsing/CountryCoefficients","href":"/api-reference/country-coefficients"},{"title":"Currencies (Merchant to Global-e)","sidebarTitle":"Currencies","openapi":"api-reference/specs/currencies.yaml POST /Browsing/Currencies","href":"/api-reference/currencies"},{"title":"Currency Rates (Merchant to Global-e)","sidebarTitle":"Currency Rates","openapi":"api-reference/specs/currencyrates.yaml POST /Browsing/CurrencyRates","href":"/api-reference/currency-rates"},{"title":"Location by IP (Merchant to Global-e)","sidebarTitle":"Location by IP","openapi":"api-reference/specs/locationbyip.yaml POST /Browsing/LocationByIP","href":"/api-reference/location-by-ip"},{"title":"Location default culture (Merchant to Global-e)","sidebarTitle":"Location default culture","openapi":"api-reference/specs/locationdefaultculture.yaml POST /Browsing/LocationDefaultCulture","href":"/api-reference/location-default-culture"},{"title":"Locations Default Cultures List (Merchant to Global-e)","sidebarTitle":"Locations Default Cultures List","openapi":"api-reference/specs/locationsdefaultcultureslist.yaml POST /Browsing/LocationsDefaultCulturesList","href":"/api-reference/locations-default-cultures-list"},{"title":"Product Countries (Merchant to Global-e)","sidebarTitle":"Product Countries","openapi":"api-reference/specs/productcountries.yaml POST /Browsing/ProductCountryS","href":"/api-reference/product-countries"},{"title":"Recent Product Countries (Merchant to Global-e)","sidebarTitle":"Recent Product Countries","openapi":"api-reference/specs/recentproductcountries.yaml POST /Browsing/RecentProductCountryS","href":"/api-reference/recent-product-countries"},{"title":"Regions (Merchant to Global-e)","sidebarTitle":"Regions","openapi":"api-reference/specs/regions.yaml POST /Browsing/Regions","href":"/api-reference/regions"},{"title":"Rounding rules (Merchant to Global-e)","sidebarTitle":"Rounding rules","openapi":"api-reference/specs/roundingrules.yaml POST /Browsing/RoundingRules","href":"/api-reference/rounding-rules"},{"title":"Save products list (Merchant to Global-e)","sidebarTitle":"Save products list","openapi":"api-reference/specs/saveproductslist.yaml POST /Browsing/SaveProductsList","href":"/api-reference/save-products-list"},{"title":"Save Products Bulk (Merchant to Global-e)","sidebarTitle":"Save Products Bulk","openapi":"api-reference/specs/saveproductsbulk.yaml POST /Bulk/SaveProductsBulk","href":"/api-reference/save-products-bulk"},{"title":"Shipping Options (Merchant to Global-e)","sidebarTitle":"Shipping Options","openapi":"api-reference/specs/shippingoptions.yaml POST /Browsing/ShippingOptions","href":"/api-reference/shipping-options"},{"title":"VAT Category Countries (Merchant to Global-e)","sidebarTitle":"VAT Category Countries","openapi":"api-reference/specs/vatcategorycountries.yaml POST /Browsing/VATCategoryCountryS","href":"/api-reference/vat-category-countries"}]},{"group":"Subscriptions","pages":[{"title":"Get subscription and payment reference details (Merchant to Global-e)","sidebarTitle":"Get subscription and payment reference details","openapi":"api-reference/specs/getsubscriptionandpaymentreferencedetails.yaml GET /Payments/Subscriptions/{merchantGuid}","href":"/api-reference/get-subscription-and-payment-reference-details"},{"title":"Subscription notifications (Subscription Manager to Global-e)","sidebarTitle":"Subscription notifications","openapi":"api-reference/specs/subscriptionnotifications.yaml POST /subscriptions/notifications","href":"/api-reference/subscription-notifications"},{"title":"Calculate billing summary (Subscription Manager to Global-e)","sidebarTitle":"Calculate billing summary","openapi":"api-reference/specs/billingsummarycalculate.yaml POST /subscriptions/billing-summary/calculate","href":"/api-reference/calculate-billing-summary"},{"title":"Create recurring payment (Subscription Manager to Global-e)","sidebarTitle":"Create recurring payment","openapi":"api-reference/specs/recurringpayments.yaml POST /subscriptions/recurringPayments","href":"/api-reference/create-recurring-payment"},{"title":"Update a subscription (Subscription Manager to Global-e)","sidebarTitle":"Update a subscription","openapi":"api-reference/specs/updatesubscription.yaml PATCH /subscriptions/{subscriptionId}","href":"/api-reference/update-subscription"}]},{"group":"Webhooks","pages":[{"group":"Orders","pages":[{"title":"Send Order To Merchant (Global-e to Merchant)","sidebarTitle":"Send Order To Merchant","openapi":"api-reference/specs/sendordertomerchant.yaml POST /order-update-create-url","href":"/api-reference/send-order-to-merchant"},{"title":"Send additional required documents to merchant (Global-e to Merchant)","sidebarTitle":"Send additional required documents to merchant","openapi":"api-reference/specs/sendadditionalrequireddocumentstomerchant.yaml POST /send-additional-required-documents-url","href":"/api-reference/send-additional-required-documents-to-merchant"},{"title":"Notify order refund (Global-e to Merchant)","sidebarTitle":"Notify order refund","openapi":"api-reference/specs/notifyorderrefund.yaml POST /order-refund-url","href":"/api-reference/notify-order-refund"},{"title":"Update Order Shipping Info (Global-e to Merchant)","sidebarTitle":"Update Order Shipping Info","openapi":"api-reference/specs/updateordershippinginfo.yaml POST /order-shipping-info-update-only-url","href":"/api-reference/update-order-shipping-info"},{"title":"Update Order Status (Global-e to Merchant)","sidebarTitle":"Update Order Status","openapi":"api-reference/specs/updateorderstatusfromglobale.yaml POST /order-status-update-url","href":"/api-reference/update-order-status-from-globale"},{"title":"Send RMA Info to Merchant (Global-e to Merchant)","sidebarTitle":"Send RMA Info to Merchant","openapi":"api-reference/specs/sendrmainfomerchant.yaml POST /rma-info-to-merchant-url","href":"/api-reference/send-rma-info-merchant"},{"title":"Perform Order Payment (Global-e to Merchant)","sidebarTitle":"Perform Order Payment","openapi":"api-reference/specs/performorderpayment.yaml POST /order-payment-only-url","href":"/api-reference/perform-order-payment"}]},{"group":"Checkout \u0026 Cart","pages":[{"title":"Get Checkout Cart Info (Global-e to Merchant)","sidebarTitle":"Get Checkout Cart Info","description":"The GetCheckoutCartInfo API retrieves cart information for international checkout processing.","openapi":"api-reference/specs/getcheckoutcartinfo.yaml GET /get-checkout-cart-info-url","href":"/api-reference/get-checkout-cart-info"},{"title":"Validate Stock (Global-e to Merchant)","sidebarTitle":"Validate Stock","openapi":"api-reference/specs/validatestock.yaml POST /checkout-validate-cart-stock-url","href":"/api-reference/validate-stock"},{"title":"ValidateVoucher (Global-e to Merchant)","sidebarTitle":"ValidateVoucher","description":"This API returns new CartToken in the CartToken attribute. The API call is used to help validate vouchers/coupons used on the Checkout page.","openapi":"api-reference/specs/validatevoucher.yaml POST /checkout-validate-cart-voucher-url","href":"/api-reference/validate-voucher"},{"title":"Client apply loyalty vouchers (Global-e to Merchant)","sidebarTitle":"Client apply loyalty vouchers","openapi":"api-reference/specs/clientapplyloyaltyvouchers.yaml POST /ClientApplyLoyaltyVouchers","href":"/api-reference/client-apply-loyalty-vouchers"},{"title":"RemoveRestrictedProducts (Global-e to Merchant)","sidebarTitle":"RemoveRestrictedProducts","openapi":"api-reference/specs/removerestrictedproducts.yaml POST /remove-restricted-products-url","href":"/api-reference/remove-restricted-products"}]},{"group":"Fulfillment","pages":[{"title":"Update Parcel Dispatch","openapi":"api-reference/specs/updateparceldispatch.yaml POST /UpdateParcelDispatch","href":"/api-reference/update-parcel-dispatch"}]},{"group":"Subscriptions","pages":[{"title":"Recurring payment notifications (Global-e to Subscription Manager)","sidebarTitle":"Recurring payment notifications","openapi":"api-reference/specs/recurringpaymentnotifications.yaml POST /subscriptions/recurringPayments/notifications","href":"/api-reference/recurring-payment-notifications"}]}]},{"group":"Shared Objects","pages":[{"title":"Attributes","href":"/api-reference/objects/attributes"},{"title":"BillingDetails","href":"/api-reference/objects/billing-details"},{"title":"Brand","href":"/api-reference/objects/brand"},{"title":"Category","href":"/api-reference/objects/category"},{"title":"DiscountsList","href":"/api-reference/objects/discounts-list"},{"title":"Parcel","href":"/api-reference/objects/parcel"},{"title":"ShippingDetails","href":"/api-reference/objects/shipping-details"},{"title":"UserIdNumberType","href":"/api-reference/objects/user-id-number-type"},{"title":"VATRateType","href":"/api-reference/objects/vat-rate-type"}]}]}]},"basePath":"","title":"Validate Stock (Global-e to Merchant) - Global-e Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}