> ## Documentation Index > Fetch the complete documentation index at: https://enterprise-docs.bglobale.com/llms.txt > Use this file to discover all available pages before exploring further. # Quote order changes > Preview the updated order content and prices for a change without applying it. Returns the updated order **without** changing it. Call [Edit order](/api-reference/edit-order) with the same request to apply the change. See the [Edit Order integration guide](/edit-order) for details. ## OpenAPI ````yaml api-reference/specs/editorder.yaml POST /api/orders/changes/quote openapi: 3.0.3 info: title: EditOrder version: 1.0.0 description: >- Change an existing Global-e order by adding, exchanging, or removing products. The API exposes two URLs with an identical request/response structure: a quote URL that returns the updated order content and prices without changing the order, and an editing URL that applies the change. servers: - 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. security: [] tags: - name: EditOrder x-page-title: EditOrder - name: 'Direction: Merchant → Global-e' - name: 'Domain: Orders' paths: /api/orders/changes/quote: post: tags: - EditOrder summary: Quote order changes description: >- Returns the updated order content and prices for the requested changes WITHOUT changing the order. Call the editing endpoint with the same request to apply the changes. operationId: editOrderQuote requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OrderChangeRequest' example: OrderId: GE379858112TS RemovedProducts: - cartItemId: '1' quantity: 1 NewProducts: - ProductCode: 750518703039M CartItemId: '2' OrderedQuantity: 1 OriginalSalePrice: 125.12 ReplacementOfCartItemId: '1' SubsidizeHigherValue: 0 responses: '200': description: The updated Merchant.Order object (quote — order not changed). content: application/json: schema: $ref: '#/components/schemas/MerchantOrder' example: OrderId: GE379858112TS CurrencyCode: GBP Products: - Sku: 750518703039M CartItemId: '2' ParentCartItemId: null Quantity: 1 Price: 125.12 InternationalPrice: 160 DiscountedPrice: 125.12 InternationalDiscountedPrice: 160 Discounts: - Name: Hidden DDP Description: Discount generated to discount the DDP Price: 8 InternationalPrice: 10 ProductCartItemId: null TotalDutiesAndTaxesPrice: 79.83 USSalesTax: 0 CCFPrice: 12.4 TotalDutiesPaidByCustomerPrice: 0 InternationalDetails: CurrencyCode: EUR TotalPrice: 160 TransactionCurrencyCode: EUR TransactionTotalPrice: 160 TotalShippingPrice: 0 TotalCCFPrice: 14.79 TotalDutiesPrice: 0 USSalesTax: 0 DutiesGuaranteed: true ConsignmentFee: 0 DiscountedShippingPrice: 0 '400': description: >- Bad Request. Documented cases: OrderId not found ("Order {{OrderId}} not found."); OrderId null/empty ("OrderId is not provided."); RemovedProduct CartItemId null/empty ("RemovedProduct CartItemId should be provided."); RemovedProduct CartItemId not found ("RemovedProduct with CartItemId {{CartItemId}} not found in order {{OrderId}}."); RemovedProduct Quantity null/empty/<1 ("RemovedProduct Quantity should be greater than 0 for CartItemId {{CartItemId}}."); RemovedProduct Quantity > OrderProduct quantity ("RemovedProduct Quantity should be less or equal to {{OrderProduct.Quantity}} for CartItemId {{CartItemId}}."); NewProducts null/empty ("At least one product in NewProducts list should be provided."); NewProduct CartItemId null/empty ("NewProduct CartItemId should be provided."); NewProduct CartItemId not unique ("NewProduct with CartItemId {CartItemId} already exists for this order."); NewProduct ReplacementOfCartItemId not valid ("NewProduct with CartItemId {{CartItemId}} specifies ReplacementOfCartItemId {{ReplacementOfCartItemId}} that is missing from the RemovedProducts collection."); NewProduct ReplacementOfCartItemId not found in order ("ReplacementOfCartItemId {ReplacementOfCartItemId} of NewProduct with CartItemId {CartItemId} not found in the order."); NewProduct ProductCode null/empty ("NewProduct ProductCode should be provided for CartItemId {{CartItemId}}."); NewProduct Quantity null/empty/<1 ("NewProduct Quantity should be greater than 0 for CartItemId {{CartItemId}}."); NewProduct SalePrice or OriginalSalePrice not specified or negative ("One of the NewProduct fields SalePrice or OriginalSalePrice should be specified and cannot be negative for CartItemId {{CartItemId}}."); SubsidizeHigherValue missing/null/empty ("SubsidizeHigherValue must be provided."); SubsidizeHigherValue wrong value ("SubsidizeHigherValue should be provided with a valid value."). content: application/json: schema: $ref: '#/components/schemas/ErrorInfo' '403': description: >- Forbidden. The order status is not allowed for order changes ("Order {{OrderId}} status does not allow to make changes for the order."). content: application/json: schema: $ref: '#/components/schemas/ErrorInfo' components: schemas: OrderChangeRequest: type: object title: OrderChangeRequest description: >- Details of changes to the order, including products to add to or remove from the order. required: - OrderId - NewProducts - SubsidizeHigherValue properties: OrderId: type: string description: Global-e order ID. NewProducts: type: array description: List providing information about the products. items: $ref: '#/components/schemas/Product' RemovedProducts: type: array description: List providing information about removed products. items: $ref: '#/components/schemas/RemovedProduct' SubsidizeHigherValue: type: integer description: >- In a quote request: set to 0 to receive the expected order values with no merchant subsidy discount applied in case of higher value; set to 1 to receive the expected order values including the merchant subsidy for the cost difference. In an edit request: set to 0 to avoid subsidizing the cost difference in case of a higher value (if the new order value is higher and the value is 0/null/empty, the editing request will fail); set to 1 to subsidize the additional cost between the original order value prior to the update and the updated value. MerchantOrder: type: object title: Merchant.Order properties: MerchantGUID: type: string description: Unique identifier of the Merchant on Global-e. OrderId: type: string description: Global-e order unique identifier. MerchantOrderId: type: string description: >- Optional. Order unique identifier on the Merchant's site returned from a previous call to SendOrderToMerchant method for this order. CartId: type: string description: >- Optional. Identifier of the cart on the Merchant's site originally specified in merchantCartToken argument for the SendCart method for the cart converted to this order on Global-e. CartHash: type: string description: >- Optional. Cart hash originally specified in merchantCartHash argument for SendCart method for the cart converted to this order on Global-e. StatusCode: type: string description: >- Code denoting the order status on the Merchant site (to be mapped on the Global-e side). CurrencyCode: type: string description: >- 3-char ISO currency code for the order being posted. By default, this is set to the original Merchant's currency. PriceCoefficientRate: type: number description: CountryCoefficient rate is applied to the prices in this order. RoundingRate: type: number description: >- The average conversion rate applied to the prices paid by the customer when calculating the prices paid by Global-e to the Merchant in the original Merchant's currency. This rate includes "FX conversion" and "marketing rounding" factors. UserId: type: string description: >- Optional. Internal User identifier on the Merchant's site originally specified in shippingDetails.UserId argument for the SendCart method for the cart converted to this order on Global-e. ShippingMethodCode: type: string description: >- Optional. Code denoting the local shipping method selected from the list of available shipping options provided in shippingOptionsList argument for SendCart method for the cart converted to this order on Global-e. ClearCart: type: boolean description: >- Indicates if the end customer's cart must be cleared before this method finishes execution on the Merchant's site. AllowMailsFromMerchant: type: boolean description: >- Indicates if the end customer has opted for Global-e checkout to receive emails from the Merchant. LoyaltyPointsSpent: type: number description: >- Optional. The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer's user account. Therefore, the "Loyalty points" type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (on the user's My Account page). LoyaltyPointsEarned: type: number description: >- Optional. The number of loyalty points to be earned for this purchase by the customer on the Merchant's site, as specified in the loyaltyPointsEarned argument for the SendCart method for the cart converted to this order on Global-e. LoyaltyCode: type: string description: >- Optional. The loyalty code applicable to the Merchant's site is entered by the customer in Global-e checkout. SameDayDispatch: type: boolean description: >- Optional. Indicates if the customer has requested a "Same Day Dispatch" in the Global-e checkout. SameDayDispatchCost: type: number description: >- Optional. Cost of the "Same Day Dispatch" option selected by the end customer on Global-e checkout, in the original Merchant's currency. DoNotChargeVAT: type: boolean description: >- Optional. Indicates if the end customer has not been charged VAT in Global-e checkout, as specified in the doNotChargeVAT argument for the SendCart method for the cart converted to this order on Global-e. IsFreeShipping: type: boolean description: >- Optional. Indicates if the Merchant offers free international shipping to the end customer, as specified in the IsFreeShipping argument for the SendCart method for the cart converted to this order on Global-e. FreeShippingCouponCode: type: string description: >- Optional. Merchant's free shipping coupon code applied by the end customer, as specified in the FreeShippingCouponCode argument for the SendCart method for the cart converted to this order on Global-e. ShipToStoreCode: type: string description: >- Optional. Code denoting the Merchant's store specified by the customer for "ship to shop" shipping destination (to be mapped on the Global-e side). CustomerComments: type: string description: >- Optional. Comments text entered by the end customer in Global-e checkout. IsSplitOrder: type: boolean description: >- Optional. Indicates if the order should be handled as split order (i.e. without consolidation). OTVoucherCode: type: string description: Optional. One-time voucher code used to place the order. OTCurrencyCode: type: string description: >- Optional. Currency of the one-time voucher code used to place the order. OTVoucherAmount: type: number description: Optional. Amount taken off the voucher when applicable. WebStoreCode: type: string description: >- Optional. Code used on the merchant's side to identify the web store, as specified in the WebStoreCode argument for the SendCart method for the cart converted to this order on Global-e. Products: type: array description: The list of products being purchased. items: $ref: '#/components/schemas/MerchantProduct' Discounts: type: array description: >- Optional. The list of discounts being applied to the order, according to the original list of discounts received in SendCart for this order, and to the Merchant shipping configuration on Global-e. items: $ref: '#/components/schemas/MerchantDiscount' Markups: type: array description: >- Optional. The list of markups being applied to the order, according to the Merchant shipping configuration on Global-e. Effectively Markup is a "negative Discount". The main use case for Markups is when the customer is charged in Global-e checkout, a flat shipping rate, which is higher than the shipping rate, calculated for the respective order. In this case, Global-e pays the difference to the merchant in the form of Markups applied to the order. Unlike Discounts, Markups may be only passed to the Merchant's back-end ERP system for reconciliation purposes, and may not be displayed to the end customer. items: $ref: '#/components/schemas/MerchantDiscount' Customer: allOf: - $ref: '#/components/schemas/MerchantCustomer' description: >- The paying customer's preferences (Global-e acts as a paying customer). PrimaryBilling: allOf: - $ref: '#/components/schemas/MerchantCustomerDetails' description: >- Primary customer's billing details. Primary customer denotes the paying (Global-e) customer unless Customer.IsEndCustomerPrimary is FALSE. Note that all string attributes of customer details are indicated in the URL-encoded form. Therefore, if the Customer.IsEndCustomerPrimary is TRUE then all string attributes in PrimaryBilling are URL encoded. PrimaryShipping: allOf: - $ref: '#/components/schemas/MerchantCustomerDetails' description: >- Primary customer's shipping details. Primary customer denotes the paying (Global-e) customer unless Customer.IsEndCustomerPrimary is FALSE. Note that all string attributes of customer's details are indicated in URL encoded form. Therefore, if Customer.IsEndCustomerPrimary is TRUE then all string attributes in PrimaryShipping are URL encoded. PaymentDetails: allOf: - $ref: '#/components/schemas/MerchantPaymentDetails' description: The paying customer's payment details. SecondaryBilling: allOf: - $ref: '#/components/schemas/MerchantCustomerDetails' description: >- Secondary customer's billing details. Secondary customer denotes the end customer who has placed the order with Global-e checkout unless Customer.IsEndCustomerPrimary is FALSE. Note that all string attributes of customer's details are indicated in URL encoded form. Therefore, if Customer.IsEndCustomerPrimary is FALSE then all string attributes in SecondaryBilling are URL encoded. SecondaryShipping: allOf: - $ref: '#/components/schemas/MerchantCustomerDetails' description: >- Secondary customer's shipping details. Secondary customer denotes the end customer who has placed the order with Global-e checkout unless Customer.IsEndCustomerPrimary is FALSE. Note that all string attributes of customer's details are indicated in URL encoded form. Therefore, if Customer.IsEndCustomerPrimary is FALSE then all string attributes in SecondaryShipping are URL encoded. InternationalDetails: allOf: - $ref: '#/components/schemas/MerchantInternationalDetails' description: >- Optional. Details referring to the customer's order placed on the Global-e side. These details are applicable only to the Merchants dealing with international customers' support themselves. DiscountedShippingPrice: type: number description: >- The shipping price paid by the customer is converted to the merchant currency. Total Shipping price reducing Order Discounts (InternationalDetails.DiscountedShippingPrice price converted to the merchant currency). PrePayOffered: type: boolean description: >- Indicates if the prepayment option for duties and taxes was offered to the customer. IsReplacementOrder: type: boolean description: Indicates if the order is a replacement. OriginalOrder: allOf: - $ref: '#/components/schemas/MerchantOriginalOrder' description: >- Optional. Details referring to the original order if the current order is a replacement. DateCreated: type: string description: >- Optional, returned by GetOrdersDetails API only. Order creation date and time. CurrencyName: type: string description: >- Optional, returned by GetOrdersDetails API only. Customer currency name. Parcels: type: array description: >- Optional, returned by GetOrdersDetails API only. The list of parcels created for the order. items: $ref: '#/components/schemas/MerchantParcel' TotalDutiesAndTaxesPrice: type: number description: >- Total Duties & Taxes value including Customs Clearance Fees, in the Merchant currency. This amount is the total amount, regardless of whether the customer or the Merchant paid it. USSalesTax: type: number description: >- Sales tax value for USA in the Merchant currency. This value is included in TotalDutiesAndTaxesPrice. ExporterDetails: allOf: - $ref: '#/components/schemas/MerchantExporterDetails' description: Exporter details (relevant EIN / EORI / VAT ImporterDetails: allOf: - $ref: '#/components/schemas/MerchantImporterDetails' description: Importer details (relevant EIN / EORI / VAT DeclarativeShippingPriceInCustomerCurrency: type: number description: >- Shipping cost used for declarative purposes. If the value is 0 (free shipping), a non-zero low value is recommended (may attract duties and taxes). By default, if the customer benefits from Free Shipping, 5 USD is added instead for declarative purposes — this can be disabled by the Global-e team. TaxCalculationRule: type: string description: >- Indicates if destination Duties & Tax calculation is based on Products, Freight, and Duties. Possible values are accordingly: FOB, CIF, CIFD. enum: - FOB - CIF - CIFD TotalValueForCustoms: type: number description: >- Total shipment declarative value for customs. Calculated to include Products, Freight, and Duties. ErrorInfo: type: object title: ErrorInfo properties: Code: type: string description: Error code. Error: type: string description: Error messages. Description: type: string description: Error description. Product: type: object title: Product properties: ReplacementOfCartItemId: type: string description: >- CartItemId of the RemovedProduct that this new product replaces. Must reference a CartItemId present in the RemovedProducts collection and in the order. (Documented in the example and error messages only.) Attributes: type: array description: The product's custom attributes (such as Color, Size, etc.). items: $ref: '#/components/schemas/Attributes' AttributesEnglish: type: array description: >- The product's custom attributes (such as Color, Size, etc.) in English. items: $ref: '#/components/schemas/Attributes' BackOrderDate: type: string description: Estimated date for the backordered item to be in stock. Brand: allOf: - $ref: '#/components/schemas/Brand' description: The product's brand. 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. 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. Categories: type: array description: The product's categories. items: $ref: '#/components/schemas/Category' DeliveryQuantity: type: number description: >- The quantity actually set for delivery for the product (to be used in the Order methods described below, as needed). Description: type: string description: Description of the Product. DescriptionEnglish: type: string description: Description of the Product in English. 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. GiftMessage: type: string description: >- Optional "gift message" text defined by the end customer to be printed on the product. 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. Height: type: number description: >- The product's height in the Merchant's default unit of length measure (will be converted to CM). 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. ImageHeight: type: number description: The product's image height in pixels. ImageURL: type: string description: The product's image URL. ImageWidth: type: number description: The product's image width in pixels. 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. 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. 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. 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. 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. Keywords: type: string description: The product's keywords. Length: type: number description: >- The product's length in the Merchant's default unit of length measure (will be converted to CM). 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. 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. 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. LocalVATRateType: allOf: - $ref: '#/components/schemas/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. MetaData: allOf: - $ref: '#/components/schemas/ProductMetaData' description: >- Used to hold additional product data such as customer-defined product attributes. Name: type: string description: Name of the Product. NameEnglish: type: string description: Name of the Product in English. 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. 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. OrderedQuantity: type: number description: >- Ordered quantity for the product (to be used in Checkout / Order methods described below, as needed). 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. 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. 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. 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. PriceCoefficientRate: type: number description: >- Rate applicable to this Product's ProductClassCode if returned from the CountryCoefficients method. ProductClassCode: type: string description: >- The product class code is used by the Merchant to classify products to use different country coefficient rates. ProductCode: type: string description: >- SKU code used to identify the product on the Merchant's site (to be mapped on the Global-e side). 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). 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"). 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). 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. 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. 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"). URL: type: string description: The product's information page URL. VATCategory: allOf: - $ref: '#/components/schemas/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. VATRateType: allOf: - $ref: '#/components/schemas/VATRateType' description: Product's VAT rate type or class. 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. 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. Width: type: number description: >- The product's width in the Merchant's default unit of length measure (will be converted to CM). RemovedProduct: type: object title: RemovedProduct properties: CartItemId: type: string description: >- Identifier of the line item in the order. This property should be equal to the respective Product's CartItemId originally specified in the SendCart call in order creation. Quantity: type: number description: The quantity of replaced items. MerchantProduct: type: object title: Merchant.Product properties: Attributes: type: array x-gem-only: true description: >- Custom attributes describe products that customers can personalize according to what the site offers. Each Attribute holds a key to specify attribute name and Value properties. items: $ref: '#/components/schemas/MerchantCartProductAttribute' BackOrderDate: type: string x-gem-only: true description: Estimated date for the backordered item to be in stock. Brand: allOf: - $ref: '#/components/schemas/MerchantBrand' description: Product's brandSku. CartItemId: type: string x-gem-only: true description: >- Identifier of the cart item on the Merchant's site originally specified in the Product.CartItemId property of the respective product in the SendCart method for the cart converted to this order on Global-e. CartItemOptionId: type: string x-gem-only: true description: >- Identifier of the child cart item "option" on the Merchant's site originally specified in the Product.CartItemOptionId property of the respective product in the SendCart method for the cart converted to this order on Global-e. Categories: type: array description: List of product categories. items: $ref: '#/components/schemas/MerchantCategory' CustomerVATRate: type: number x-gem-only: true description: The customer VAT rate applied to this product. DiscountedPrice: type: number x-gem-only: true description: >- The product value is in Merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product's price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product's refund. DiscountedPriceForCustoms: type: number x-gem-only: true description: >- Product price in Merchant currency reflects the price after Reverse D&T calculation. DTBreakdown: allOf: - $ref: '#/components/schemas/DTBreakdown' x-gem-only: true description: Contains the duties and taxes per item in Merchant currency. GenericHSCode: type: string x-gem-only: true description: Product's HS code. GiftMessage: type: string x-gem-only: true description: >- Text originally specified in the Product.GiftMessage property of the respective product in the SendCart method for the cart converted to this order on Global-e. HandlingCode: type: string x-gem-only: true description: >- Code originally specified in Product.HandlingCode property of the respective product in the SendCart method for the cart converted to this order on Global-e. InternationalDiscountedPrice: type: number x-gem-only: true description: >- The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product's price and cart discounts will be prorated over all products according to the remaining value. This value can be used as the pre-calculated value for the returned product's refund. InternationalDiscountedPriceForCustoms: type: number x-gem-only: true description: >- Product price in customer currency reflects the price after Reverse D&T calculation. InternationalDiscountedPriceInMerchantCurrency: type: number x-gem-only: true description: Product Price in Merchant currency. InternationalDTBreakdown: allOf: - $ref: '#/components/schemas/DTBreakdown' x-gem-only: true description: Contains the duties and taxes per item in customer currency. InternationalListPrice: type: number x-gem-only: true description: >- Single product list price in end customer's currency (specified in the InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling. InternationalPrice: type: number x-gem-only: true description: >- Single product final sale price in end customer currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling. IsBackOrdered: type: boolean x-gem-only: true description: >- Identifies if the product was ordered as a back ordered item. TRUE - Product is back-ordered. FALSE - Product is not back-ordered. LineItemInternationalPrice: type: number description: >- Line item (product in ordered quantity) price in end customer's currency (specified in the InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable), and IncludeVAT handling. If not specified, should be deemed equal to "InternationalPrice * Quantity". If specified, should take preference over InternationalPrice. LineItemPriceBeforeGlobalEDiscount: type: number deprecated: true description: >- DEPRECATED. Line item (product in ordered quantity) price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global-e discounts (such as per-product Shipping discounts). If not specified, should be deemed equal to "PriceBeforeGlobalEDiscount * Quantity". If specified, should take preference over PriceBeforeGlobalEDiscount. ListPrice: type: number x-gem-only: true description: >- Single product List price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant. Name: type: string x-gem-only: true description: Name of the product. Returned by GetOrdersDetails API only. ParentCartItemId: type: string x-gem-only: true description: >- Identifier of the current item's parent cart item on the Merchant's site originally specified in the Product.ParentCartItemId property of the respective product in the SendCart method for the cart converted to this order on Global-e. Price: type: number x-gem-only: true description: >- Single product final sale price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant. PriceBeforeGlobalEDiscount: type: number deprecated: true x-gem-only: true description: >- DEPRECATED. Single product price in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global-e discounts (such as per-product Shipping discounts). If no Global-e discount was applied, PriceBeforeGlobalEDiscount is equal to Price. ProductAttributes: type: array x-gem-only: true description: Product attributes. Returned by GetOrdersDetails API only. items: $ref: '#/components/schemas/MerchantProductAttribute' Quantity: type: number x-gem-only: true description: >- Product quantity in the order that is currently being submitted to the Merchant. RoundingRate: type: number x-gem-only: true description: >- The conversion rate applied to this product price paid by the end customer when calculating the prices paid by Global-e to the Merchant in the original Merchant's currency. This rate includes "FX conversion" and "marketing rounding" factors. Sku: type: string x-gem-only: true description: >- SKU code used to identify the product on the Merchant's site (to be mapped on the Global-e side). VATRate: type: number x-gem-only: true description: The VAT rate applied to this product. MerchantDiscount: type: object title: Merchant.Discount properties: CouponCode: type: string x-gem-only: true description: >- Merchant CouponCode used for this discount (applicable to coupon-based discounts only). Description: type: string x-gem-only: true description: Discount textual description. DiscountCode: type: string x-gem-only: true description: >- Discount code originally specified in the Discount.DiscountCode property of the respective discount in SendCart method for the cart converted to this order on Global-e. DiscountSource: type: integer description: >- The enum DiscountSource has the following possible values: 1 = Merchant, 2 = FixedShippingPrice, 3 = PercentageCartPrice, 4 = HiddenForceDDP, 5 = Amend, 6 = RemoteAreaSurchargeSubsidy, 7 = LoyaltyPoints, 8 = PaymentCharge, 9 = ReplacementOrder. enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 DiscountType: type: number x-gem-only: true description: >- Discount type ("Cart", "Shipping", etc.), as defined in the DiscountTypeOptions enumeration described in the Discount class in this document. InternationalPrice: type: number x-gem-only: true description: >- Discount value in end customer's currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, and IncludeVAT handling. LocalVATRate: type: number x-gem-only: true description: >- The VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore the VATRate property denotes the VAT for the target country. LoyaltyVoucherCode: type: string x-gem-only: true description: >- Loyalty Voucher code originally specified in Discount.LoyaltyVoucherCode property of the respective discount in SendCart method for the cart converted to this order on Global-e. Name: type: string x-gem-only: true description: Discount name. Price: type: number x-gem-only: true description: >- Discount value in the currency defined in the CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant. ProductCartItemId: type: string x-gem-only: true description: >- Identifier of the product cart item related to this discount on the Merchant's site originally specified in the Discount.ProductCartItemId property of the respective discount in the SendCart method for the cart converted to this order on Global-e. VATRate: type: number x-gem-only: true description: The VAT rate applied to this discount. MerchantCustomer: type: object title: Merchant.Customer properties: IsEndCustomerPrimary: type: boolean description: >- Indicates if end customer details are "swapped" with a paying (Global-e) customer's details when submitting the order to the Merchant. By default, IsEndCustomerPrimary is FALSE. TRUE - The primary customer is the same as the end customer who has placed the order. FALSE - The primary customer denotes the paying (Global-e) customer and the secondary customer denotes the end customer who has placed the order with Global-e checkout. SendConfirmation: type: boolean description: >- Indicates if e-mail confirmation of the respective order's status change needs to be sent to the paying customer (Global-e acts as a paying customer). MerchantCustomerDetails: type: object title: Merchant.CustomerDetails properties: Address1: type: string x-gem-only: true description: Address line 1. Address2: type: string x-gem-only: true description: Address line 2. AddressBookId: type: string x-gem-only: true description: Id of the current address from within the address book. AddressBookName: type: string x-gem-only: true description: Name of the current address from within the address book. City: type: string x-gem-only: true description: City name. Company: type: string x-gem-only: true description: Company name. CountryCode: type: string x-gem-only: true description: 2-char ISO country code. CountryName: type: string x-gem-only: true description: Country name. Email: type: string x-gem-only: true description: Email address. Fax: type: string x-gem-only: true description: Fax. FirstName: type: string x-gem-only: true description: First name. FirstNameInLocalCulture: type: string description: First name in local culture. LastName: type: string x-gem-only: true description: Last name. LastNameInLocalCulture: type: string description: Last name in local culture. MiddleName: type: string x-gem-only: true description: Middle name. Phone1: type: string x-gem-only: true description: Phone Phone2: type: string x-gem-only: true description: Phone Salutation: type: string x-gem-only: true description: Salutation or title (e.g. Dr., Mr., etc.). SaveAddress: type: boolean description: >- Indicates that the current address should be saved in the Merchant platform. StateCode: type: string x-gem-only: true description: State or province ISO code such as AZ for Arizona (if applicable). StateOrProvince: type: string x-gem-only: true description: State or province name. Zip: type: string x-gem-only: true description: Zip or postal code. MerchantPaymentDetails: type: object title: Merchant.PaymentDetails properties: Address1: type: string x-gem-only: true description: Address line 1. Address2: type: string x-gem-only: true description: Address line 2. CardNumber: type: string x-gem-only: true description: Card number. City: type: string x-gem-only: true description: City name. CountryCode: type: string x-gem-only: true description: 2-char ISO country code. CountryName: type: string x-gem-only: true description: Country name. CVVNumber: type: string x-gem-only: true description: Card CVV number. Email: type: string x-gem-only: true description: E-mail address. ExpirationDate: type: string x-gem-only: true description: Card expiration date (in YYYY-MM-DD format). Fax: type: string x-gem-only: true description: Fax. OwnerFirstName: type: string x-gem-only: true description: Card owner's first name. Optional if OwnerName is specified. OwnerLastName: type: string x-gem-only: true description: Card owner's last name. Optional if OwnerName is specified. OwnerName: type: string x-gem-only: true description: >- Card owner's full name (the Merchant may choose to consider either full name or first name with the last name, according to the existing payment method input validation requirements). PaymentMethodCode: type: string x-gem-only: true description: >- Payment method code used to identify the payment method on the Merchant's site (to be mapped on the Global-e side). PaymentMethodName: type: string x-gem-only: true description: Payment method name. PaymentMethodTypeCode: type: string x-gem-only: true description: >- Payment method type's code used to identify the payment method type (such as Credit Card or Check) on the Merchant's site (to be mapped on the Global-e side). Phone1: type: string x-gem-only: true description: Phone Phone2: type: string x-gem-only: true description: Phone StateCode: type: string x-gem-only: true description: State or province ISO code such as AZ for Arizona (if applicable). StateOrProvince: type: string x-gem-only: true description: State or province name. Zip: type: string x-gem-only: true description: Zip or postal code. MerchantInternationalDetails: type: object title: Merchant.InternationalDetails properties: CardNumberLastFourDigits: type: string description: The last 4 digits of the Card number (if applicable). CashOnDeliveryFee: type: number description: >- The additional charge is paid by the end customer when the "Cash on Delivery" payment method has been selected. ConsignmentFee: type: number description: >- The consignment fee is paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice. CurrencyCode: type: string description: >- 3-char ISO code for the currency selected by the end customer for the order payment. CustomerDTBreakdown: allOf: - $ref: '#/components/schemas/DTBreakdown' x-gem-only: true description: >- Contains the duties and taxes parts the customer paid for the order in the currency denoted by CurrencyCode. DeliveryDaysFrom: type: number description: >- The minimum number of days for delivery to the end customer for the selected shipping method. DeliveryDaysTo: type: number description: >- The maximum number of days for delivery to the end customer for the selected shipping method. DiscountedShippingPrice: type: number description: >- The price paid by the customer in local currency. Total Shipping price reducing Order Discounts International price. DutiesGuaranteed: type: boolean description: >- Indicates if the end customer has selected the "guaranteed duties and taxes" option. ExpirationDate: type: string description: Card expiration date in YYYY-MM-DD format (if applicable). MerchantDTBreakdown: allOf: - $ref: '#/components/schemas/DTBreakdown' x-gem-only: true description: >- Contains the duties and taxes parts the Merchant subsidized for the order in the currency denoted by CurrencyCode. OrderTrackingNumber: type: string description: >- Tracking number used by the selected international shipping method for this order. OrderTrackingUrl: type: string description: >- Full tracking URL including OrderTrackingNumber used by the selected international shipping method for this order. OrderWaybillNumber: type: string description: >- Waybill number used by the selected international shipping method for this order. ParcelsTracking: type: array description: >- List of Merchant.ParcelTracking objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number). items: $ref: '#/components/schemas/MerchantParcelTracking' PaymentMethodCode: type: string description: >- Code denoting the selected payment method as defined on the Merchant's site (to be mapped on the Global-e side). If this payment method doesn't exist on the Merchant's site, the internal Global-e payment method code will be specified instead. PaymentMethodName: type: string description: Name of the selected payment method. RemoteAreaSurcharge: type: number description: >- Remote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice. SameDayDispatchCost: type: number description: >- Cost of the "Same Day Dispatch" option (if selected by the end customer on Global-e checkout), in the currency denoted by CurrencyCode. This value is NOT included in TotalShippingPrice. ShippingMethodCode: type: string description: >- Code denoting the selected international shipping method as defined on the Merchant's site (to be mapped on the Global-e side). If this international shipping method doesn't exist on the Merchant's site, the internal Global-e shipping method code will be specified instead. ShippingMethodName: type: string description: Name of the selected international shipping method. ShippingMethodStatusCode: type: string description: >- Code denoting the selected shipping status as defined on the Merchant's site (to be mapped on the Global-e side). If this shipping status doesn't exist on the Merchant's site, the internal Global-e shipping status code will be specified instead. ShippingMethodStatusName: type: string description: Name of the shipping status. ShippingMethodTypeCode: type: string description: >- Code denoting the selected international shipping method type as defined on the Merchant's site (to be mapped on the Global-e side). If this international shipping method type does not exist on the Merchant's site, the internal Global-e shipping method type code will be specified instead. ShippingMethodTypeName: type: string description: Name of the selected international shipping method type. ShippingVATRate: type: number x-gem-only: true description: >- The shipping VAT rate for the customer. This rate is applied to the shipping cost. SizeOverchargeValue: type: number description: >- Oversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice. TotalCCFPrice: type: number description: >- Total Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice. TotalDutiesPrice: type: number description: >- Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by CurrencyCode. TotalPrice: type: number description: Total order price in the currency denoted by CurrencyCode. TotalShippingPrice: type: number description: Total shipping price in the currency denoted by CurrencyCode. TotalVATAmount: type: number description: Amount of VAT paid by the customer to Global-e. TransactionCurrencyCode: type: string description: >- 3-char ISO code for the currency actually used for the current order payment. TransactionCurrencyCode may differ from CurrencyCode if the currency selected by the end customer could not be used with the selected payment method. TransactionTotalPrice: type: number description: >- Total order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode. USSalesTax: type: number description: >- Sales tax value for the USA in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice. MerchantOriginalOrder: type: object title: Merchant.OriginalOrder properties: MerchantInternalOrderId: type: string x-gem-only: true description: >- InternalOrderId returned from SendOrderToMerchant call for the original order. MerchantOrderId: type: string x-gem-only: true description: >- OrderId returned from SendOrderToMerchant call for the original order. OrderId: type: string description: Global-e order unique identifier for the original order. MerchantParcel: type: object title: Merchant.Parcel properties: Code: type: string description: Parcel code. ParcelStatusId: type: number description: Parcel status id. StatusName: type: string description: Parcel status name. TrackingUrl: type: string description: Direct tracking URL. Products: type: array description: List of products included in the parcel. items: $ref: '#/components/schemas/MerchantParcelProduct' MerchantExporterDetails: type: object title: Merchant.ExporterDetails properties: EORINumber: type: string description: Global-e Exporter entity registration EORI number. IOSSNumber: type: string description: Global-e Exporter entity IOSS number (for shipments to the EU). VATRegistrationNumber: type: string description: Global-e Exporter entity registration VAT number. MerchantImporterDetails: type: object title: Merchant.ImporterDetails properties: Address: allOf: - $ref: '#/components/schemas/MerchantImporterAddress' description: >- Full address of the importer as the Private/Business Importer (customer) or the Global-e Importer entity, if relevant. Company: type: string description: >- Either the Customer Company name, if provided in the cart/checkout, or the Global-e importer entity name for the relevant markets (eg. Switzerland). CustomerTaxId: type: string description: >- The Customer tax number is provided at checkout, as required for clearance into certain markets (e.g. Brazil, Turkey). ImporterType: type: integer description: >- Importer type, depending on the order type and destination: 0: Private importer – standard B2C shipment. 1: Global-e Importer – specific importer mentions required. enum: - 0 - 1 VATRegistrationNumber: type: string description: >- Either the Customer VAT Registration Number, if provided in the cart/checkout, or the Global-e importer entity registration number for relevant markets (eg. Switzerland). Attributes: 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). 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). Name: type: string description: Attribute name. Brand: type: object title: Brand properties: BrandCode: type: string description: >- Brand code on the Merchant's site (to be mapped on the Global-e side). Name: type: string description: Brand name. Category: type: object title: Category properties: CategoryCode: type: string description: >- Category code on the Merchant site (to be mapped on the Global-e side). Name: type: string description: Category name. VATRateType: type: object title: VATRateType properties: Name: type: string description: VAT rate type name. Rate: type: number description: VAT rate decimal value. VATRateTypeCode: type: string description: >- VAT rate type (or class) code on the Merchant's site (to be mapped on the Global-e side). ProductMetaData: type: object title: ProductMetaData properties: Attributes: type: array description: >- Customer-defined product attributes that allow the personalisation of the product if supported by the merchant's site (e.g. engraving). items: $ref: '#/components/schemas/Attributes' VATCategory: type: object title: VATCategory properties: Name: type: string description: VAT Category name. VATCategoryCode: type: string description: >- Code used to identify the VAT category on the Merchant's site (to be mapped on the Global-e side). MerchantCartProductAttribute: type: object title: Merchant.CartProductAttribute properties: AttributeKey: type: string description: >- Custom product attribute name that is used to describe the personalized product. AttributeValue: type: string description: >- Custom product attribute value that is used to describe the personalized product. MerchantBrand: type: object title: Merchant.Brand properties: BrandCode: type: string description: Brand code. Name: type: string description: Brand name. MerchantCategory: type: object title: Merchant.Category properties: CategoryCode: type: string description: Merchant category code. Name: type: string description: Merchant category name. DTBreakdown: type: object title: DTBreakdown properties: Duties: type: number x-gem-only: true description: Duties that are applied. Other: type: number x-gem-only: true description: Other DT fees that are applied. SalesTaxes: type: number description: Sales taxes that are applied. MerchantProductAttribute: type: object title: Merchant.ProductAttribute properties: AttributeKey: type: string description: >- Customized product attribute name, used to describe the personalized product. AttributeValue: type: string description: >- Customized product attribute, used to describe the personalized product. MerchantParcelTracking: type: object title: Merchant.ParcelTracking properties: ParcelCode: type: string description: Parcel code. ParcelTrackingNumber: type: string description: >- The tracking number is used by the selected international shipping method for this parcel. ParcelTrackingUrl: type: string description: >- Full tracking URL including ParcelTrackingNumber used by the selected international shipping method for this parcel. MerchantParcelProduct: type: object title: Merchant.ParcelProduct properties: CartItemId: type: string description: Cart item id of the product. Quantity: type: number description: Product quantity included in the parcel. Sku: type: string description: Product SKU. MerchantImporterAddress: type: object title: Merchant.ImporterAddress properties: Address1: type: string description: Address line 1. Address2: type: string description: Address line 2. City: type: string description: City name. Country: type: string description: Country name. CountryCode: type: string description: 2-char ISO country code. Name: type: string description: First and Last name. StateCode: type: string description: State or province ISO code such as AZ for Arizona (if applicable). StateOrProvince: type: string description: State or province name. Zip: type: string description: Zip or postal code. ````