UpdateOrderDispatchV2
curl --request POST \
--url https://{globale_api_domain}/Order/UpdateOrderDispatchV2 \
--header 'Content-Type: application/json' \
--data '
{
"OrderId": "GE123874638GB",
"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/UpdateOrderDispatchV2"
payload = {
"OrderId": "GE123874638GB",
"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',
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/UpdateOrderDispatchV2', 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/UpdateOrderDispatchV2",
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',
'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/UpdateOrderDispatchV2"
payload := strings.NewReader("{\n \"OrderId\": \"GE123874638GB\",\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/UpdateOrderDispatchV2")
.header("Content-Type", "application/json")
.body("{\n \"OrderId\": \"GE123874638GB\",\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/UpdateOrderDispatchV2")
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 \"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"
}
UpdateOrderDispatchV2
Updates the order status and Delivery Quantities for the products, as well as the Merchant’s internal Delivery Reference Number, if applicable. You can also add tracking information on each parcel or on the entire order. Optionally, you can include the list of Parcels with Products for this order shipment to the Global-e hub, exceptions to report on out-of-stock items, and items that will be shipped later on.
POST
/
Order
/
UpdateOrderDispatchV2
UpdateOrderDispatchV2
curl --request POST \
--url https://{globale_api_domain}/Order/UpdateOrderDispatchV2 \
--header 'Content-Type: application/json' \
--data '
{
"OrderId": "GE123874638GB",
"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/UpdateOrderDispatchV2"
payload = {
"OrderId": "GE123874638GB",
"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',
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/UpdateOrderDispatchV2', 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/UpdateOrderDispatchV2",
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',
'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/UpdateOrderDispatchV2"
payload := strings.NewReader("{\n \"OrderId\": \"GE123874638GB\",\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/UpdateOrderDispatchV2")
.header("Content-Type", "application/json")
.body("{\n \"OrderId\": \"GE123874638GB\",\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/UpdateOrderDispatchV2")
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 \"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 unique identifier, or the order unique identifier on the Merchant's site.
Merchant's internal Delivery Reference Number for this order.
Flag to mark orders as "completed" by the Merchant. TRUE if order fulfillment has been completed and no more products will be shipped. FALSE if order fulfillment has not been completed yet.
List of Parcel objects for this UpdateOrderDispatchRequest. Note Either Parcels or Exceptions should be specified.
Show child attributes
Show child attributes
List of UpdateOrderDispatchException objects for this the UpdateOrderDispatchRequest. Note Either Parcels or Exceptions should be specified.
Show child attributes
Show child attributes
Tracking information at the order level of the parcel in case the Merchant does the shipping by itself.
Show child attributes
Show child attributes
Merchant hub code that indicates which hub the parcels are being sent from. Note The hubCode should be mapped to a Global-e hubId on the Global-e side.
Used if additional information is required for shipment. Currently, it is used for the ITN number when exporting from the US.
Shipping Method Code used for the order instead of the original one. The order should use a non-Global-e carrier and the input shipping method must also be Non-Global-e carrier. NOTE: The Shipping Method Code should be mapped to a Global-e Shipping Method on the Global-e side.
Response
Indicates if the API call was successful.