> ## Documentation Index > Fetch the complete documentation index at: https://docs-stage.bglobale.com/llms.txt > Use this file to discover all available pages before exploring further. # SendCartV2 > The method sends the end customer's cart contents from the Merchant's site to Global-e and returns a unique Cart Token to be further passed by the Merchant's site to the Global-e checkout widget or to API checkout methods. ## OpenAPI ````yaml api-reference/specs/sendcartv2.yaml POST /Checkout/SendCartV2 openapi: 3.0.3 info: title: SendCartV2 version: 1.0.0 description: >- The method sends the end customer's cart contents from the Merchant's site to Global-e and returns a unique Cart Token to be further passed by the Merchant's site to the Global-e checkout widget or to API checkout methods. 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: SendCartV2 x-page-title: SendCartV2 - name: 'Direction: Merchant → Global-e' - name: 'Domain: Checkout & Cart' paths: /Checkout/SendCartV2: post: tags: - SendCartV2 summary: SendCartV2 operationId: sendCartV2 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendCartData' example: CountryCode: AU ClientIP: 128.128.128.128 Currency: OriginalCurrencyCode: GBP CurrencyCode: AUD PriceModification: RoundingRuleId: 103 PriceCoefficientRate: 1 IncludeVAT: null Culture: PreferedCultureCode: null InputDataCultureCode: null CultureCode: en-GB LocalShippingOptions: - Carrier: globaleintegration_standard CarrierTitle: globaleintegration_standard CarrierName: globaleintegration_standard Code: globaleintegration_standard Method: globaleintegration_standard MethodTitle: globaleintegration_standard MethodDescription: globaleintegration_standard Price: 0 IsPreferred: true MerchantCartToken: 21531332-b15f-4640-ad5e-60887271a89a MerchantOrderId: '45345454' PlatformURLs: SiteURL: https://test.com/my_url.html RedirectToCartURL: https://test.com/callback_URL.html PaymentCallbackURL: https://test.com/paymentCallback_URL.html Products: - ProductCode: XE08801 ProductGroupCode: null Name: Socks URL: https://www.test.com/products/08801 Description: Naturally Close 5 Pack White Value Trainer Liner Socks ImageURL: https://test.test.com/1.jpg SalePrice: '8.95' OriginalSalePrice: '5' SalePriceBeforeRounding: '8.905175000000000000' LocalVATRateType: VATRateTypeCode: merchantVATRateType_20 Name: merchantVATRateType_20 Rate: 20 InternalVATRateTypeId: 0 OrderedQuantity: 1 CartItemId: '111' IsBackOrdered: false IsFixedPrice: true ListPrice: 58.2 Attributes: - AttributeCode: color Name: WHITE AttributeTypeCode: color - AttributeCode: size Name: ONE SIZE AttributeTypeCode: size MetaData: Attributes: - AttributeKey: earliestDeliveryDate AttributeValue: '1717763520' - AttributeKey: earliestShipDate AttributeValue: '1716985920' CartToken: null UserDetails: UserId: 12345 AddressDetails: - UserId: 12345 FirstName: Test LastName: Test-e Phone1: '01234567' Email: mmm.bbb@gmail.com Address1: 2-4 Test St City: Alexandria Zip: '2015' CountryCode: AU IsShipping: true IsBilling: true IsDefaultShipping: true IsDefaultBilling: true Discounts: [] VATRegistration: VatRegistrationNumber: null DoNotChargeVAT: false rateData: bkep2SfLA8VXnA3+mU1e16u5InvGPYAmwm7RpmXveyU= IsMoto: 1 responses: '200': description: Response Parameters content: application/json: schema: $ref: '#/components/schemas/SendCartV2Response' components: schemas: SendCartData: type: object title: SendCartData description: >- Details about the end customer's cart contents from the Merchant's site. Includes user details, product details, discount details, conversion information, vouchers, and any other information required for cart creation additionalProperties: true required: - Products properties: AllowMailsFromMerchant: type: boolean description: >- Indicates if the end customer’s consent to receive emails from Merchants should be pre-selected in Global‑e checkout. TRUE - Preselect consent to receive emails. FALSE - Do not preselect consent. CartCurrencyData: $ref: '#/components/schemas/CartCurrencyData' description: Details about the cart currency CartId: type: string description: >- A string that represents the Merchant order id if it is known already at the point when the user is still in the cart page on the Merchant’s store. CartPriceModificationData: $ref: '#/components/schemas/CartPriceModificationData' description: Data regarding cart price modifications CartToken: type: string description: >- The value returned from the previous call to SendCart for the same client (must be stored in the client session or persistent cookie on the Merchant’s side). This parameter is used to support cart updates. clientIP: type: string description: The end customer’s IP address. 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 the shippingDetails.CountryCode property denoting the registered user’s country defined below. Culture: $ref: '#/components/schemas/Culture' description: Cart culture data DeliveryType: type: string description: Indicates type of delivery. Discounts: type: array items: $ref: '#/components/schemas/Discount' description: >- List of Discounts to be applied to the cart. Discounts of any type (“cart”, “shipping”, etc.) may be specified. FreeShipping: $ref: '#/components/schemas/CartFreeShippingData' description: >- Holds information required carts that were awarded free international shipping according to the Merchant platform (as opposed to the flat shipping pricing system on the global-e system). HubCountryCode: type: string description: >- The 2-character ISO country code representing the country to which this hub belongs. HubId: type: number description: >- Identifier of the Global‑e’s Local Hub previously returned by the ActiveHubDetails method. If not specified, the default Merchant’s Hub will be used instead. IsMoto: type: boolean description: >- Indicates whether the person placing the order is a customer support agent or a regular customer. TRUE – The customer is a customer support agent and an “Offline order” takes place, FALSE - (default value) – The customer is a regular customer. LocalShippingOptions: type: array items: $ref: '#/components/schemas/ShippingOption' 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 the ActiveHubDetails method. If the “globaleintegration_standard” shipping method 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 the SendOrderToMerchant API method). Therefore, all other shipping methods available for local shipping may be omitted in LocalShippingOptions . LoyaltyData: $ref: '#/components/schemas/CartLoyaltyData' description: Holds information for Merchant-side loyalty points to be applied. LoyaltyPoints: $ref: '#/components/schemas/LoyaltyPoints' description: >- Holds information on the registered user to apply loyalty points on the checkout page. MerchantCartHash: type: string description: >- Hash optionally generated by the Merchant, to be returned to the Merchant with the order API call. This hash may be used for additional cart and order validation purposes on the Merchant’s side. MerchantCartToken: type: string description: >- Cart or session identifier used for the cart on the Merchant’s site, to be returned to the Merchant with the order API call. MerchantInternalOrderId: type: string description: Unique identifier of Merchant internal order ID. MerchantOrderId: type: string description: Unique identifier of Merchant order ID. MerchantPriceForDuties: type: string description: >- The amended Merchant's price for duties. Can be used to declare a value for a free item for customs purposes. Note: Either MerchantPriceForDuties or OriginalMerchantPriceForDuties or both can be provided. Used by SendCartV2 API. OriginalMerchantPriceForDuties: type: string description: >- The original Merchant's price for duties. Can be used to declare a value for a free item for customs purposes. Note: Either MerchantPriceForDuties or OriginalMerchantPriceForDuties or both can be provided. Used by SendCartV2 API. PaymentInstallments: type: array items: type: number description: List of available payment instalment amounts. PriceModification: type: object description: Cart price modification data Products: type: array items: $ref: '#/components/schemas/Product' description: List of Product objects. rateData: type: string description: >- Currency data used by Global‑e to verify the currency rate. Return the value received in the used currency rate. ShipToStoreCode: type: string description: Indicates the ship-to-shop code. UrlParameters: type: string description: >- List of JSON-serialized KeyValuePairs that denote parameter values to be specified in the respective Merchant’s RESTFul API action URLs. For example, to instruct Global‑e to include the “ en-AU ” locale in the SendOrderToMerchant call for this cart, urlParameters should include: KeyValuePair: [{"Key":"locale", "Value":"en-AU"}] . In this example “locale” parameter should be configured for the SendOrderToMerchant URL for this Merchant on the Global‑e side. UserDetails: $ref: '#/components/schemas/CartUserDetails' description: All available details of the user including all relevant addresses. VATRegistration: $ref: '#/components/schemas/CartVATRegistrationData' description: Holds information required for VAT exemption within the EU. VoucherData: $ref: '#/components/schemas/CartVoucherData' description: >- Holds information for Merchant-side vouchers to be applied (includes loyalty vouchers and one-time vouchers). WebStoreCode: type: string description: >- Code used on the Merchant’s side to identify the web store where the current cart is originating from. This code should be used in case of a multi-store setup on the Merchant’s site. 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. SendCartV2Response: type: object title: Response properties: cartInfo: $ref: '#/components/schemas/CartInfo' description: Contains details about the end customer's cart. CartCurrencyData: type: object title: CartCurrencyData properties: 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 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 CartPriceModificationData: type: object title: CartPriceModificationData properties: IncludeVAT: type: number description: The IncludeVAT value returned from the CountryCoefficients method priceCoefficientRate: type: number description: The rate returned from the CountryCoefficients method RoundingRuleId: type: number description: The RoundingRuleId value returned from the RoundingRules method Culture: type: object title: Culture properties: Code: type: string description: ISO culture code IsRTL: type: boolean description: >- Identifies if language is a “right-to-left” language such as Hebrew and Arabic. TRUE if “right-to-left” language FALSE if not “right-to-left” language LocalizedName: type: string description: >- Culture name in the respective language, such as “עברית” for he-IL (Hebrew-Israel) culture Name: type: string description: Culture name Discount: type: object title: Discount properties: CalculationMode: type: number description: >- One of the following possible values of CalculationModeOptions enumeration denoting the calculation mode of a discount to be implemented by GEM, see the CalculationMode Option Value Table below. CouponCode: type: string description: >- Merchant Coupon Code used for this discount (applicable to coupon-based discounts only) Description: type: string description: Discount textual description DiscountCode: type: string description: >- Discount code used to identify the discount on the Merchant’s site. This property may be optionally specified in the SendCart method only, so that the same value could be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant method. DiscountType: type: number description: >- One of the following possible enum values of DiscountTypeOptions enumeration denoting a type of discount. See the DiscountType Option Table below. DiscountValue: type: number description: >- Discount value as displayed to the customer, after applying country coefficient, FX conversion and IncludeVAT handling. LocalVATRate: type: number description: >- 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 VATRate property denotes the VAT for the target country. LoyaltyVoucherCode: type: string description: >- Code used on the Merchant’s site to identify the Loyalty Voucher that this discount is based on Name: type: string description: Discount name OriginalDiscountValue: type: number description: >- Discount value in original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country. ProductCartItemId: type: string description: >- Identifier of the product cart item related to this discount on the Merchant’s site. This property may be optionally specified in the SendCart method only so that the same value could be posted back when creating the order on the Merchant’s site with the SendOrderToMerchant method. VATRate: type: number description: The VAT rate applied to this discount CartFreeShippingData: type: object title: CartFreeShippingData properties: FreeShippingCouponCode: type: string description: Merchant’s free shipping CouponCode applied by the end customer IsFreeShipping: type: boolean description: >- Indicates if the Merchant offers free international shipping to the end customer. TRUE - Free international shipping is offered. FALSE - Free international shipping is not offered. ShippingOption: type: object title: ShippingOption properties: Carrier: type: string description: Carrier’s short name CarrierName: type: string description: Carrier’s full name CarrierTitle: type: string description: Carrier’s title 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) Method: type: string description: Shipping method name MethodTitle: type: string description: Shipping method title MethodDescription: type: string description: Shipping method description Price: type: number description: >- Shipping price in Merchant’s original currency defined in the originalCurrencyCode argument of the respective method call (i.e. SendCart ) CartLoyaltyData: type: object title: CartLoyaltyData properties: LoyaltyCode: type: string description: >- Loyalty code applicable to the Merchant’s site entered by the end customer in Global‑e checkout LoyaltyPointsEarned: type: number description: >- The number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in the loyaltyPointsEarned argument for the SendCart method for the cart converted to this order on Global-e. LoyaltyPointsSpent: type: number description: >- The number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, the “Loyalty points” type discount must not be applied to the order directly but can be used for display purposes elsewhere in the system (i.e. on the end user’s My Account page). LoyaltyPointsTotal: type: number description: >- The total number of loyalty points currently available in the end customer’s user account on the Merchant’s site. LoyaltyPoints: type: object title: LoyaltyPoints properties: LoyaltyPointsMaxSpend: type: number description: >- The limit loyalty points that the user can use in this order – if not exists the LoyaltyPointsTotal is taken. LoyaltyPointsOriginalValueForEarn: type: number description: >- Value of one loyalty point for earn, in Merchant currency – optional if LoyaltyPointsOriginalForEarn exists. LoyaltyPointsOriginalValueForSpend: type: number description: >- Value of one loyalty point for spending, in Merchant currency – optional if LoyaltyPointsValueForSpend exists. LoyaltyPointsTotal: type: number description: >- The total loyalty points the user has on account at the Merchant’s site LoyaltyPointsValueForEarn: type: number description: >- Value of one loyalty point for earn, in customer currency – optional if LoyaltyPointsOriginalValueForEarn exists. LoyaltyPointsValueForSpend: type: number description: >- Value of one loyalty point for spending, in customer currency – optional if LoyaltyPointsOriginalValueForSpend exists. Product: type: object title: Product properties: Attributes: type: array items: $ref: '#/components/schemas/Attributes' description: The product’s custom attributes (such as Color, Size, etc.) AttributesEnglish: type: array items: $ref: '#/components/schemas/Attributes' description: >- The product’s custom attributes (such as Color, Size, etc.) in English BackOrderDate: type: string description: Estimated date for the backordered item to be in stock Brand: $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 items: $ref: '#/components/schemas/Category' description: The product’s categories 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 backed 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. LocalVATRateType: $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: $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. 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. 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. 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: $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: $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). 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). CartUserDetails: type: object title: CartUserDetails properties: AddressDetails: type: array items: $ref: '#/components/schemas/AddressDetails' description: >- All available addresses are taken from the registered customer address book UserId: type: string description: Internal User identifier on the Merchant’s site CartVATRegistrationData: type: object title: CartVATRegistrationData properties: DoNotChargeVAT: type: boolean description: >- Indicates if the end customer must not be charged VAT. TRUE - Set to TRUE for registered users who have validated their business entity’s VAT Registration Number with the merchant and are therefore VAT exempted. Customer is not charged VAT. FALSE - Customer is charged VAT. VatRegistrationNumber: type: string description: >- VAT Registration Number of the end customer’s business entity validated with the merchant CartVoucherData: type: object title: CartVoucherData properties: LoyaltyVouchers: type: array items: $ref: '#/components/schemas/LoyaltyVoucher' description: List of available loyalty vouchers for the registered customer OTVoucher: $ref: '#/components/schemas/CartOTVoucherData' description: One-time voucher information CartInfo: type: object title: CartInfo properties: CartToken: type: string description: >- Cart token for the cart generated on Global‑e side by SendCart method (further on to be passed by the Merchant’s site to Global‑e checkout widget or to API checkout methods) 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: MetaData properties: Attributes: type: array items: $ref: '#/components/schemas/Attributes' description: >- Customer-defined product attributes that allow the personalisation of the product if supported by the merchant’s site (e.g. engraving) 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) AddressDetails: type: object title: AddressDetails properties: Address1: type: string description: Address line 1. Address2: type: string description: Address line 2. AddressBookId: type: string description: Id of the current address from within the address book AddressBookName: type: string description: Name of the current address from within the address book City: type: string description: City name. Company: type: string description: Company name CountryCode: type: string description: 2-char ISO country code Email: type: string description: E-mail address Fax: type: string description: Fax FirstName: type: string description: First name FirstNameInLocalCulture: type: string description: First name in local culture IsBilling: type: boolean description: Indicates that the current address can be used as a billing address IsDefaultBilling: type: boolean description: Indicates that the current address is the default billing address IsDefaultShipping: type: boolean description: Indicates that the current address is the default shipping address IsShipping: type: boolean description: Indicates that the current address can be used as a shipping address LastName: type: string description: Last name LastNameInLocalCulture: type: string description: Last name in local culture MiddleName: type: string description: Middle name Phone1: type: string description: 'Phone #1' Phone2: type: string description: 'Phone #2' Salutation: type: string description: Salutation or title (e.g. Dr., Mr., etc.). StateCode: type: string description: State or province ISO code such as AZ for Arizona (if applicable) StateOrProvince: type: string description: State or province name UserIdNumber: type: string description: User’s personal ID document number UserIdNumberType: $ref: '#/components/schemas/UserIdNumberType' description: User’s personal ID document type (e.g. Passport, ID card, etc.) Zip: type: string description: Zip or postal code LoyaltyVoucher: type: object title: LoyaltyVoucher properties: Description: type: string description: Loyalty Voucher’s textual description DiscountValue: type: number description: >- Value of the discount based on the Loyalty Voucher. This value should be specified in the end customer’s currency, after applying country coefficient, FX conversion and IncludeVAT handling. IsApplied: type: boolean description: >- Indicates if the Loyalty Voucher is already applied by the end customer to the current cart LocalVATRate: type: number description: >- The VAT rate to be applied to the discount based on this Loyalty Voucher if the order was placed by the local customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore VATRate property actually denotes the VAT for the target country. Name: type: string description: Loyalty Voucher’s name OriginalDiscountValue: type: number description: >- The discount value to which the end customer is entitled if this Loyalty Voucher is applied to the cart. This value should be specified in the original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country. VATRate: type: number description: The VAT rate applied to the discount based on this Loyalty Voucher VoucherCode: type: string description: Code used to identify the Loyalty Voucher on the Merchant’s site CartOTVoucherData: type: object title: CartOTVoucherData properties: OTVoucherAmount: type: string description: Amount of the one-time voucher in OTVoucherCurrencyCode currency OTVoucherCode: type: number description: One-time voucher code for the cart (for applicable platforms) OTVoucherCurrencyCode: type: number description: One-time voucher currency used for the amount UserIdNumberType: type: object title: UserIdNumberType properties: Name: type: string description: Identification document type name 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) ````