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.

POST /Checkout/SendCartV2

SendCartV2

cURL

curl --request POST \
  --url https://{globale_api_domain}/Checkout/SendCartV2 \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": "[e-mail]",
        "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
}
'

200

{
  "cartInfo": {
    "CartToken": "<string>"
  }
}

Body

application/json

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

Products · Product · object[] · required

List of Product objects.

Show child attributes

AllowMailsFromMerchant · boolean

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 · CartCurrencyData · object

Details about the cart currency

Show child attributes

CartId · string

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 · CartPriceModificationData · object

Data regarding cart price modifications

Show child attributes

CartToken · string

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

The end customer’s IP address.

CountryCode · string

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 · Culture · object

Cart culture data

Show child attributes

DeliveryType · string

Indicates type of delivery.

Discounts · Discount · object[]

List of Discounts to be applied to the cart. Discounts of any type (“cart”, “shipping”, etc.) may be specified.

Show child attributes

FreeShipping · CartFreeShippingData · object

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

Show child attributes

HubCountryCode · string

The 2-character ISO country code representing the country to which this hub belongs.

HubId · number

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

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 · ShippingOption · object[]

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 .

Show child attributes

LoyaltyData · CartLoyaltyData · object

Holds information for Merchant-side loyalty points to be applied.

Show child attributes

LoyaltyPoints · LoyaltyPoints · object

Holds information on the registered user to apply loyalty points on the checkout page.

Show child attributes

MerchantCartHash · string

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

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

Unique identifier of Merchant internal order ID.

MerchantOrderId · string

Unique identifier of Merchant order ID.

MerchantPriceForDuties · string

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

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

List of available payment instalment amounts.

PriceModification · object

Cart price modification data

rateData · string

Currency data used by Global‑e to verify the currency rate. Return the value received in the used currency rate.

ShipToStoreCode · string

Indicates the ship-to-shop code.

UrlParameters · string

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 · CartUserDetails · object

All available details of the user including all relevant addresses.

Show child attributes

VATRegistration · CartVATRegistrationData · object

Holds information required for VAT exemption within the EU.

Show child attributes

VoucherData · CartVoucherData · object

Holds information for Merchant-side vouchers to be applied (includes loyalty vouchers and one-time vouchers).

Show child attributes

WebStoreCode · string

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

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.

Response

200 - application/json

Response Parameters

cartInfo · CartInfo · object

Contains details about the end customer's cart.

Show child attributes