ValidateVoucher (Global-e to Merchant)

curl --request POST \
  --url https://{merchant_site_domain}/checkout-validate-cart-voucher-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "CartHash": "",
  "CartId": "36048",
  "CartToken": "f8a78edd-7cea-4cb7-835c-57c7f0b13c56",
  "CountryCode": "IL",
  "CurrencyCode": "ILS",
  "Discounts": [],
  "FreeShippingCouponCode": "",
  "IsFreeShipping": false,
  "MerchantGUID": "e967e65e-f69e-479c-949d-91289a7f6875",
  "Products": [],
  "UserId": null,
  "VoucherCode": "10Perc",
  "VoucherType": 1,
  "WebStoreCode": null,
  "WebStoreInstanceCode": "GlobalEDefaultStoreInstance"
}
'

import requests

url = "https://{merchant_site_domain}/checkout-validate-cart-voucher-url"

payload = {
    "CartHash": "",
    "CartId": "36048",
    "CartToken": "f8a78edd-7cea-4cb7-835c-57c7f0b13c56",
    "CountryCode": "IL",
    "CurrencyCode": "ILS",
    "Discounts": [],
    "FreeShippingCouponCode": "",
    "IsFreeShipping": False,
    "MerchantGUID": "e967e65e-f69e-479c-949d-91289a7f6875",
    "Products": [],
    "UserId": None,
    "VoucherCode": "10Perc",
    "VoucherType": 1,
    "WebStoreCode": None,
    "WebStoreInstanceCode": "GlobalEDefaultStoreInstance"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    CartHash: '',
    CartId: '36048',
    CartToken: 'f8a78edd-7cea-4cb7-835c-57c7f0b13c56',
    CountryCode: 'IL',
    CurrencyCode: 'ILS',
    Discounts: [],
    FreeShippingCouponCode: '',
    IsFreeShipping: false,
    MerchantGUID: 'e967e65e-f69e-479c-949d-91289a7f6875',
    Products: [],
    UserId: null,
    VoucherCode: '10Perc',
    VoucherType: 1,
    WebStoreCode: null,
    WebStoreInstanceCode: 'GlobalEDefaultStoreInstance'
  })
};

fetch('https://{merchant_site_domain}/checkout-validate-cart-voucher-url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{merchant_site_domain}/checkout-validate-cart-voucher-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'CartHash' => '',
    'CartId' => '36048',
    'CartToken' => 'f8a78edd-7cea-4cb7-835c-57c7f0b13c56',
    'CountryCode' => 'IL',
    'CurrencyCode' => 'ILS',
    'Discounts' => [
        
    ],
    'FreeShippingCouponCode' => '',
    'IsFreeShipping' => false,
    'MerchantGUID' => 'e967e65e-f69e-479c-949d-91289a7f6875',
    'Products' => [
        
    ],
    'UserId' => null,
    'VoucherCode' => '10Perc',
    'VoucherType' => 1,
    'WebStoreCode' => null,
    'WebStoreInstanceCode' => 'GlobalEDefaultStoreInstance'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{merchant_site_domain}/checkout-validate-cart-voucher-url"

	payload := strings.NewReader("{\n  \"CartHash\": \"\",\n  \"CartId\": \"36048\",\n  \"CartToken\": \"f8a78edd-7cea-4cb7-835c-57c7f0b13c56\",\n  \"CountryCode\": \"IL\",\n  \"CurrencyCode\": \"ILS\",\n  \"Discounts\": [],\n  \"FreeShippingCouponCode\": \"\",\n  \"IsFreeShipping\": false,\n  \"MerchantGUID\": \"e967e65e-f69e-479c-949d-91289a7f6875\",\n  \"Products\": [],\n  \"UserId\": null,\n  \"VoucherCode\": \"10Perc\",\n  \"VoucherType\": 1,\n  \"WebStoreCode\": null,\n  \"WebStoreInstanceCode\": \"GlobalEDefaultStoreInstance\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{merchant_site_domain}/checkout-validate-cart-voucher-url")
  .header("Content-Type", "application/json")
  .body("{\n  \"CartHash\": \"\",\n  \"CartId\": \"36048\",\n  \"CartToken\": \"f8a78edd-7cea-4cb7-835c-57c7f0b13c56\",\n  \"CountryCode\": \"IL\",\n  \"CurrencyCode\": \"ILS\",\n  \"Discounts\": [],\n  \"FreeShippingCouponCode\": \"\",\n  \"IsFreeShipping\": false,\n  \"MerchantGUID\": \"e967e65e-f69e-479c-949d-91289a7f6875\",\n  \"Products\": [],\n  \"UserId\": null,\n  \"VoucherCode\": \"10Perc\",\n  \"VoucherType\": 1,\n  \"WebStoreCode\": null,\n  \"WebStoreInstanceCode\": \"GlobalEDefaultStoreInstance\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{merchant_site_domain}/checkout-validate-cart-voucher-url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"CartHash\": \"\",\n  \"CartId\": \"36048\",\n  \"CartToken\": \"f8a78edd-7cea-4cb7-835c-57c7f0b13c56\",\n  \"CountryCode\": \"IL\",\n  \"CurrencyCode\": \"ILS\",\n  \"Discounts\": [],\n  \"FreeShippingCouponCode\": \"\",\n  \"IsFreeShipping\": false,\n  \"MerchantGUID\": \"e967e65e-f69e-479c-949d-91289a7f6875\",\n  \"Products\": [],\n  \"UserId\": null,\n  \"VoucherCode\": \"10Perc\",\n  \"VoucherType\": 1,\n  \"WebStoreCode\": null,\n  \"WebStoreInstanceCode\": \"GlobalEDefaultStoreInstance\"\n}"

response = http.request(request)
puts response.read_body

{
  "IsVoucherValid": true,
  "VoucherType": 1,
  "CartToken": "f8a78edd-7cea-4cb7-835c-57c7f0b13c56",
  "VoucherValidationRestriction": [],
  "ValidationFaliureMessage": ""
}

POST

checkout-validate-cart-voucher-url

ValidateVoucher (Global-e to Merchant)

curl --request POST \
  --url https://{merchant_site_domain}/checkout-validate-cart-voucher-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "CartHash": "",
  "CartId": "36048",
  "CartToken": "f8a78edd-7cea-4cb7-835c-57c7f0b13c56",
  "CountryCode": "IL",
  "CurrencyCode": "ILS",
  "Discounts": [],
  "FreeShippingCouponCode": "",
  "IsFreeShipping": false,
  "MerchantGUID": "e967e65e-f69e-479c-949d-91289a7f6875",
  "Products": [],
  "UserId": null,
  "VoucherCode": "10Perc",
  "VoucherType": 1,
  "WebStoreCode": null,
  "WebStoreInstanceCode": "GlobalEDefaultStoreInstance"
}
'

import requests

url = "https://{merchant_site_domain}/checkout-validate-cart-voucher-url"

payload = {
    "CartHash": "",
    "CartId": "36048",
    "CartToken": "f8a78edd-7cea-4cb7-835c-57c7f0b13c56",
    "CountryCode": "IL",
    "CurrencyCode": "ILS",
    "Discounts": [],
    "FreeShippingCouponCode": "",
    "IsFreeShipping": False,
    "MerchantGUID": "e967e65e-f69e-479c-949d-91289a7f6875",
    "Products": [],
    "UserId": None,
    "VoucherCode": "10Perc",
    "VoucherType": 1,
    "WebStoreCode": None,
    "WebStoreInstanceCode": "GlobalEDefaultStoreInstance"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    CartHash: '',
    CartId: '36048',
    CartToken: 'f8a78edd-7cea-4cb7-835c-57c7f0b13c56',
    CountryCode: 'IL',
    CurrencyCode: 'ILS',
    Discounts: [],
    FreeShippingCouponCode: '',
    IsFreeShipping: false,
    MerchantGUID: 'e967e65e-f69e-479c-949d-91289a7f6875',
    Products: [],
    UserId: null,
    VoucherCode: '10Perc',
    VoucherType: 1,
    WebStoreCode: null,
    WebStoreInstanceCode: 'GlobalEDefaultStoreInstance'
  })
};

fetch('https://{merchant_site_domain}/checkout-validate-cart-voucher-url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{merchant_site_domain}/checkout-validate-cart-voucher-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'CartHash' => '',
    'CartId' => '36048',
    'CartToken' => 'f8a78edd-7cea-4cb7-835c-57c7f0b13c56',
    'CountryCode' => 'IL',
    'CurrencyCode' => 'ILS',
    'Discounts' => [
        
    ],
    'FreeShippingCouponCode' => '',
    'IsFreeShipping' => false,
    'MerchantGUID' => 'e967e65e-f69e-479c-949d-91289a7f6875',
    'Products' => [
        
    ],
    'UserId' => null,
    'VoucherCode' => '10Perc',
    'VoucherType' => 1,
    'WebStoreCode' => null,
    'WebStoreInstanceCode' => 'GlobalEDefaultStoreInstance'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{merchant_site_domain}/checkout-validate-cart-voucher-url"

	payload := strings.NewReader("{\n  \"CartHash\": \"\",\n  \"CartId\": \"36048\",\n  \"CartToken\": \"f8a78edd-7cea-4cb7-835c-57c7f0b13c56\",\n  \"CountryCode\": \"IL\",\n  \"CurrencyCode\": \"ILS\",\n  \"Discounts\": [],\n  \"FreeShippingCouponCode\": \"\",\n  \"IsFreeShipping\": false,\n  \"MerchantGUID\": \"e967e65e-f69e-479c-949d-91289a7f6875\",\n  \"Products\": [],\n  \"UserId\": null,\n  \"VoucherCode\": \"10Perc\",\n  \"VoucherType\": 1,\n  \"WebStoreCode\": null,\n  \"WebStoreInstanceCode\": \"GlobalEDefaultStoreInstance\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{merchant_site_domain}/checkout-validate-cart-voucher-url")
  .header("Content-Type", "application/json")
  .body("{\n  \"CartHash\": \"\",\n  \"CartId\": \"36048\",\n  \"CartToken\": \"f8a78edd-7cea-4cb7-835c-57c7f0b13c56\",\n  \"CountryCode\": \"IL\",\n  \"CurrencyCode\": \"ILS\",\n  \"Discounts\": [],\n  \"FreeShippingCouponCode\": \"\",\n  \"IsFreeShipping\": false,\n  \"MerchantGUID\": \"e967e65e-f69e-479c-949d-91289a7f6875\",\n  \"Products\": [],\n  \"UserId\": null,\n  \"VoucherCode\": \"10Perc\",\n  \"VoucherType\": 1,\n  \"WebStoreCode\": null,\n  \"WebStoreInstanceCode\": \"GlobalEDefaultStoreInstance\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{merchant_site_domain}/checkout-validate-cart-voucher-url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"CartHash\": \"\",\n  \"CartId\": \"36048\",\n  \"CartToken\": \"f8a78edd-7cea-4cb7-835c-57c7f0b13c56\",\n  \"CountryCode\": \"IL\",\n  \"CurrencyCode\": \"ILS\",\n  \"Discounts\": [],\n  \"FreeShippingCouponCode\": \"\",\n  \"IsFreeShipping\": false,\n  \"MerchantGUID\": \"e967e65e-f69e-479c-949d-91289a7f6875\",\n  \"Products\": [],\n  \"UserId\": null,\n  \"VoucherCode\": \"10Perc\",\n  \"VoucherType\": 1,\n  \"WebStoreCode\": null,\n  \"WebStoreInstanceCode\": \"GlobalEDefaultStoreInstance\"\n}"

response = http.request(request)
puts response.read_body

{
  "IsVoucherValid": true,
  "VoucherType": 1,
  "CartToken": "f8a78edd-7cea-4cb7-835c-57c7f0b13c56",
  "VoucherValidationRestriction": [],
  "ValidationFaliureMessage": ""
}

This API is part of Global-e’s extensions and plug-ins. Merchants do not need to implement this API unless a custom integration is required.

This API returns new CartToken in the CartToken attribute. The API call is used to help validate vouchers/coupons used on the Checkout page. If the voucher is valid, the merchant’s platform is responsible for applying this voucher to the shopper’s basket and executing a new SendCart / SendCartV2 API call to Global‑e, with an indication of the newly generated discount for this voucher or coupon. The new CartToken returned from this call is returned in the CartToken attribute.

Body

application/json

Provides information related to validating a voucher in a cart.

CartHash

string

Cart hash originally specified in merchantCartHash argument for SendCart method for the cart converted to this order on Global‑e.

CartId

string

Identifier of the cart on the Merchant’s site originally specified in merchantCartToken argument for SendCart method for the cart converted to this order on Global‑e.

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.

CountryCode

string

2-char ISO country code

CurrencyCode

string

3-char ISO currency code.

Discounts

Merchant.DiscountVoucherValidation · object[]

Cart discounts for voucher validation.

Show child attributes

FreeShippingCouponCode

string

The Merchant free shipping coupon code applied by the end customer.

IsFreeShipping

boolean

Indicates if the Merchant offers free international shipping to the end customer.

MerchantGUID

string

Unique identifier of the Merchant on Global-e.

Products

Merchant.ProductVoucherValidation · object[]

Cart products for voucher validation.

Show child attributes

UserId

string | null

Internal User identifier on the Merchant’s site in case it was specified in the SendCart call.

VoucherCode

string

The voucher code specified on the Merchant site.

VoucherType

number

Enumeration of VoucherTypes: 1 - DiscountVoucher

WebStoreCode

string | null

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

Provides information related to the voucher validation.

CartToken

string

CartToken returned from the new SendCart / SendCartV2 API call, executed after the voucher has been applied to the respective user’s basket

IsVoucherValid

boolean

Indicates if the voucher is valid. TRUE - Voucher is valid. FALSE - Voucher is not valid.

ValidationFaliureMessage

string

Error message in case voucher is not valid

VoucherRestrictions

Merchant.VoucherValidationRestriction · object[]

List of validation restrictions applied to vouchers

Show child attributes

VoucherType

number

Enumeration of VoucherTypes: 1 - DiscountVoucher

⌘I

Overview

Shipping

Orders

Returns

Gift Cards

Checkout

Pricing

Browsing & Catalog

Webhooks

Shared Objects

ValidateVoucher (Global-e to Merchant)

Body

Response