Update Order Dispatch
curl --request POST \
--url https://{globale_api_domain}/Order/UpdateOrderDispatch \
--header 'Content-Type: application/json' \
--data '
{
"OrderId": "GE123874638GB",
"MerchantOrderId": "100018322",
"DeliveryReferenceNumber": "123756483",
"IsCompleted": false,
"Parcels": [
{
"ParcelCode": "123454321",
"Products": [
{
"DeliveryQuantity": 1,
"CartItemId": "12365",
"ProductCode": "121212"
},
{
"DeliveryQuantity": 2,
"CartItemId": "12376",
"ProductCode": "131313"
}
]
}
],
"Exceptions": [
{
"CartItemId": "12366",
"ProductCode": "121213",
"ExceptionType": 1,
"Quantity": 1
},
{
"CartItemId": "12367",
"ProductCode": "121214",
"ExceptionType": 2,
"ExpectedFulfilmentDate": "2018-01-18"
}
]
}
'import requests
url = "https://{globale_api_domain}/Order/UpdateOrderDispatch"
payload = {
"OrderId": "GE123874638GB",
"MerchantOrderId": "100018322",
"DeliveryReferenceNumber": "123756483",
"IsCompleted": False,
"Parcels": [
{
"ParcelCode": "123454321",
"Products": [
{
"DeliveryQuantity": 1,
"CartItemId": "12365",
"ProductCode": "121212"
},
{
"DeliveryQuantity": 2,
"CartItemId": "12376",
"ProductCode": "131313"
}
]
}
],
"Exceptions": [
{
"CartItemId": "12366",
"ProductCode": "121213",
"ExceptionType": 1,
"Quantity": 1
},
{
"CartItemId": "12367",
"ProductCode": "121214",
"ExceptionType": 2,
"ExpectedFulfilmentDate": "2018-01-18"
}
]
}
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({
OrderId: 'GE123874638GB',
MerchantOrderId: '100018322',
DeliveryReferenceNumber: '123756483',
IsCompleted: false,
Parcels: [
{
ParcelCode: '123454321',
Products: [
{DeliveryQuantity: 1, CartItemId: '12365', ProductCode: '121212'},
{DeliveryQuantity: 2, CartItemId: '12376', ProductCode: '131313'}
]
}
],
Exceptions: [
{CartItemId: '12366', ProductCode: '121213', ExceptionType: 1, Quantity: 1},
{
CartItemId: '12367',
ProductCode: '121214',
ExceptionType: 2,
ExpectedFulfilmentDate: '2018-01-18'
}
]
})
};
fetch('https://{globale_api_domain}/Order/UpdateOrderDispatch', 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}/Order/UpdateOrderDispatch",
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([
'OrderId' => 'GE123874638GB',
'MerchantOrderId' => '100018322',
'DeliveryReferenceNumber' => '123756483',
'IsCompleted' => false,
'Parcels' => [
[
'ParcelCode' => '123454321',
'Products' => [
[
'DeliveryQuantity' => 1,
'CartItemId' => '12365',
'ProductCode' => '121212'
],
[
'DeliveryQuantity' => 2,
'CartItemId' => '12376',
'ProductCode' => '131313'
]
]
]
],
'Exceptions' => [
[
'CartItemId' => '12366',
'ProductCode' => '121213',
'ExceptionType' => 1,
'Quantity' => 1
],
[
'CartItemId' => '12367',
'ProductCode' => '121214',
'ExceptionType' => 2,
'ExpectedFulfilmentDate' => '2018-01-18'
]
]
]),
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}/Order/UpdateOrderDispatch"
payload := strings.NewReader("{\n \"OrderId\": \"GE123874638GB\",\n \"MerchantOrderId\": \"100018322\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"IsCompleted\": false,\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"Products\": [\n {\n \"DeliveryQuantity\": 1,\n \"CartItemId\": \"12365\",\n \"ProductCode\": \"121212\"\n },\n {\n \"DeliveryQuantity\": 2,\n \"CartItemId\": \"12376\",\n \"ProductCode\": \"131313\"\n }\n ]\n }\n ],\n \"Exceptions\": [\n {\n \"CartItemId\": \"12366\",\n \"ProductCode\": \"121213\",\n \"ExceptionType\": 1,\n \"Quantity\": 1\n },\n {\n \"CartItemId\": \"12367\",\n \"ProductCode\": \"121214\",\n \"ExceptionType\": 2,\n \"ExpectedFulfilmentDate\": \"2018-01-18\"\n }\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}/Order/UpdateOrderDispatch")
.header("Content-Type", "application/json")
.body("{\n \"OrderId\": \"GE123874638GB\",\n \"MerchantOrderId\": \"100018322\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"IsCompleted\": false,\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"Products\": [\n {\n \"DeliveryQuantity\": 1,\n \"CartItemId\": \"12365\",\n \"ProductCode\": \"121212\"\n },\n {\n \"DeliveryQuantity\": 2,\n \"CartItemId\": \"12376\",\n \"ProductCode\": \"131313\"\n }\n ]\n }\n ],\n \"Exceptions\": [\n {\n \"CartItemId\": \"12366\",\n \"ProductCode\": \"121213\",\n \"ExceptionType\": 1,\n \"Quantity\": 1\n },\n {\n \"CartItemId\": \"12367\",\n \"ProductCode\": \"121214\",\n \"ExceptionType\": 2,\n \"ExpectedFulfilmentDate\": \"2018-01-18\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{globale_api_domain}/Order/UpdateOrderDispatch")
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 \"OrderId\": \"GE123874638GB\",\n \"MerchantOrderId\": \"100018322\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"IsCompleted\": false,\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"Products\": [\n {\n \"DeliveryQuantity\": 1,\n \"CartItemId\": \"12365\",\n \"ProductCode\": \"121212\"\n },\n {\n \"DeliveryQuantity\": 2,\n \"CartItemId\": \"12376\",\n \"ProductCode\": \"131313\"\n }\n ]\n }\n ],\n \"Exceptions\": [\n {\n \"CartItemId\": \"12366\",\n \"ProductCode\": \"121213\",\n \"ExceptionType\": 1,\n \"Quantity\": 1\n },\n {\n \"CartItemId\": \"12367\",\n \"ProductCode\": \"121214\",\n \"ExceptionType\": 2,\n \"ExpectedFulfilmentDate\": \"2018-01-18\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"Success": true,
"Reason": "Operation description"
}Update Order Dispatch
This section describes the manifest shipping requirements sent by Merchants to Global‑e via API.
POST
/
Order
/
UpdateOrderDispatch
Update Order Dispatch
curl --request POST \
--url https://{globale_api_domain}/Order/UpdateOrderDispatch \
--header 'Content-Type: application/json' \
--data '
{
"OrderId": "GE123874638GB",
"MerchantOrderId": "100018322",
"DeliveryReferenceNumber": "123756483",
"IsCompleted": false,
"Parcels": [
{
"ParcelCode": "123454321",
"Products": [
{
"DeliveryQuantity": 1,
"CartItemId": "12365",
"ProductCode": "121212"
},
{
"DeliveryQuantity": 2,
"CartItemId": "12376",
"ProductCode": "131313"
}
]
}
],
"Exceptions": [
{
"CartItemId": "12366",
"ProductCode": "121213",
"ExceptionType": 1,
"Quantity": 1
},
{
"CartItemId": "12367",
"ProductCode": "121214",
"ExceptionType": 2,
"ExpectedFulfilmentDate": "2018-01-18"
}
]
}
'import requests
url = "https://{globale_api_domain}/Order/UpdateOrderDispatch"
payload = {
"OrderId": "GE123874638GB",
"MerchantOrderId": "100018322",
"DeliveryReferenceNumber": "123756483",
"IsCompleted": False,
"Parcels": [
{
"ParcelCode": "123454321",
"Products": [
{
"DeliveryQuantity": 1,
"CartItemId": "12365",
"ProductCode": "121212"
},
{
"DeliveryQuantity": 2,
"CartItemId": "12376",
"ProductCode": "131313"
}
]
}
],
"Exceptions": [
{
"CartItemId": "12366",
"ProductCode": "121213",
"ExceptionType": 1,
"Quantity": 1
},
{
"CartItemId": "12367",
"ProductCode": "121214",
"ExceptionType": 2,
"ExpectedFulfilmentDate": "2018-01-18"
}
]
}
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({
OrderId: 'GE123874638GB',
MerchantOrderId: '100018322',
DeliveryReferenceNumber: '123756483',
IsCompleted: false,
Parcels: [
{
ParcelCode: '123454321',
Products: [
{DeliveryQuantity: 1, CartItemId: '12365', ProductCode: '121212'},
{DeliveryQuantity: 2, CartItemId: '12376', ProductCode: '131313'}
]
}
],
Exceptions: [
{CartItemId: '12366', ProductCode: '121213', ExceptionType: 1, Quantity: 1},
{
CartItemId: '12367',
ProductCode: '121214',
ExceptionType: 2,
ExpectedFulfilmentDate: '2018-01-18'
}
]
})
};
fetch('https://{globale_api_domain}/Order/UpdateOrderDispatch', 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}/Order/UpdateOrderDispatch",
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([
'OrderId' => 'GE123874638GB',
'MerchantOrderId' => '100018322',
'DeliveryReferenceNumber' => '123756483',
'IsCompleted' => false,
'Parcels' => [
[
'ParcelCode' => '123454321',
'Products' => [
[
'DeliveryQuantity' => 1,
'CartItemId' => '12365',
'ProductCode' => '121212'
],
[
'DeliveryQuantity' => 2,
'CartItemId' => '12376',
'ProductCode' => '131313'
]
]
]
],
'Exceptions' => [
[
'CartItemId' => '12366',
'ProductCode' => '121213',
'ExceptionType' => 1,
'Quantity' => 1
],
[
'CartItemId' => '12367',
'ProductCode' => '121214',
'ExceptionType' => 2,
'ExpectedFulfilmentDate' => '2018-01-18'
]
]
]),
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}/Order/UpdateOrderDispatch"
payload := strings.NewReader("{\n \"OrderId\": \"GE123874638GB\",\n \"MerchantOrderId\": \"100018322\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"IsCompleted\": false,\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"Products\": [\n {\n \"DeliveryQuantity\": 1,\n \"CartItemId\": \"12365\",\n \"ProductCode\": \"121212\"\n },\n {\n \"DeliveryQuantity\": 2,\n \"CartItemId\": \"12376\",\n \"ProductCode\": \"131313\"\n }\n ]\n }\n ],\n \"Exceptions\": [\n {\n \"CartItemId\": \"12366\",\n \"ProductCode\": \"121213\",\n \"ExceptionType\": 1,\n \"Quantity\": 1\n },\n {\n \"CartItemId\": \"12367\",\n \"ProductCode\": \"121214\",\n \"ExceptionType\": 2,\n \"ExpectedFulfilmentDate\": \"2018-01-18\"\n }\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}/Order/UpdateOrderDispatch")
.header("Content-Type", "application/json")
.body("{\n \"OrderId\": \"GE123874638GB\",\n \"MerchantOrderId\": \"100018322\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"IsCompleted\": false,\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"Products\": [\n {\n \"DeliveryQuantity\": 1,\n \"CartItemId\": \"12365\",\n \"ProductCode\": \"121212\"\n },\n {\n \"DeliveryQuantity\": 2,\n \"CartItemId\": \"12376\",\n \"ProductCode\": \"131313\"\n }\n ]\n }\n ],\n \"Exceptions\": [\n {\n \"CartItemId\": \"12366\",\n \"ProductCode\": \"121213\",\n \"ExceptionType\": 1,\n \"Quantity\": 1\n },\n {\n \"CartItemId\": \"12367\",\n \"ProductCode\": \"121214\",\n \"ExceptionType\": 2,\n \"ExpectedFulfilmentDate\": \"2018-01-18\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{globale_api_domain}/Order/UpdateOrderDispatch")
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 \"OrderId\": \"GE123874638GB\",\n \"MerchantOrderId\": \"100018322\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"IsCompleted\": false,\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"Products\": [\n {\n \"DeliveryQuantity\": 1,\n \"CartItemId\": \"12365\",\n \"ProductCode\": \"121212\"\n },\n {\n \"DeliveryQuantity\": 2,\n \"CartItemId\": \"12376\",\n \"ProductCode\": \"131313\"\n }\n ]\n }\n ],\n \"Exceptions\": [\n {\n \"CartItemId\": \"12366\",\n \"ProductCode\": \"121213\",\n \"ExceptionType\": 1,\n \"Quantity\": 1\n },\n {\n \"CartItemId\": \"12367\",\n \"ProductCode\": \"121214\",\n \"ExceptionType\": 2,\n \"ExpectedFulfilmentDate\": \"2018-01-18\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"Success": true,
"Reason": "Operation description"
}Part of the Dispatch Notifications integration guide — see it for when and how to use this endpoint.
Body
application/json
Global‑e Order ID (starting with "GE"). One of OrderId or MerchantOrderId is required.
Merchant order ID as recorded in the ecommerce platform. One of OrderId or MerchantOrderId is required.
Additional informative dispatch reference (optional).
When true, all items not already declared as part of a parcel will be cancelled and refunded. Until true, consolidation of parcels is expected if no backorders are present. If backorder exceptions are specified, not required — allows dispatch of existing parcels without delay.
List of parcels being dispatched. May be an empty array.
Show child attributes
Show child attributes
List of item exceptions (out-of-stock, backorder, or cancellation). May be an empty array or null.
Show child attributes
Show child attributes
Response
Success or object-processing failure. Check the Success field to distinguish. A true value confirms receipt and first-level validation; processing of nested attributes is asynchronous.