Returns all available shipping options for the cart information specified either by cartToken or by including all the relevant checkoutCartInfo details.
Merchants who implement API checkout only, may specify the Cart token returned by the SendCart method preceding the current method call. In this case, all other arguments will be ignored and the information stored in the respective Cart will be used instead. Either cartToken or checkoutCartInfo must be specified.
{"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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/globale-enterprise/bdd88c3538cea5b1/style.css"}],"page":{"pagePath":"api-reference/shipping-options","slug":"/api-reference/shipping-options","pageMetadata":{"contextual":{"options":[{"title":"View YAML","description":"Open the OpenAPI spec for this endpoint","icon":"file-code","href":"/api-reference/specs/shippingoptions.yaml"},"download-spec","copy","view","chatgpt","claude"]},"title":"Shipping Options (Merchant to Global-e)","sidebarTitle":"Shipping Options","description":"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.","openapi":"api-reference/specs/shippingoptions.yaml POST /Browsing/ShippingOptions","href":"/api-reference/shipping-options"},"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: \"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Returns all available shipping options for the cart information specified either by `,_jsx(_components.code,{children:`cartToken`}),` or by including all the relevant `,_jsx(_components.code,{children:`checkoutCartInfo`}),` details.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"contextual":{"options":[{"title":"View YAML","description":"Open the OpenAPI spec for this endpoint","icon":"file-code","href":"/api-reference/specs/shippingoptions.yaml"},"download-spec","copy","view","chatgpt","claude"]},"title":"Shipping Options (Merchant to Global-e)","sidebarTitle":"Shipping Options","description":"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.","openapi":"api-reference/specs/shippingoptions.yaml POST /Browsing/ShippingOptions","href":"/api-reference/shipping-options"}}},"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":"Return all available shipping options for the specified cart","description":"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.","operationId":"shippingOptions","tags":["ShippingOptions"],"parameters":["272ed558-e5a2-4be0-9125-569f53891433","bc2a3014-fe81-4ef6-aa85-cafaca37f6d1"],"responses":{"200":"3af24764-2ac1-4222-abc3-513d048e2eb0"},"method":"post","type":"path","servers":["5b0e9afe-ee28-4492-abb0-6cb4de478e0c"],"security":[],"path":"/Browsing/ShippingOptions","baseUrlOptions":["https://{globale_api_domain}"],"title":"Return all available shipping options for the specified cart","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"272ed558-e5a2-4be0-9125-569f53891433":{"name":"cartToken","in":"query","required":false,"description":"Merchants who implement API checkout only, may specify the Cart token returned by the SendCart method preceding the current method call. In this case, all other arguments will be ignored and the information stored in the respective Cart will be used instead. Either cartToken or checkoutCartInfo must be specified.","schema":{"type":"string","isRequired":false,"description":"Merchants who implement API checkout only, may specify the Cart token returned by the SendCart method preceding the current method call. In this case, all other arguments will be ignored and the information stored in the respective Cart will be used instead. Either cartToken or checkoutCartInfo must be specified.","uniqueKey":"","typeLabel":"string"}},"bc2a3014-fe81-4ef6-aa85-cafaca37f6d1":{"name":"checkoutCartInfo","in":"query","required":false,"description":"Full cart information. Either cartToken or checkoutCartInfo must be specified.","schema":{"type":"object","title":"CheckoutCartInfo","required":["productsList"],"properties":{"productsList":{"type":"array","items":{"type":"object","title":"Product","properties":{"Attributes":{"type":"array","items":{"type":"object","title":"Attributes","properties":{"AttributeCode":{"type":"string","description":"Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].Attributes.items.[INDEX].AttributeCode","typeLabel":"string"},"AttributeTypeCode":{"type":"string","description":"Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for \"colour\", etc. (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].Attributes.items.[INDEX].AttributeTypeCode","typeLabel":"string"},"Name":{"type":"string","description":"Attribute name","uniqueKey":"productsList.items.[INDEX].Attributes.items.[INDEX].Name","typeLabel":"string"}},"uniqueKey":"productsList.items.[INDEX].Attributes.items.[INDEX]","typeLabel":"Attributes · object"},"description":"The product’s custom attributes (such as Color, Size, etc.)","uniqueKey":"productsList.items.[INDEX].Attributes","typeLabel":"Attributes · object[]"},"AttributesEnglish":{"type":"array","items":{"type":"object","title":"Attributes","properties":{"AttributeCode":{"type":"string","description":"Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].AttributesEnglish.items.[INDEX].AttributeCode","typeLabel":"string"},"AttributeTypeCode":{"type":"string","description":"Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for \"colour\", etc. (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].AttributesEnglish.items.[INDEX].AttributeTypeCode","typeLabel":"string"},"Name":{"type":"string","description":"Attribute name","uniqueKey":"productsList.items.[INDEX].AttributesEnglish.items.[INDEX].Name","typeLabel":"string"}},"uniqueKey":"productsList.items.[INDEX].AttributesEnglish.items.[INDEX]","typeLabel":"Attributes · object"},"description":"The product’s custom attributes (such as Color, Size, etc.) in English","uniqueKey":"productsList.items.[INDEX].AttributesEnglish","typeLabel":"Attributes · object[]"},"BackOrderDate":{"type":"string","description":"Estimated date for the backordered item to be in stock","uniqueKey":"productsList.items.[INDEX].BackOrderDate","typeLabel":"string"},"Brand":{"type":"object","title":"Brand","description":"The product’s brand","properties":{"BrandCode":{"type":"string","description":"Brand code on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].Brand.BrandCode","typeLabel":"string"},"Name":{"type":"string","description":"Brand name","uniqueKey":"productsList.items.[INDEX].Brand.Name","typeLabel":"string"}},"uniqueKey":"productsList.items.[INDEX].Brand","typeLabel":"Brand · object"},"CartItemId":{"type":"string","description":"Identifier of the cart item on the Merchant’s site. This property may be optionally specified in the SendCart method only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant method.","uniqueKey":"productsList.items.[INDEX].CartItemId","typeLabel":"string"},"CartItemOptionId":{"type":"string","description":"Identifier of the child cart item “option” on the Merchant’s site. This value must be specified if the current cart item is related to a parent item ( CartItemId must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a package for the parent item in the same cart. This property may be optionally specified in the SendCart method only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant method.","uniqueKey":"productsList.items.[INDEX].CartItemOptionId","typeLabel":"string"},"Categories":{"type":"array","items":{"type":"object","title":"Category","properties":{"CategoryCode":{"type":"string","description":"Category code on the Merchant site (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].Categories.items.[INDEX].CategoryCode","typeLabel":"string"},"Name":{"type":"string","description":"Category name","uniqueKey":"productsList.items.[INDEX].Categories.items.[INDEX].Name","typeLabel":"string"}},"uniqueKey":"productsList.items.[INDEX].Categories.items.[INDEX]","typeLabel":"Category · object"},"description":"The product’s categories","uniqueKey":"productsList.items.[INDEX].Categories","typeLabel":"Category · object[]"},"DeliveryQuantity":{"type":"number","description":"The quantity actually set for delivery for the product (to be used in the Order methods described below, as needed)","uniqueKey":"productsList.items.[INDEX].DeliveryQuantity","typeLabel":"number"},"Description":{"type":"string","description":"Description of the Product","uniqueKey":"productsList.items.[INDEX].Description","typeLabel":"string"},"DescriptionEnglish":{"type":"string","description":"Description of the Product in English","uniqueKey":"productsList.items.[INDEX].DescriptionEnglish","typeLabel":"string"},"GenericHSCode":{"type":"string","description":"The product’s generic HS Code (not country-specific). If specified this property may assist in mapping the product for duties and taxes calculation purposes.","uniqueKey":"productsList.items.[INDEX].GenericHSCode","typeLabel":"string"},"GiftMessage":{"type":"string","description":"Optional “gift message” text defined by the end customer to be printed on the product.","uniqueKey":"productsList.items.[INDEX].GiftMessage","typeLabel":"string"},"HandlingCode":{"type":"string","description":"Code applicable to the product on the Merchant’s site. This code may be optionally used by the Merchant to trigger a certain business logic when this product is included in the order posted back to the Merchant’s site with the SendOrderToMerchant method.","uniqueKey":"productsList.items.[INDEX].HandlingCode","typeLabel":"string"},"Height":{"type":"number","description":"The product’s height in the Merchant’s default unit of length measure (will be converted to CM).","uniqueKey":"productsList.items.[INDEX].Height","typeLabel":"number"},"HubCode":{"type":"string","description":"The Merchant hub code indicates from which hub the product was sent. Note that the HubCode should be mapped to a Global-e hubId on the Global-e side.","uniqueKey":"productsList.items.[INDEX].HubCode","typeLabel":"string"},"ImageHeight":{"type":"number","description":"The product’s image height in pixels","uniqueKey":"productsList.items.[INDEX].ImageHeight","typeLabel":"number"},"ImageURL":{"type":"string","description":"The product’s image URL","uniqueKey":"productsList.items.[INDEX].ImageURL","typeLabel":"string"},"ImageWidth":{"type":"number","description":"The product’s image width in pixels","uniqueKey":"productsList.items.[INDEX].ImageWidth","typeLabel":"number"},"IsBackOrdered":{"type":"boolean","description":"Boolean specifying if the product was ordered as a back ordered item. TRUE - The item is back ordered FALSE - The item is not back ordered. Default FALSE.","uniqueKey":"productsList.items.[INDEX].IsBackOrdered","typeLabel":"boolean"},"IsBlockedForGlobalE":{"type":"boolean","description":"Indicates if product is available for international shipping. TRUE - The product is not available for international shipping FALSE - The product is available for international shipping","uniqueKey":"productsList.items.[INDEX].IsBlockedForGlobalE","typeLabel":"boolean"},"IsBundle":{"type":"boolean","description":"Indicates if the product represents a set of products. TRUE - The product represents a set of other products. If a bundled product has non-zero prices specified (i.e. OriginalListPrice , ListPrice , etc.), then all the contained products must have zero prices, and vice versa, to avoid double charging for the same products. FALSE - The product does not represent a set of other products.","uniqueKey":"productsList.items.[INDEX].IsBundle","typeLabel":"boolean"},"IsFixedPrice":{"type":"boolean","description":"Indicates if the product’s price is fixed by the Merchant, in the default currency for the country. TRUE - The product’s price is fixed. In this case, all price modifications are disabled for this product. Setting fixed prices is only allowed for the Countries where the SupportsFixedPrices flag is set to TRUE. FALSE - The product's price is not fixed.","uniqueKey":"productsList.items.[INDEX].IsFixedPrice","typeLabel":"boolean"},"IsVirtual":{"type":"boolean","description":"Indicates if the product represents a virtual product that does not have weight or volume and doesn’t affect shipping calculation in Global‑e checkout TRUE - The product represents a virtual product FALSE - The product does not represent a virtual product","uniqueKey":"productsList.items.[INDEX].IsVirtual","typeLabel":"boolean"},"Keywords":{"type":"string","description":"The product’s keywords","uniqueKey":"productsList.items.[INDEX].Keywords","typeLabel":"string"},"Length":{"type":"number","description":"The product’s length in the Merchant’s default unit of length measure (will be converted to CM).","uniqueKey":"productsList.items.[INDEX].Length","typeLabel":"number"},"LineItemOriginalSalePrice":{"type":"number","description":"Line item (product in ordered quantity) sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the price in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country. If not specified, will be deemed equal to “ OriginalSalePrice* OrderedQuantity ”. If specified, will take preference over OriginalSalePrice .","uniqueKey":"productsList.items.[INDEX].LineItemOriginalSalePrice","typeLabel":"number"},"LineItemSalePrice":{"type":"number","description":"Line item (product in ordered quantity) sale price as displayed to the customer, after applying country coefficient, FX conversion and IncludeVAT handling, before rounding rules have been applied. If not specified, will be deemed equal to “ SalePrice * OrderedQuantity ”. If specified, will take preference over SalePrice .","uniqueKey":"productsList.items.[INDEX].LineItemSalePrice","typeLabel":"number"},"ListPrice":{"type":"number","description":"Product list price (before discounts) as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling. Optional in SendCart , SaveProductsBulk","uniqueKey":"productsList.items.[INDEX].ListPrice","typeLabel":"number"},"LocalVATRateType":{"type":"object","title":"VATRateType","description":"VAT rate type or class that would be applied to this product 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 VATRateType property actually denotes the VAT for the target country.","properties":{"Name":{"type":"string","description":"VAT rate type name","uniqueKey":"productsList.items.[INDEX].LocalVATRateType.Name","typeLabel":"string"},"Rate":{"type":"number","description":"VAT rate decimal value","uniqueKey":"productsList.items.[INDEX].LocalVATRateType.Rate","typeLabel":"number"},"VATRateTypeCode":{"type":"string","description":"VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)","uniqueKey":"productsList.items.[INDEX].LocalVATRateType.VATRateTypeCode","typeLabel":"string"}},"uniqueKey":"productsList.items.[INDEX].LocalVATRateType","typeLabel":"VATRateType · object"},"MetaData":{"type":"object","title":"ProductMetaData","description":"Used to hold additional product data such as customer-defined product attributes.","properties":{"Attributes":{"type":"array","items":{"type":"object","title":"Attributes","properties":{"AttributeCode":{"type":"string","description":"Custom attribute code denoting a Merchant-specific attribute such as size, color, etc. (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].MetaData.Attributes.items.[INDEX].AttributeCode","typeLabel":"string"},"AttributeTypeCode":{"type":"string","description":"Code used to identify the attribute type on the Merchant’s site such as “size” for size, “color” for \"colour\", etc. (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].MetaData.Attributes.items.[INDEX].AttributeTypeCode","typeLabel":"string"},"Name":{"type":"string","description":"Attribute name","uniqueKey":"productsList.items.[INDEX].MetaData.Attributes.items.[INDEX].Name","typeLabel":"string"}},"uniqueKey":"productsList.items.[INDEX].MetaData.Attributes.items.[INDEX]","typeLabel":"Attributes · object"},"description":"Customer-defined product attributes that allow the personalisation of the product if supported by the merchant’s site (e.g. engraving)","uniqueKey":"productsList.items.[INDEX].MetaData.Attributes","typeLabel":"Attributes · object[]"}},"uniqueKey":"productsList.items.[INDEX].MetaData","typeLabel":"ProductMetaData · object"},"Name":{"type":"string","description":"Name of the Product","uniqueKey":"productsList.items.[INDEX].Name","typeLabel":"string"},"NameEnglish":{"type":"string","description":"Name of the Product in English","uniqueKey":"productsList.items.[INDEX].NameEnglish","typeLabel":"string"},"NetVolume":{"type":"number","description":"The product’s net volume in the Merchant’s default unit of volume measure (will be converted to cubic CM). If specified, this property indicates the net volume of the product, excluding any packaging.","uniqueKey":"productsList.items.[INDEX].NetVolume","typeLabel":"number"},"NetWeight":{"type":"number","description":"The product’s net weight in the Merchant’s default unit of weight measure (will be converted to grams). If specified, this property indicates the net weight of the product, excluding any packaging.","uniqueKey":"productsList.items.[INDEX].NetWeight","typeLabel":"number"},"OrderedQuantity":{"type":"number","description":"Ordered quantity for the product (to be used in Checkout / Order methods described below, as needed)","uniqueKey":"productsList.items.[INDEX].OrderedQuantity","typeLabel":"number"},"OriginalListPrice":{"type":"number","description":"Product list price (before any discounts) in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country. Optional in SendCart , SaveProductsBulk","uniqueKey":"productsList.items.[INDEX].OriginalListPrice","typeLabel":"number"},"OriginalSalePrice":{"type":"number","description":"Product sale price in the original Merchant’s currency including the local VAT, before applying any price modifications. This property always denotes the product’s price in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country. Optional in SaveProductsList , SaveProductsBulk","uniqueKey":"productsList.items.[INDEX].OriginalSalePrice","typeLabel":"number"},"OriginCountryCode":{"type":"string","description":"2-char ISO country code of the product’s country of Origin. The Merchant’s country will be assumed if not specified.","uniqueKey":"productsList.items.[INDEX].OriginCountryCode","typeLabel":"string"},"ParentCartItemId":{"type":"string","description":"Identifier of the current item’s parent cart item on the Merchant’s site. This value must be specified if the current cart item is related to a parent item ( CartItemId must not be specified for this item because this attribute applies only to the “parent” item itself). For example, this item might indicate a custom option (such as a product package) for the parent item in the same cart. This property may be optionally specified in the SendCart method only so that the same value can be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant method.","uniqueKey":"productsList.items.[INDEX].ParentCartItemId","typeLabel":"string"},"PriceCoefficientRate":{"type":"number","description":"Rate applicable to this Product’s ProductClassCode if returned from the CountryCoefficients method.","uniqueKey":"productsList.items.[INDEX].PriceCoefficientRate","typeLabel":"number"},"ProductClassCode":{"type":"string","description":"The product class code is used by the Merchant to classify products to use different country coefficient rates.","uniqueKey":"productsList.items.[INDEX].ProductClassCode","typeLabel":"string"},"ProductCode":{"type":"string","description":"SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].ProductCode","typeLabel":"string"},"ProductCodeSecondary":{"type":"string","description":"Secondary code that may be used to refer to the product on the Merchant’s site. This code may be used in addition to the ProductCode and is not guaranteed to be unique (may be reused for other products as long as the old product is not available on the Merchant’s site any more).","uniqueKey":"productsList.items.[INDEX].ProductCodeSecondary","typeLabel":"string"},"ProductGroupCode":{"type":"string","description":"Product’s group code on the Merchant’s site (to be mapped on the Global‑e side). Usually, this value is a part of the product SKU code denoting a group of similar products (such as \"the same product in different s\").","uniqueKey":"productsList.items.[INDEX].ProductGroupCode","typeLabel":"string"},"ProductGroupCodeSecondary":{"type":"string","description":"Secondary code that may refer to the group of products on the Merchant’s site. This code may be used in addition to the ProductGroupCode and is not guaranteed to be unique (may be reused for other groups as long as the old group is not available on the Merchant’s site anymore).","uniqueKey":"productsList.items.[INDEX].ProductGroupCodeSecondary","typeLabel":"string"},"SalePrice":{"type":"number","description":"Product sale price as displayed to the customer, after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling. Optional in SaveProductsList , SaveProductsBulk , GetCheckoutCartInfo","uniqueKey":"productsList.items.[INDEX].SalePrice","typeLabel":"number"},"SalePriceBeforeRounding":{"type":"number","description":"Product sale price as displayed to the customer, after applying country coefficient, FX conversion and IncludeVAT handling, before rounding rules have been applied. If not specified, will be deemed equal to SalePrice .","uniqueKey":"productsList.items.[INDEX].SalePriceBeforeRounding","typeLabel":"number"},"SalePriceReason":{"type":"string","description":"Reason for the sale price. This property may optionally contain the text definition of the promo that has resulted in the price deduction for this product (such as “10% discount on all shoes”).","uniqueKey":"productsList.items.[INDEX].SalePriceReason","typeLabel":"string"},"URL":{"type":"string","description":"The product’s information page URL","uniqueKey":"productsList.items.[INDEX].URL","typeLabel":"string"},"VATCategory":{"type":"object","title":"VATCategory","description":"The product’s VAT category. A product may be assigned to a single VAT category on the Merchant’s site. If available, the respective product’s HS Code should be used as the VAT category for a product.","properties":{"Name":{"type":"string","description":"VAT Category name","uniqueKey":"productsList.items.[INDEX].VATCategory.Name","typeLabel":"string"},"VATCategoryCode":{"type":"string","description":"Code used to identify the VAT category on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"productsList.items.[INDEX].VATCategory.VATCategoryCode","typeLabel":"string"}},"uniqueKey":"productsList.items.[INDEX].VATCategory","typeLabel":"VATCategory · object"},"VATRateType":{"type":"object","title":"VATRateType","description":"Product’s VAT rate type or class","properties":{"Name":{"type":"string","description":"VAT rate type name","uniqueKey":"productsList.items.[INDEX].VATRateType.Name","typeLabel":"string"},"Rate":{"type":"number","description":"VAT rate decimal value","uniqueKey":"productsList.items.[INDEX].VATRateType.Rate","typeLabel":"number"},"VATRateTypeCode":{"type":"string","description":"VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)","uniqueKey":"productsList.items.[INDEX].VATRateType.VATRateTypeCode","typeLabel":"string"}},"uniqueKey":"productsList.items.[INDEX].VATRateType","typeLabel":"VATRateType · object"},"Volume":{"type":"number","description":"The product’s volume in the Merchant’s default unit of volume measure (will be converted to cubic CM). Optional, can be used as an alternative for specifying all Height, Width and Length dimensions","uniqueKey":"productsList.items.[INDEX].Volume","typeLabel":"number"},"Weight":{"type":"number","description":"The product’s weight is in the Merchant’s default unit of weight measure (will be converted to grams). The Merchant’s default product weight will be used if not specified.","uniqueKey":"productsList.items.[INDEX].Weight","typeLabel":"number"},"Width":{"type":"number","description":"The product’s width in the Merchant’s default unit of length measure (will be converted to CM).","uniqueKey":"productsList.items.[INDEX].Width","typeLabel":"number"}},"example":[{"ProductCode":"1020872","Name":"Lanolin","Description":"Breast%20Feeding%20Ointment","GenericHSCode":"","OriginCountryCode":"","Weight":"1.0000","Height":null,"Length":null,"Volume":"60","ImageURL":"/a/3/a3c9ef_ece3bec0467310603bce72e9a58e33d3.jpg","ImageHeight":"","ImageWidth":"","ListPrice":"25.0000","OriginalListPrice":"17.7000","SalePrice":"15.0000","OriginalSalePrice":"17.7000","VATRateType":{"VATRateTypeCode":1,"Name":"Low","Rate":"18.0000"},"Brand":{"BrandCode":"7","Name":"Brand2"},"Categories":[{"CategoryCode":"3","Name":"Maternity"}],"OrderedQuantity":1}],"uniqueKey":"productsList.items.[INDEX]","typeLabel":"Product · object"},"description":"List of Product objects (specified in the request body)","isRequired":true,"uniqueKey":"productsList","typeLabel":"Product · object[]"},"allowMailsFromMerchant":{"type":"boolean","description":"Indicates if the end customer’s consent to receive emails from merchants should be pre-selected in the Global‑e Checkout. TRUE - Customer consents to receive emails. FALSE - Customer does not consent to receive emails.","uniqueKey":"allowMailsFromMerchant","typeLabel":"boolean"},"billingDetails":{"type":"object","title":"UserDetails","description":"Billing details of a registered user (if available on the Merchant’s site). If the userDetails property mentioned below is specified, then billingDetails will be ignored.","properties":{"Address1":{"type":"string","description":"Address line 1","uniqueKey":"billingDetails.Address1","typeLabel":"string"},"Address2":{"type":"string","description":"Address line 2","uniqueKey":"billingDetails.Address2","typeLabel":"string"},"City":{"type":"string","description":"City name","uniqueKey":"billingDetails.City","typeLabel":"string"},"Company":{"type":"string","description":"Company name","uniqueKey":"billingDetails.Company","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code","uniqueKey":"billingDetails.CountryCode","typeLabel":"string"},"CountryName":{"type":"string","description":"Country name","uniqueKey":"billingDetails.CountryName","typeLabel":"string"},"Email":{"type":"string","description":"E-mail address","uniqueKey":"billingDetails.Email","typeLabel":"string"},"Fax":{"type":"string","description":"Fax","uniqueKey":"billingDetails.Fax","typeLabel":"string"},"FirstName":{"type":"string","description":"First name","uniqueKey":"billingDetails.FirstName","typeLabel":"string"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture Ex: Kana Japanese dialect","uniqueKey":"billingDetails.FirstNameInLocalCulture","typeLabel":"string"},"LastName":{"type":"string","description":"Last name","uniqueKey":"billingDetails.LastName","typeLabel":"string"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture Ex: Kana Japanese dialect","uniqueKey":"billingDetails.LastNameInLocalCulture","typeLabel":"string"},"MiddleName":{"type":"string","description":"Middle name","uniqueKey":"billingDetails.MiddleName","typeLabel":"string"},"Phone1":{"type":"string","description":"Phone","uniqueKey":"billingDetails.Phone1","typeLabel":"string"},"Phone2":{"type":"string","description":"Phone","uniqueKey":"billingDetails.Phone2","typeLabel":"string"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)","uniqueKey":"billingDetails.Salutation","typeLabel":"string"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)","uniqueKey":"billingDetails.StateCode","typeLabel":"string"},"StateOrProvice":{"type":"string","description":"State or province name","uniqueKey":"billingDetails.StateOrProvice","typeLabel":"string"},"UserId":{"type":"string","description":"Internal User identifier on the Merchant site","uniqueKey":"billingDetails.UserId","typeLabel":"string"},"UserIdNumber":{"type":"string","description":"User’s personal ID document number","uniqueKey":"billingDetails.UserIdNumber","typeLabel":"string"},"UserIdNumberType":{"type":"object","title":"UserIdNumberType","description":"User’s personal ID document type (e.g. Passport, ID card, etc.)","properties":{"Name":{"type":"string","description":"Identification document type name","uniqueKey":"billingDetails.UserIdNumberType.Name","typeLabel":"string"},"UserIdNumberTypeCode":{"type":"string","description":"Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"billingDetails.UserIdNumberType.UserIdNumberTypeCode","typeLabel":"string"}},"uniqueKey":"billingDetails.UserIdNumberType","typeLabel":"UserIdNumberType · object"},"Zip":{"type":"string","description":"Zip or postal code","uniqueKey":"billingDetails.Zip","typeLabel":"string"}},"uniqueKey":"billingDetails","typeLabel":"UserDetails · object"},"clientIP":{"type":"string","description":"The end customer’s IP address","uniqueKey":"clientIP","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code of the shipping country either pre-defined using geo-location or actively selected by the end customer. This may be different from shippingDetails.CountryCode denoting the registered user’s country.","uniqueKey":"CountryCode","typeLabel":"string"},"cultureCode":{"type":"string","description":"ISO culture code. If specified, the textual properties will be returned in the requested culture’s language if available. Texts in English will be returned by default.","uniqueKey":"cultureCode","typeLabel":"string"},"currencyCode":{"type":"string","description":"3-char ISO currency code denoting the end customer’s currency. If not specified, the Merchant’s default currency will be assumed by default.","uniqueKey":"currencyCode","typeLabel":"string"},"discountList":{"type":"array","items":{"type":"object","title":"Discounts","required":["OriginalDiscountValue","CalculationMode"],"properties":{"OriginalDiscountValue":{"type":"number","description":"Discount value in the currency defined in the CurrencyCode ; property of the Merchant.Order ; object for the order being submitted to the Merchant.","isRequired":true,"uniqueKey":"discountList.items.[INDEX].OriginalDiscountValue","typeLabel":"number"},"CalculationMode":{"type":"integer","description":"The mode of calculation: 1 - value in base currency while maintaining ratio to domestic discount 2 - fixed amount in base currency 3 - fixed amount in shopper currency (used for fixed price markets only)","isRequired":true,"uniqueKey":"discountList.items.[INDEX].CalculationMode","typeLabel":"integer"},"CouponCode":{"type":"string","description":"Merchant Coupon Code used for this discount (applicable to coupon-based discounts only). Max length: 100 chars.","uniqueKey":"discountList.items.[INDEX].CouponCode","typeLabel":"string"},"Description":{"type":"string","description":"Discount textual description. Length: Unlimited.","uniqueKey":"discountList.items.[INDEX].Description","typeLabel":"string"},"DiscountType":{"type":"integer","description":"One of the following possible values of DiscountTypeOptions enumeration denoting a type of discount: Cart discount - 1 Shipping discount - 2 Loyalty points discount - 3 Duties discount - 4 Checkout Loyalty points discount - 5 Payment charge - 6","uniqueKey":"discountList.items.[INDEX].DiscountType","typeLabel":"integer"},"DiscountValue":{"type":"number","description":"Discount value in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the Merchant.Order , after applying country coefficient, FX conversion, and IncludeVAT.","uniqueKey":"discountList.items.[INDEX].DiscountValue","typeLabel":"number"},"Name":{"type":"string","description":"Discount name. Length: Unlimited.","uniqueKey":"discountList.items.[INDEX].Name","typeLabel":"string"},"VATRate":{"type":"number","description":"The VAT rate applied to this discount","uniqueKey":"discountList.items.[INDEX].VATRate","typeLabel":"number"},"ProductCartItemId":{"type":"string","description":"For product level discount, match the unique CartItemId line identifier of the respective product in the productList. For cart level discounts, leave this field blank or null.","uniqueKey":"discountList.items.[INDEX].ProductCartItemId","typeLabel":"string"}},"uniqueKey":"discountList.items.[INDEX]","typeLabel":"Discounts · object"},"description":"List of JSON-serialized Discounts to be applied to the cart. Discounts of any type (“cart”, “shipping”, etc.) may be specified.","uniqueKey":"discountList","typeLabel":"Discounts · object[]"},"doNotChargeVAT":{"type":"boolean","description":"Indicates if the end customer must not be charged VAT. This is usually set to TRUE for registered users who have validated their business entity’s VAT Registration Number with the merchant and are therefore VAT exempted.","uniqueKey":"doNotChargeVAT","typeLabel":"boolean"},"freeShippingCouponCode":{"type":"string","description":"Merchant’s free shipping coupon code applied by the end customer. Max length: 50.","uniqueKey":"freeShippingCouponCode","typeLabel":"string"},"hubID":{"type":"number","description":"Identifier of the Global‑e’s Local Hub previously returned by API. If not specified, the default Merchant’s Hub will be used instead.","uniqueKey":"hubID","typeLabel":"number"},"IncludeVAT":{"type":"number","description":"Optional for the merchants not supporting browsing integration. The value is returned from CountryCoefficients API.","uniqueKey":"IncludeVAT","typeLabel":"number"},"isFreeShipping":{"type":"boolean","description":"Indicates if the Merchant offers free international shipping to the end customer.","uniqueKey":"isFreeShipping","typeLabel":"boolean"},"loyaltyCode":{"type":"string","description":"The loyalty code specified by the end customer (or read from the end customer’s account) on the Merchant’s site.","uniqueKey":"loyaltyCode","typeLabel":"string"},"LoyaltyPoints":{"type":"object","title":"LoyaltyPoints","description":"LoyaltyPoints contains data about the registered user for applying loyalty points on the Checkout page.","properties":{"LoyaltyPointsMaxSpend":{"type":"number","description":"The limit loyalty points that the user can use in this order – if not exists the LoyaltyPointsTotal is taken.","uniqueKey":"LoyaltyPoints.LoyaltyPointsMaxSpend","typeLabel":"number"},"LoyaltyPointsOriginalValueForEarn":{"type":"number","description":"Value of one loyalty point for earn, in Merchant currency – optional if LoyaltyPointsOriginalForEarn exists.","uniqueKey":"LoyaltyPoints.LoyaltyPointsOriginalValueForEarn","typeLabel":"number"},"LoyaltyPointsOriginalValueForSpend":{"type":"number","description":"Value of one loyalty point for spending, in Merchant currency – optional if LoyaltyPointsValueForSpend exists.","uniqueKey":"LoyaltyPoints.LoyaltyPointsOriginalValueForSpend","typeLabel":"number"},"LoyaltyPointsTotal":{"type":"number","description":"The total loyalty points the user has on account at the Merchant’s site","uniqueKey":"LoyaltyPoints.LoyaltyPointsTotal","typeLabel":"number"},"LoyaltyPointsValueForEarn":{"type":"number","description":"Value of one loyalty point for earn, in customer currency – optional if LoyaltyPointsOriginalValueForEarn exists.","uniqueKey":"LoyaltyPoints.LoyaltyPointsValueForEarn","typeLabel":"number"},"LoyaltyPointsValueForSpend":{"type":"number","description":"Value of one loyalty point for spending, in customer currency – optional if LoyaltyPointsOriginalValueForSpend exists.","uniqueKey":"LoyaltyPoints.LoyaltyPointsValueForSpend","typeLabel":"number"}},"uniqueKey":"LoyaltyPoints","typeLabel":"LoyaltyPoints · object"},"loyaltyPointsEarned":{"type":"number","description":"The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site.","uniqueKey":"loyaltyPointsEarned","typeLabel":"number"},"loyaltyPointsSpent":{"type":"number","description":"The number of loyalty points to be spent for this purchase by the end customer on the Merchant’s site.","uniqueKey":"loyaltyPointsSpent","typeLabel":"number"},"loyaltyPointsTotal":{"type":"number","description":"The total number of loyalty points currently available in the end customer’s user account on the Merchant’s site.","uniqueKey":"loyaltyPointsTotal","typeLabel":"number"},"merchantCartHash":{"type":"string","description":"A hash may be optionally generated by the merchant and returned to the merchant with an order API call. This hash may be used for additional cart and order validation purposes on the Merchant’s side. No max length.","uniqueKey":"merchantCartHash","typeLabel":"string"},"MerchantOrderId":{"type":"string","description":"The merchant order id, if it is already known, at the point when the user is still in the cart page on the merchant’s store.","uniqueKey":"MerchantOrderId","typeLabel":"string"},"originalCurrencyCode":{"type":"string","description":"3-char ISO currency code denoting the original currency on the Merchant’s site (before applying country coefficient and FX conversion). If not specified, the Merchant’s default currency will be assumed by default.","uniqueKey":"originalCurrencyCode","typeLabel":"string"},"otVoucherAmount":{"type":"number","description":"Amount of the one-time voucher in otVoucherCurrencyCode currency.","uniqueKey":"otVoucherAmount","typeLabel":"number"},"otVoucherCode":{"type":"string","description":"One-time voucher code for the cart (for applicable platforms).","uniqueKey":"otVoucherCode","typeLabel":"string"},"otVoucherCurrencyCode":{"type":"string","description":"One-time voucher currency used for the amount.","uniqueKey":"otVoucherCurrencyCode","typeLabel":"string"},"paymentInstallments":{"type":"string","description":"List of available payment instalment amounts. For example: {2,4,6,8} – This indicates that we should allow instalments in 2, 4, 6 or 8 instalment options (to be selected by the customer).","uniqueKey":"paymentInstallments","typeLabel":"string"},"rateData":{"type":"string","description":"Currency data is used by Global-e to verify the currency rate and to return the value received in the used currency rate. Optional, irrelevant for GetCheckoutCartInfo API response","uniqueKey":"rateData","typeLabel":"string"},"shippingDetails":{"type":"object","title":"UserDetails","description":"Shipping details of a registered user (if available on the Merchant’s site). If the userDetails property is specified, then the shippingDetails will be ignored. If countryCode is not specified, the shipping country must be specified in shippingDetails.CountryCode property. If not specified neither in the countryCode argument nor in shippingDetails.CountryCode property, clientIP argument defined above becomes mandatory and will be used to determine the end user’s shipping country by Global‑e system.","properties":{"Address1":{"type":"string","description":"Address line 1","uniqueKey":"shippingDetails.Address1","typeLabel":"string"},"Address2":{"type":"string","description":"Address line 2","uniqueKey":"shippingDetails.Address2","typeLabel":"string"},"City":{"type":"string","description":"City name","uniqueKey":"shippingDetails.City","typeLabel":"string"},"Company":{"type":"string","description":"Company name","uniqueKey":"shippingDetails.Company","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code","uniqueKey":"shippingDetails.CountryCode","typeLabel":"string"},"CountryName":{"type":"string","description":"Country name","uniqueKey":"shippingDetails.CountryName","typeLabel":"string"},"Email":{"type":"string","description":"E-mail address","uniqueKey":"shippingDetails.Email","typeLabel":"string"},"Fax":{"type":"string","description":"Fax","uniqueKey":"shippingDetails.Fax","typeLabel":"string"},"FirstName":{"type":"string","description":"First name","uniqueKey":"shippingDetails.FirstName","typeLabel":"string"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture Ex: Kana Japanese dialect","uniqueKey":"shippingDetails.FirstNameInLocalCulture","typeLabel":"string"},"LastName":{"type":"string","description":"Last name","uniqueKey":"shippingDetails.LastName","typeLabel":"string"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture Ex: Kana Japanese dialect","uniqueKey":"shippingDetails.LastNameInLocalCulture","typeLabel":"string"},"MiddleName":{"type":"string","description":"Middle name","uniqueKey":"shippingDetails.MiddleName","typeLabel":"string"},"Phone1":{"type":"string","description":"Phone","uniqueKey":"shippingDetails.Phone1","typeLabel":"string"},"Phone2":{"type":"string","description":"Phone","uniqueKey":"shippingDetails.Phone2","typeLabel":"string"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.)","uniqueKey":"shippingDetails.Salutation","typeLabel":"string"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)","uniqueKey":"shippingDetails.StateCode","typeLabel":"string"},"StateOrProvice":{"type":"string","description":"State or province name","uniqueKey":"shippingDetails.StateOrProvice","typeLabel":"string"},"UserId":{"type":"string","description":"Internal User identifier on the Merchant site","uniqueKey":"shippingDetails.UserId","typeLabel":"string"},"UserIdNumber":{"type":"string","description":"User’s personal ID document number","uniqueKey":"shippingDetails.UserIdNumber","typeLabel":"string"},"UserIdNumberType":{"type":"object","title":"UserIdNumberType","description":"User’s personal ID document type (e.g. Passport, ID card, etc.)","properties":{"Name":{"type":"string","description":"Identification document type name","uniqueKey":"shippingDetails.UserIdNumberType.Name","typeLabel":"string"},"UserIdNumberTypeCode":{"type":"string","description":"Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"shippingDetails.UserIdNumberType.UserIdNumberTypeCode","typeLabel":"string"}},"uniqueKey":"shippingDetails.UserIdNumberType","typeLabel":"UserIdNumberType · object"},"Zip":{"type":"string","description":"Zip or postal code","uniqueKey":"shippingDetails.Zip","typeLabel":"string"}},"uniqueKey":"shippingDetails","typeLabel":"UserDetails · object"},"shippingOptionsList":{"type":"array","items":{"type":"object","title":"ShippingOption","properties":{"Carrier":{"type":"string","description":"Carrier’s short name","uniqueKey":"shippingOptionsList.items.[INDEX].Carrier","typeLabel":"string"},"CarrierName":{"type":"string","description":"Carrier’s full name","uniqueKey":"shippingOptionsList.items.[INDEX].CarrierName","typeLabel":"string"},"CarrierTitle":{"type":"string","description":"Carrier’s title","uniqueKey":"shippingOptionsList.items.[INDEX].CarrierTitle","typeLabel":"string"},"Code":{"type":"string","description":"Shipping method code used to identify the shipping option on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"shippingOptionsList.items.[INDEX].Code","typeLabel":"string"},"Method":{"type":"string","description":"Shipping method name","uniqueKey":"shippingOptionsList.items.[INDEX].Method","typeLabel":"string"},"MethodTitle":{"type":"string","description":"Shipping method title","uniqueKey":"shippingOptionsList.items.[INDEX].MethodTitle","typeLabel":"string"},"MethodDescription":{"type":"string","description":"Shipping method description","uniqueKey":"shippingOptionsList.items.[INDEX].MethodDescription","typeLabel":"string"},"Price":{"type":"number","description":"Shipping price in Merchant’s original currency defined in the originalCurrencyCode argument of the respective method call (i.e. SendCart )","uniqueKey":"shippingOptionsList.items.[INDEX].Price","typeLabel":"number"}},"uniqueKey":"shippingOptionsList.items.[INDEX]","typeLabel":"ShippingOption · object"},"description":"List of JSON-serialized Shipping Options available for local shipping of the order from the Merchant to Global‑e’s Local Hub previously returned by ActiveHubDetails API. If the Global-e integration shipping API has been created and enabled for Global‑e on the Merchant’s site, Global‑e will prefer this Shipping Option when posting the order back to the Merchant’s site (using SendOrderToMerchant API). Therefore, all other shipping APIs available for local shipping may be omitted in shippingOptionsList .","uniqueKey":"shippingOptionsList","typeLabel":"ShippingOption · object[]"},"urlParameters":{"type":"array","items":{"type":"object","title":"KeyValuePair","properties":{"Key":{"type":"string","description":"Entity key (for example a URL parameter) used on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"urlParameters.items.[INDEX].Key","typeLabel":"string"},"Value":{"type":"string","description":"Entity value for the respective Key","uniqueKey":"urlParameters.items.[INDEX].Value","typeLabel":"string"}},"uniqueKey":"urlParameters.items.[INDEX]","typeLabel":"KeyValuePair · object"},"description":"List of JSON-serialized Key:Value pairs denoting the values of the parameters specified in the respective Merchant’s REST API action URLs. For example, to instruct Global‑e to include “en-AU” locale in the SendOrderToMerchant call for this cart, urlParameters should include the following KeyValuePair: [{\"Key\":\"locale\", \"Value\":\"en-AU\"}] . In this example “locale” parameter should be configured for SendOrderToMerchant URL for this merchant on the Global‑e side.","uniqueKey":"urlParameters","typeLabel":"KeyValuePair · object[]"},"userDetails":{"type":"object","title":"CartUserDetails","description":"All available details of the user including all relevant addresses. If userDetails is not specified, then shippingDetails and billingDetails properties will be used instead. userDetails property can be used by merchants who support multiple shipping and/or multiple billing addresses in the user’s account.","properties":{"AddressDetails":{"type":"array","items":{"type":"object","title":"AddressDetails","properties":{"Address1":{"type":"string","description":"Address line 1.","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Address1","typeLabel":"string"},"Address2":{"type":"string","description":"Address line 2.","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Address2","typeLabel":"string"},"AddressBookId":{"type":"string","description":"Id of the current address from within the address book","uniqueKey":"userDetails.AddressDetails.items.[INDEX].AddressBookId","typeLabel":"string"},"AddressBookName":{"type":"string","description":"Name of the current address from within the address book","uniqueKey":"userDetails.AddressDetails.items.[INDEX].AddressBookName","typeLabel":"string"},"City":{"type":"string","description":"City name.","uniqueKey":"userDetails.AddressDetails.items.[INDEX].City","typeLabel":"string"},"Company":{"type":"string","description":"Company name","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Company","typeLabel":"string"},"CountryCode":{"type":"string","description":"2-char ISO country code","uniqueKey":"userDetails.AddressDetails.items.[INDEX].CountryCode","typeLabel":"string"},"Email":{"type":"string","description":"E-mail address","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Email","typeLabel":"string"},"Fax":{"type":"string","description":"Fax","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Fax","typeLabel":"string"},"FirstName":{"type":"string","description":"First name","uniqueKey":"userDetails.AddressDetails.items.[INDEX].FirstName","typeLabel":"string"},"FirstNameInLocalCulture":{"type":"string","description":"First name in local culture","uniqueKey":"userDetails.AddressDetails.items.[INDEX].FirstNameInLocalCulture","typeLabel":"string"},"IsBilling":{"type":"boolean","description":"Indicates that the current address can be used as a billing address","uniqueKey":"userDetails.AddressDetails.items.[INDEX].IsBilling","typeLabel":"boolean"},"IsDefaultBilling":{"type":"boolean","description":"Indicates that the current address is the default billing address","uniqueKey":"userDetails.AddressDetails.items.[INDEX].IsDefaultBilling","typeLabel":"boolean"},"IsDefaultShipping":{"type":"boolean","description":"Indicates that the current address is the default shipping address","uniqueKey":"userDetails.AddressDetails.items.[INDEX].IsDefaultShipping","typeLabel":"boolean"},"IsShipping":{"type":"boolean","description":"Indicates that the current address can be used as a shipping address","uniqueKey":"userDetails.AddressDetails.items.[INDEX].IsShipping","typeLabel":"boolean"},"LastName":{"type":"string","description":"Last name","uniqueKey":"userDetails.AddressDetails.items.[INDEX].LastName","typeLabel":"string"},"LastNameInLocalCulture":{"type":"string","description":"Last name in local culture","uniqueKey":"userDetails.AddressDetails.items.[INDEX].LastNameInLocalCulture","typeLabel":"string"},"MiddleName":{"type":"string","description":"Middle name","uniqueKey":"userDetails.AddressDetails.items.[INDEX].MiddleName","typeLabel":"string"},"Phone1":{"type":"string","description":"Phone","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Phone1","typeLabel":"string"},"Phone2":{"type":"string","description":"Phone","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Phone2","typeLabel":"string"},"Salutation":{"type":"string","description":"Salutation or title (e.g. Dr., Mr., etc.).","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Salutation","typeLabel":"string"},"StateCode":{"type":"string","description":"State or province ISO code such as AZ for Arizona (if applicable)","uniqueKey":"userDetails.AddressDetails.items.[INDEX].StateCode","typeLabel":"string"},"StateOrProvince":{"type":"string","description":"State or province name","uniqueKey":"userDetails.AddressDetails.items.[INDEX].StateOrProvince","typeLabel":"string"},"UserIdNumber":{"type":"string","description":"User’s personal ID document number","uniqueKey":"userDetails.AddressDetails.items.[INDEX].UserIdNumber","typeLabel":"string"},"UserIdNumberType":{"type":"object","title":"UserIdNumberType","description":"User’s personal ID document type (e.g. Passport, ID card, etc.)","properties":{"Name":{"type":"string","description":"Identification document type name","uniqueKey":"userDetails.AddressDetails.items.[INDEX].UserIdNumberType.Name","typeLabel":"string"},"UserIdNumberTypeCode":{"type":"string","description":"Code denoting a user identification document type (e.g. Passport, ID card, etc.) on the Merchant’s site (to be mapped on the Global‑e side)","uniqueKey":"userDetails.AddressDetails.items.[INDEX].UserIdNumberType.UserIdNumberTypeCode","typeLabel":"string"}},"uniqueKey":"userDetails.AddressDetails.items.[INDEX].UserIdNumberType","typeLabel":"UserIdNumberType · object"},"Zip":{"type":"string","description":"Zip or postal code","uniqueKey":"userDetails.AddressDetails.items.[INDEX].Zip","typeLabel":"string"}},"uniqueKey":"userDetails.AddressDetails.items.[INDEX]","typeLabel":"AddressDetails · object"},"description":"All available addresses are taken from the registered customer address book","uniqueKey":"userDetails.AddressDetails","typeLabel":"AddressDetails · object[]"},"UserId":{"type":"string","description":"Internal User identifier on the Merchant’s site","uniqueKey":"userDetails.UserId","typeLabel":"string"}},"uniqueKey":"userDetails","typeLabel":"CartUserDetails · object"},"vatRegistrationNumber":{"type":"string","description":"VAT Registration Number of the end customer’s business entity validated with the merchant.","uniqueKey":"vatRegistrationNumber","typeLabel":"string"},"webStoreCode":{"type":"string","description":"Code used on the merchant’s side to identify the web store where the current cart is originating. This code should be used when a multi-store setup is on the merchant’s site. Max length: 100","uniqueKey":"webStoreCode","typeLabel":"string"},"webStoreInstanceCode":{"type":"string","description":"Code used on the merchant’s side to identify the web store instance where the current cart is originating from. This code should be used in case of multi-store domains set up on the merchant’s site.","uniqueKey":"webStoreInstanceCode","typeLabel":"string"}},"isRequired":false,"description":"Full cart information. Either cartToken or checkoutCartInfo must be specified.","uniqueKey":"","typeLabel":"CheckoutCartInfo · object"}}},"responses":{"3af24764-2ac1-4222-abc3-513d048e2eb0":{"description":"List of shipping options.","content":{"application/json":{"schema":{"type":"object","properties":{"CheckoutShippingOption":{"type":"array","description":"List of shipping options","items":{"type":"object","title":"CheckoutShippingOption","properties":{"DeliveryDaysFrom":{"type":"number","description":"Minimum number of days for delivery to the end customer’s shipping country for this shipping option","uniqueKey":"CheckoutShippingOption.items.[INDEX].DeliveryDaysFrom","typeLabel":"number"},"DeliveryDaysTo":{"type":"number","description":"Maximum number of delivery days to the end customer’s shipping country for this shipping option","uniqueKey":"CheckoutShippingOption.items.[INDEX].DeliveryDaysTo","typeLabel":"number"},"ForceDDP":{"type":"number","enum":[0,1,2],"description":"One of the possible values of ForceDDPTypes enumeration denoting a type of DDP enforcement for this shipping option (applicable only if SupportsDDP is set to TRUE) as listed in the table below.","uniqueKey":"CheckoutShippingOption.items.[INDEX].ForceDDP","typeLabel":"enum\u003cnumber>"},"Price":{"type":"number","description":"Shipping price in end customer currency for this cart","uniqueKey":"CheckoutShippingOption.items.[INDEX].Price","typeLabel":"number"},"PriceBeforeDiscount":{"type":"number","description":"Shipping price in end customer currency for this cart, before applying shipping discounts","uniqueKey":"CheckoutShippingOption.items.[INDEX].PriceBeforeDiscount","typeLabel":"number"},"ShippingMethodId":{"type":"string","description":"Unique identifier of the shipping method in the Global-e system","uniqueKey":"CheckoutShippingOption.items.[INDEX].ShippingMethodId","typeLabel":"string"},"ShippingMethodTypeName":{"type":"string","description":"Shipping method type name","uniqueKey":"CheckoutShippingOption.items.[INDEX].ShippingMethodTypeName","typeLabel":"string"},"SupportsDDP":{"type":"boolean","description":"Indicates if taxes \u0026 duties may be prepaid for this shipping option","uniqueKey":"CheckoutShippingOption.items.[INDEX].SupportsDDP","typeLabel":"boolean"}},"uniqueKey":"CheckoutShippingOption.items.[INDEX]","typeLabel":"CheckoutShippingOption · object"},"uniqueKey":"CheckoutShippingOption","typeLabel":"CheckoutShippingOption · object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"CheckoutShippingOption":[{"DeliveryDaysFrom":123,"DeliveryDaysTo":123,"ForceDDP":0,"Price":123,"PriceBeforeDiscount":123,"ShippingMethodId":"\u003cstring>","ShippingMethodTypeName":"\u003cstring>","SupportsDDP":true}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"5b0e9afe-ee28-4492-abb0-6cb4de478e0c":{"url":"https://{globale_api_domain}","variables":{"globale_api_domain":{"default":"globale_api_domain","description":"Global-e API host, supplied to the merchant by Global-e."}}}}},"originalFileLocation":"api-reference/specs/shippingoptions.yaml"},"subdomain":"globale-enterprise","siteName":"Global-e Docs","title":"Shipping Options (Merchant to Global-e) - Global-e Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-13T17:10:59.294Z","originalFileLocation":"api-reference/shipping-options.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=\"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.\">\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=\"Shipping Options (Merchant to Global-e) - Global-e Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.\">\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/shipping-options\">\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=Browsing+%26+Catalog\u0026amp;title=Shipping+Options+%28Merchant+to+Global-e%29\u0026amp;description=Returns+all+available+shipping+options+for+a+cart%2C+specified+by+cartToken+or+by+full+checkoutCartInfo+details.\u0026amp;theme=ba448c405b24dd48494124de\u0026amp;signature=eb0d4fc53e17a01f34514ca9835d2bf61193cb3e812865fb2496c0c095e24c85\">\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=\"Shipping Options (Merchant to Global-e) - Global-e Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://globale-enterprise.mintlify.app/_mintlify/api/og/v2?division=Browsing+%26+Catalog\u0026amp;title=Shipping+Options+%28Merchant+to+Global-e%29\u0026amp;description=Returns+all+available+shipping+options+for+a+cart%2C+specified+by+cartToken+or+by+full+checkoutCartInfo+details.\u0026amp;theme=ba448c405b24dd48494124de\u0026amp;signature=eb0d4fc53e17a01f34514ca9835d2bf61193cb3e812865fb2496c0c095e24c85\">\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/shipping-options\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/shipping-options.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/shipping-options#webpage\",\"url\":\"https://docs.global-e.com/api-reference/shipping-options\",\"name\":\"Shipping Options (Merchant to Global-e)\",\"description\":\"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.\",\"dateModified\":\"2026-09-13T17:10:59.294Z\",\"isPartOf\":{\"@id\":\"https://docs.global-e.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.global-e.com/api-reference/shipping-options#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.global-e.com/api-reference/shipping-options#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Browsing \u0026 Catalog\",\"item\":\"https://docs.global-e.com/api-reference/active-hub-details\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Shipping Options (Merchant to Global-e)\",\"item\":\"https://docs.global-e.com/api-reference/shipping-options\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.global-e.com/api-reference/shipping-options#apireference\",\"headline\":\"Shipping Options (Merchant to Global-e)\",\"name\":\"Shipping Options (Merchant to Global-e)\",\"description\":\"Returns all available shipping options for a cart, specified by cartToken or by full checkoutCartInfo details.\",\"url\":\"https://docs.global-e.com/api-reference/shipping-options\",\"mainEntityOfPage\":{\"@id\":\"https://docs.global-e.com/api-reference/shipping-options#webpage\"},\"dateModified\":\"2026-09-13T17:10:59.294Z\",\"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","description":"Saves product data on the Global-e system, called from a Merchant's ERP before publishing, for early duties and taxes calculation.","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","description":"Returns the list of VATCategoryCountry objects for a set of specified VAT categories.","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","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","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":"Shipping Options (Merchant to Global-e) - 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"]}