Create a replacement order
curl --request POST \
--url https://{globale_api_domain}/checkout/CreateOrder \
--header 'Content-Type: application/json' \
--data '
{
"orderReplacement": {
"replacedProducts": [
{
"quantity": 1,
"cartItemId": "1"
}
],
"originalOrderId": "GE10097473894NL"
},
"cartData": {
"products": [
{
"productCode": "460011778068",
"isFixedPrice": true,
"orderedQuantity": 1,
"salePrice": "17.90",
"cartItemId": "",
"parentCartItemId": "1"
}
],
"userDetails": {
"addressDetails": [
{
"email": "customer@example.com"
}
]
},
"discounts": [
{
"productCartItemId": "",
"discountType": 1,
"discountValue": 1.79
}
],
"shippingMethodCode": "",
"merchantOrderId": "Y73186844546755"
}
}
'import requests
url = "https://{globale_api_domain}/checkout/CreateOrder"
payload = {
"orderReplacement": {
"replacedProducts": [
{
"quantity": 1,
"cartItemId": "1"
}
],
"originalOrderId": "GE10097473894NL"
},
"cartData": {
"products": [
{
"productCode": "460011778068",
"isFixedPrice": True,
"orderedQuantity": 1,
"salePrice": "17.90",
"cartItemId": "",
"parentCartItemId": "1"
}
],
"userDetails": { "addressDetails": [{ "email": "customer@example.com" }] },
"discounts": [
{
"productCartItemId": "",
"discountType": 1,
"discountValue": 1.79
}
],
"shippingMethodCode": "",
"merchantOrderId": "Y73186844546755"
}
}
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({
orderReplacement: {
replacedProducts: [{quantity: 1, cartItemId: '1'}],
originalOrderId: 'GE10097473894NL'
},
cartData: {
products: [
{
productCode: '460011778068',
isFixedPrice: true,
orderedQuantity: 1,
salePrice: '17.90',
cartItemId: '',
parentCartItemId: '1'
}
],
userDetails: {addressDetails: [{email: 'customer@example.com'}]},
discounts: [{productCartItemId: '', discountType: 1, discountValue: 1.79}],
shippingMethodCode: '',
merchantOrderId: 'Y73186844546755'
}
})
};
fetch('https://{globale_api_domain}/checkout/CreateOrder', 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://{globale_api_domain}/checkout/CreateOrder",
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([
'orderReplacement' => [
'replacedProducts' => [
[
'quantity' => 1,
'cartItemId' => '1'
]
],
'originalOrderId' => 'GE10097473894NL'
],
'cartData' => [
'products' => [
[
'productCode' => '460011778068',
'isFixedPrice' => true,
'orderedQuantity' => 1,
'salePrice' => '17.90',
'cartItemId' => '',
'parentCartItemId' => '1'
]
],
'userDetails' => [
'addressDetails' => [
[
'email' => 'customer@example.com'
]
]
],
'discounts' => [
[
'productCartItemId' => '',
'discountType' => 1,
'discountValue' => 1.79
]
],
'shippingMethodCode' => '',
'merchantOrderId' => 'Y73186844546755'
]
]),
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://{globale_api_domain}/checkout/CreateOrder"
payload := strings.NewReader("{\n \"orderReplacement\": {\n \"replacedProducts\": [\n {\n \"quantity\": 1,\n \"cartItemId\": \"1\"\n }\n ],\n \"originalOrderId\": \"GE10097473894NL\"\n },\n \"cartData\": {\n \"products\": [\n {\n \"productCode\": \"460011778068\",\n \"isFixedPrice\": true,\n \"orderedQuantity\": 1,\n \"salePrice\": \"17.90\",\n \"cartItemId\": \"\",\n \"parentCartItemId\": \"1\"\n }\n ],\n \"userDetails\": {\n \"addressDetails\": [\n {\n \"email\": \"customer@example.com\"\n }\n ]\n },\n \"discounts\": [\n {\n \"productCartItemId\": \"\",\n \"discountType\": 1,\n \"discountValue\": 1.79\n }\n ],\n \"shippingMethodCode\": \"\",\n \"merchantOrderId\": \"Y73186844546755\"\n }\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://{globale_api_domain}/checkout/CreateOrder")
.header("Content-Type", "application/json")
.body("{\n \"orderReplacement\": {\n \"replacedProducts\": [\n {\n \"quantity\": 1,\n \"cartItemId\": \"1\"\n }\n ],\n \"originalOrderId\": \"GE10097473894NL\"\n },\n \"cartData\": {\n \"products\": [\n {\n \"productCode\": \"460011778068\",\n \"isFixedPrice\": true,\n \"orderedQuantity\": 1,\n \"salePrice\": \"17.90\",\n \"cartItemId\": \"\",\n \"parentCartItemId\": \"1\"\n }\n ],\n \"userDetails\": {\n \"addressDetails\": [\n {\n \"email\": \"customer@example.com\"\n }\n ]\n },\n \"discounts\": [\n {\n \"productCartItemId\": \"\",\n \"discountType\": 1,\n \"discountValue\": 1.79\n }\n ],\n \"shippingMethodCode\": \"\",\n \"merchantOrderId\": \"Y73186844546755\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{globale_api_domain}/checkout/CreateOrder")
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 \"orderReplacement\": {\n \"replacedProducts\": [\n {\n \"quantity\": 1,\n \"cartItemId\": \"1\"\n }\n ],\n \"originalOrderId\": \"GE10097473894NL\"\n },\n \"cartData\": {\n \"products\": [\n {\n \"productCode\": \"460011778068\",\n \"isFixedPrice\": true,\n \"orderedQuantity\": 1,\n \"salePrice\": \"17.90\",\n \"cartItemId\": \"\",\n \"parentCartItemId\": \"1\"\n }\n ],\n \"userDetails\": {\n \"addressDetails\": [\n {\n \"email\": \"customer@example.com\"\n }\n ]\n },\n \"discounts\": [\n {\n \"productCartItemId\": \"\",\n \"discountType\": 1,\n \"discountValue\": 1.79\n }\n ],\n \"shippingMethodCode\": \"\",\n \"merchantOrderId\": \"Y73186844546755\"\n }\n}"
response = http.request(request)
puts response.read_body{
"OrderId": "GE10098224286NL",
"MerchantOrderId": "Y73186844546755",
"MerchantInternalOrderId": null,
"IsReplacementOrder": true,
"OriginalOrder": {
"OrderId": "GE10097473894NL",
"MerchantOrderId": "EUQA1116048",
"MerchantInternalOrderId": "EUQA1116048"
},
"CurrencyCode": "EUR",
"CurrencyName": "Euro",
"IsFreeShipping": true,
"ShippingMethodCode": "globaleintegration_standard",
"HubId": 1001034,
"InternationalDetails": {
"CurrencyCode": "EUR",
"TotalPrice": 16.11,
"TotalShippingPrice": -19.9,
"ShippingMethodCode": "GLOBALE",
"ShippingMethodName": "DHL api Express Worldwide",
"PaymentMethodCode": "39",
"PaymentMethodName": "CouponPayment",
"DutiesGuaranteed": false,
"ShippingMethodTypeCode": "Standard",
"ShippingMethodTypeName": "Standard Courier",
"DeliveryDaysFrom": 1,
"DeliveryDaysTo": 2
},
"OrderDocuments": [
{
"URL": "https://connect2.bglobale.com/Document/VATInvoice?documentParam=...",
"DocumentTypeCode": "5",
"DocumentTypeName": "VATInvoice",
"DocumentExtension": "pdf",
"ErrorMessage": null
}
]
}Orders
Create order
The CreateOrder API is used to create a replacement order in Global-e.
POST
/
checkout
/
CreateOrder
Create a replacement order
curl --request POST \
--url https://{globale_api_domain}/checkout/CreateOrder \
--header 'Content-Type: application/json' \
--data '
{
"orderReplacement": {
"replacedProducts": [
{
"quantity": 1,
"cartItemId": "1"
}
],
"originalOrderId": "GE10097473894NL"
},
"cartData": {
"products": [
{
"productCode": "460011778068",
"isFixedPrice": true,
"orderedQuantity": 1,
"salePrice": "17.90",
"cartItemId": "",
"parentCartItemId": "1"
}
],
"userDetails": {
"addressDetails": [
{
"email": "customer@example.com"
}
]
},
"discounts": [
{
"productCartItemId": "",
"discountType": 1,
"discountValue": 1.79
}
],
"shippingMethodCode": "",
"merchantOrderId": "Y73186844546755"
}
}
'import requests
url = "https://{globale_api_domain}/checkout/CreateOrder"
payload = {
"orderReplacement": {
"replacedProducts": [
{
"quantity": 1,
"cartItemId": "1"
}
],
"originalOrderId": "GE10097473894NL"
},
"cartData": {
"products": [
{
"productCode": "460011778068",
"isFixedPrice": True,
"orderedQuantity": 1,
"salePrice": "17.90",
"cartItemId": "",
"parentCartItemId": "1"
}
],
"userDetails": { "addressDetails": [{ "email": "customer@example.com" }] },
"discounts": [
{
"productCartItemId": "",
"discountType": 1,
"discountValue": 1.79
}
],
"shippingMethodCode": "",
"merchantOrderId": "Y73186844546755"
}
}
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({
orderReplacement: {
replacedProducts: [{quantity: 1, cartItemId: '1'}],
originalOrderId: 'GE10097473894NL'
},
cartData: {
products: [
{
productCode: '460011778068',
isFixedPrice: true,
orderedQuantity: 1,
salePrice: '17.90',
cartItemId: '',
parentCartItemId: '1'
}
],
userDetails: {addressDetails: [{email: 'customer@example.com'}]},
discounts: [{productCartItemId: '', discountType: 1, discountValue: 1.79}],
shippingMethodCode: '',
merchantOrderId: 'Y73186844546755'
}
})
};
fetch('https://{globale_api_domain}/checkout/CreateOrder', 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://{globale_api_domain}/checkout/CreateOrder",
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([
'orderReplacement' => [
'replacedProducts' => [
[
'quantity' => 1,
'cartItemId' => '1'
]
],
'originalOrderId' => 'GE10097473894NL'
],
'cartData' => [
'products' => [
[
'productCode' => '460011778068',
'isFixedPrice' => true,
'orderedQuantity' => 1,
'salePrice' => '17.90',
'cartItemId' => '',
'parentCartItemId' => '1'
]
],
'userDetails' => [
'addressDetails' => [
[
'email' => 'customer@example.com'
]
]
],
'discounts' => [
[
'productCartItemId' => '',
'discountType' => 1,
'discountValue' => 1.79
]
],
'shippingMethodCode' => '',
'merchantOrderId' => 'Y73186844546755'
]
]),
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://{globale_api_domain}/checkout/CreateOrder"
payload := strings.NewReader("{\n \"orderReplacement\": {\n \"replacedProducts\": [\n {\n \"quantity\": 1,\n \"cartItemId\": \"1\"\n }\n ],\n \"originalOrderId\": \"GE10097473894NL\"\n },\n \"cartData\": {\n \"products\": [\n {\n \"productCode\": \"460011778068\",\n \"isFixedPrice\": true,\n \"orderedQuantity\": 1,\n \"salePrice\": \"17.90\",\n \"cartItemId\": \"\",\n \"parentCartItemId\": \"1\"\n }\n ],\n \"userDetails\": {\n \"addressDetails\": [\n {\n \"email\": \"customer@example.com\"\n }\n ]\n },\n \"discounts\": [\n {\n \"productCartItemId\": \"\",\n \"discountType\": 1,\n \"discountValue\": 1.79\n }\n ],\n \"shippingMethodCode\": \"\",\n \"merchantOrderId\": \"Y73186844546755\"\n }\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://{globale_api_domain}/checkout/CreateOrder")
.header("Content-Type", "application/json")
.body("{\n \"orderReplacement\": {\n \"replacedProducts\": [\n {\n \"quantity\": 1,\n \"cartItemId\": \"1\"\n }\n ],\n \"originalOrderId\": \"GE10097473894NL\"\n },\n \"cartData\": {\n \"products\": [\n {\n \"productCode\": \"460011778068\",\n \"isFixedPrice\": true,\n \"orderedQuantity\": 1,\n \"salePrice\": \"17.90\",\n \"cartItemId\": \"\",\n \"parentCartItemId\": \"1\"\n }\n ],\n \"userDetails\": {\n \"addressDetails\": [\n {\n \"email\": \"customer@example.com\"\n }\n ]\n },\n \"discounts\": [\n {\n \"productCartItemId\": \"\",\n \"discountType\": 1,\n \"discountValue\": 1.79\n }\n ],\n \"shippingMethodCode\": \"\",\n \"merchantOrderId\": \"Y73186844546755\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{globale_api_domain}/checkout/CreateOrder")
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 \"orderReplacement\": {\n \"replacedProducts\": [\n {\n \"quantity\": 1,\n \"cartItemId\": \"1\"\n }\n ],\n \"originalOrderId\": \"GE10097473894NL\"\n },\n \"cartData\": {\n \"products\": [\n {\n \"productCode\": \"460011778068\",\n \"isFixedPrice\": true,\n \"orderedQuantity\": 1,\n \"salePrice\": \"17.90\",\n \"cartItemId\": \"\",\n \"parentCartItemId\": \"1\"\n }\n ],\n \"userDetails\": {\n \"addressDetails\": [\n {\n \"email\": \"customer@example.com\"\n }\n ]\n },\n \"discounts\": [\n {\n \"productCartItemId\": \"\",\n \"discountType\": 1,\n \"discountValue\": 1.79\n }\n ],\n \"shippingMethodCode\": \"\",\n \"merchantOrderId\": \"Y73186844546755\"\n }\n}"
response = http.request(request)
puts response.read_body{
"OrderId": "GE10098224286NL",
"MerchantOrderId": "Y73186844546755",
"MerchantInternalOrderId": null,
"IsReplacementOrder": true,
"OriginalOrder": {
"OrderId": "GE10097473894NL",
"MerchantOrderId": "EUQA1116048",
"MerchantInternalOrderId": "EUQA1116048"
},
"CurrencyCode": "EUR",
"CurrencyName": "Euro",
"IsFreeShipping": true,
"ShippingMethodCode": "globaleintegration_standard",
"HubId": 1001034,
"InternationalDetails": {
"CurrencyCode": "EUR",
"TotalPrice": 16.11,
"TotalShippingPrice": -19.9,
"ShippingMethodCode": "GLOBALE",
"ShippingMethodName": "DHL api Express Worldwide",
"PaymentMethodCode": "39",
"PaymentMethodName": "CouponPayment",
"DutiesGuaranteed": false,
"ShippingMethodTypeCode": "Standard",
"ShippingMethodTypeName": "Standard Courier",
"DeliveryDaysFrom": 1,
"DeliveryDaysTo": 2
},
"OrderDocuments": [
{
"URL": "https://connect2.bglobale.com/Document/VATInvoice?documentParam=...",
"DocumentTypeCode": "5",
"DocumentTypeName": "VATInvoice",
"DocumentExtension": "pdf",
"ErrorMessage": null
}
]
}Part of the CreateOrder integration guide — see it for when and how to use this endpoint.
Body
application/json
Cart data for the new replacement order creation.
Show child attributes
Show child attributes
Replaced order and product information.
Show child attributes
Show child attributes
Replacement shipping method code; if empty, the original service level is used.
Response
200 - application/json
Replacement order created successfully.
Response to a successful CreateOrder call. No response field table is documented on the page — top-level fields are modeled from the response JSON example; nested objects are typed where their structure is evident.
Global-e order identifier.
Merchant order identifier.
Merchant internal order identifier.
Indicates this is a replacement order.
The original order this replaces.
Show child attributes
Show child attributes
3-character ISO currency code.
Currency name.
Products in the replacement order.
Discounts applied to the order.
Markups applied to the order (e.g. replacement shipping discount).
Indicates whether shipping is free for this order.
Shipping method code.
Global-e hub identifier.
International shipping, payment, and tracking details.
Show child attributes
Show child attributes
Documents generated for the order (e.g. VAT invoice).
Show child attributes
Show child attributes
⌘I