Get shipping documents
curl --request POST \
--url https://{globale_api_domain}/Order/GetShippingDocuments \
--header 'Content-Type: application/json' \
--data '
{
"OrderId": "GE123874638GB",
"HubCode": "hub001",
"DeliveryReferenceNumber": "123756483",
"Parcels": [
{
"ParcelCode": "123454321",
"ShippingAdditionalInformation": [
{
"name": "ITNNumber",
"value": "X202487492387"
}
],
"Products": [
{
"ProductCode": "sku121212",
"DeliveryQuantity": 1
},
{
"ProductCode": "sku131313",
"DeliveryQuantity": 2
}
]
}
]
}
'import requests
url = "https://{globale_api_domain}/Order/GetShippingDocuments"
payload = {
"OrderId": "GE123874638GB",
"HubCode": "hub001",
"DeliveryReferenceNumber": "123756483",
"Parcels": [
{
"ParcelCode": "123454321",
"ShippingAdditionalInformation": [
{
"name": "ITNNumber",
"value": "X202487492387"
}
],
"Products": [
{
"ProductCode": "sku121212",
"DeliveryQuantity": 1
},
{
"ProductCode": "sku131313",
"DeliveryQuantity": 2
}
]
}
]
}
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',
HubCode: 'hub001',
DeliveryReferenceNumber: '123756483',
Parcels: [
{
ParcelCode: '123454321',
ShippingAdditionalInformation: [{name: 'ITNNumber', value: 'X202487492387'}],
Products: [
{ProductCode: 'sku121212', DeliveryQuantity: 1},
{ProductCode: 'sku131313', DeliveryQuantity: 2}
]
}
]
})
};
fetch('https://{globale_api_domain}/Order/GetShippingDocuments', 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/GetShippingDocuments",
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',
'HubCode' => 'hub001',
'DeliveryReferenceNumber' => '123756483',
'Parcels' => [
[
'ParcelCode' => '123454321',
'ShippingAdditionalInformation' => [
[
'name' => 'ITNNumber',
'value' => 'X202487492387'
]
],
'Products' => [
[
'ProductCode' => 'sku121212',
'DeliveryQuantity' => 1
],
[
'ProductCode' => 'sku131313',
'DeliveryQuantity' => 2
]
]
]
]
]),
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/GetShippingDocuments"
payload := strings.NewReader("{\n \"OrderId\": \"GE123874638GB\",\n \"HubCode\": \"hub001\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"ShippingAdditionalInformation\": [\n {\n \"name\": \"ITNNumber\",\n \"value\": \"X202487492387\"\n }\n ],\n \"Products\": [\n {\n \"ProductCode\": \"sku121212\",\n \"DeliveryQuantity\": 1\n },\n {\n \"ProductCode\": \"sku131313\",\n \"DeliveryQuantity\": 2\n }\n ]\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/GetShippingDocuments")
.header("Content-Type", "application/json")
.body("{\n \"OrderId\": \"GE123874638GB\",\n \"HubCode\": \"hub001\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"ShippingAdditionalInformation\": [\n {\n \"name\": \"ITNNumber\",\n \"value\": \"X202487492387\"\n }\n ],\n \"Products\": [\n {\n \"ProductCode\": \"sku121212\",\n \"DeliveryQuantity\": 1\n },\n {\n \"ProductCode\": \"sku131313\",\n \"DeliveryQuantity\": 2\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{globale_api_domain}/Order/GetShippingDocuments")
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 \"HubCode\": \"hub001\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"ShippingAdditionalInformation\": [\n {\n \"name\": \"ITNNumber\",\n \"value\": \"X202487492387\"\n }\n ],\n \"Products\": [\n {\n \"ProductCode\": \"sku121212\",\n \"DeliveryQuantity\": 1\n },\n {\n \"ProductCode\": \"sku131313\",\n \"DeliveryQuantity\": 2\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"IsSuccess": true,
"ErrorText": null,
"Documents": [
{
"DocumentTypeCode": "4",
"DocumentTypeName": "AWB",
"DocumentExtension": "zpl",
"URL": "https://assets.global-e.com/documents/478D-AA72-1EB8BBDD7C27.zpl",
"DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G"
},
{
"DocumentTypeCode": "1",
"DocumentTypeName": "CommercialInvoiceAndPackingList",
"DocumentExtension": "pdf",
"URL": "https://assets.global-e.com/documents/AE09-FAB014DAA421.pdf",
"DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G",
"ErrorMessage": null
}
],
"ParcelsTracking": [
{
"ParcelTrackingNumber": "9895722141",
"ParcelTrackingUrl": "https://mydhl.express.dhl/us/en/tracking.html#/results?id=9895722141",
"ParcelCode": "123454321"
}
]
}Shipping
Get shipping documents
From the orders indicated as fulfilled with possible exceptions, the Global-e API will return the required shipping documentation as a base64 encoded byte array and URL for printing
POST
/
Order
/
GetShippingDocuments
Get shipping documents
curl --request POST \
--url https://{globale_api_domain}/Order/GetShippingDocuments \
--header 'Content-Type: application/json' \
--data '
{
"OrderId": "GE123874638GB",
"HubCode": "hub001",
"DeliveryReferenceNumber": "123756483",
"Parcels": [
{
"ParcelCode": "123454321",
"ShippingAdditionalInformation": [
{
"name": "ITNNumber",
"value": "X202487492387"
}
],
"Products": [
{
"ProductCode": "sku121212",
"DeliveryQuantity": 1
},
{
"ProductCode": "sku131313",
"DeliveryQuantity": 2
}
]
}
]
}
'import requests
url = "https://{globale_api_domain}/Order/GetShippingDocuments"
payload = {
"OrderId": "GE123874638GB",
"HubCode": "hub001",
"DeliveryReferenceNumber": "123756483",
"Parcels": [
{
"ParcelCode": "123454321",
"ShippingAdditionalInformation": [
{
"name": "ITNNumber",
"value": "X202487492387"
}
],
"Products": [
{
"ProductCode": "sku121212",
"DeliveryQuantity": 1
},
{
"ProductCode": "sku131313",
"DeliveryQuantity": 2
}
]
}
]
}
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',
HubCode: 'hub001',
DeliveryReferenceNumber: '123756483',
Parcels: [
{
ParcelCode: '123454321',
ShippingAdditionalInformation: [{name: 'ITNNumber', value: 'X202487492387'}],
Products: [
{ProductCode: 'sku121212', DeliveryQuantity: 1},
{ProductCode: 'sku131313', DeliveryQuantity: 2}
]
}
]
})
};
fetch('https://{globale_api_domain}/Order/GetShippingDocuments', 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/GetShippingDocuments",
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',
'HubCode' => 'hub001',
'DeliveryReferenceNumber' => '123756483',
'Parcels' => [
[
'ParcelCode' => '123454321',
'ShippingAdditionalInformation' => [
[
'name' => 'ITNNumber',
'value' => 'X202487492387'
]
],
'Products' => [
[
'ProductCode' => 'sku121212',
'DeliveryQuantity' => 1
],
[
'ProductCode' => 'sku131313',
'DeliveryQuantity' => 2
]
]
]
]
]),
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/GetShippingDocuments"
payload := strings.NewReader("{\n \"OrderId\": \"GE123874638GB\",\n \"HubCode\": \"hub001\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"ShippingAdditionalInformation\": [\n {\n \"name\": \"ITNNumber\",\n \"value\": \"X202487492387\"\n }\n ],\n \"Products\": [\n {\n \"ProductCode\": \"sku121212\",\n \"DeliveryQuantity\": 1\n },\n {\n \"ProductCode\": \"sku131313\",\n \"DeliveryQuantity\": 2\n }\n ]\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/GetShippingDocuments")
.header("Content-Type", "application/json")
.body("{\n \"OrderId\": \"GE123874638GB\",\n \"HubCode\": \"hub001\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"ShippingAdditionalInformation\": [\n {\n \"name\": \"ITNNumber\",\n \"value\": \"X202487492387\"\n }\n ],\n \"Products\": [\n {\n \"ProductCode\": \"sku121212\",\n \"DeliveryQuantity\": 1\n },\n {\n \"ProductCode\": \"sku131313\",\n \"DeliveryQuantity\": 2\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{globale_api_domain}/Order/GetShippingDocuments")
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 \"HubCode\": \"hub001\",\n \"DeliveryReferenceNumber\": \"123756483\",\n \"Parcels\": [\n {\n \"ParcelCode\": \"123454321\",\n \"ShippingAdditionalInformation\": [\n {\n \"name\": \"ITNNumber\",\n \"value\": \"X202487492387\"\n }\n ],\n \"Products\": [\n {\n \"ProductCode\": \"sku121212\",\n \"DeliveryQuantity\": 1\n },\n {\n \"ProductCode\": \"sku131313\",\n \"DeliveryQuantity\": 2\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"IsSuccess": true,
"ErrorText": null,
"Documents": [
{
"DocumentTypeCode": "4",
"DocumentTypeName": "AWB",
"DocumentExtension": "zpl",
"URL": "https://assets.global-e.com/documents/478D-AA72-1EB8BBDD7C27.zpl",
"DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G"
},
{
"DocumentTypeCode": "1",
"DocumentTypeName": "CommercialInvoiceAndPackingList",
"DocumentExtension": "pdf",
"URL": "https://assets.global-e.com/documents/AE09-FAB014DAA421.pdf",
"DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G",
"ErrorMessage": null
}
],
"ParcelsTracking": [
{
"ParcelTrackingNumber": "9895722141",
"ParcelTrackingUrl": "https://mydhl.express.dhl/us/en/tracking.html#/results?id=9895722141",
"ParcelCode": "123454321"
}
]
}Part of the Shipping Documents API integration guide — see it for when and how to use this endpoint.
Body
application/json
"eCommerce order number" as passed down in the order payload. For Shopify, should be either the Shopify Order Name (default), e.g. #12345; or the Shopify Order Number, e.g. 12345.
Show child attributes
Show child attributes
Additional informative dispatch reference.
When dispatching from multiple hubs, indicates for a given call which hub the related shipment will be dispatched from.
Response
Successful response, or a 200 carrying object-level processing errors (IsSuccess=false with the Errors array populated).
Indicates whether the API call was successful.
Description of the error for getting documents.
List of OrderDocument objects that hold the shipping documents.
Show child attributes
Show child attributes
The list of Merchant.ParcelTracking objects. Each object holds the parcel tracking number and the full tracking URL of the relevant shipper (with the parcel tracking number).
Show child attributes
Show child attributes
Order tracking information.
Show child attributes
Show child attributes
List of DeliveryAdviceInformation objects that hold the information required for the "Delivery Advice" document.
Show child attributes
Show child attributes
Object-level processing errors (returned with HTTP 200).
Show child attributes
Show child attributes
⌘I