SendAdditionalRequiredDocumentsToMerchant (Global-e to Merchant)
curl --request POST \
--url https://{merchant_site_domain}/send-additional-required-documents-url \
--header 'Content-Type: application/json' \
--data '
{
"OrderId": "Sample order id",
"MerchantOrderId": "Sample order id from the merchant’s system",
"CountryCode": "US",
"AdditionalRequiredDocuments": [
{
"TrackingNumber": "98789723874839",
"DocumentData": "base 64 string",
"URL": "URL do download document",
"DocumentTypeCode": "11",
"DocumentTypeName": "EAD",
"DocumentExtension": "pdf",
"DocumentReference": "24DE85123822923B8",
"CreationDateTime": "2024-01-30T10:55:21"
}
]
}
'import requests
url = "https://{merchant_site_domain}/send-additional-required-documents-url"
payload = {
"OrderId": "Sample order id",
"MerchantOrderId": "Sample order id from the merchant’s system",
"CountryCode": "US",
"AdditionalRequiredDocuments": [
{
"TrackingNumber": "98789723874839",
"DocumentData": "base 64 string",
"URL": "URL do download document",
"DocumentTypeCode": "11",
"DocumentTypeName": "EAD",
"DocumentExtension": "pdf",
"DocumentReference": "24DE85123822923B8",
"CreationDateTime": "2024-01-30T10:55:21"
}
]
}
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: 'Sample order id',
MerchantOrderId: 'Sample order id from the merchant’s system',
CountryCode: 'US',
AdditionalRequiredDocuments: [
{
TrackingNumber: '98789723874839',
DocumentData: 'base 64 string',
URL: 'URL do download document',
DocumentTypeCode: '11',
DocumentTypeName: 'EAD',
DocumentExtension: 'pdf',
DocumentReference: '24DE85123822923B8',
CreationDateTime: '2024-01-30T10:55:21'
}
]
})
};
fetch('https://{merchant_site_domain}/send-additional-required-documents-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}/send-additional-required-documents-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([
'OrderId' => 'Sample order id',
'MerchantOrderId' => 'Sample order id from the merchant’s system',
'CountryCode' => 'US',
'AdditionalRequiredDocuments' => [
[
'TrackingNumber' => '98789723874839',
'DocumentData' => 'base 64 string',
'URL' => 'URL do download document',
'DocumentTypeCode' => '11',
'DocumentTypeName' => 'EAD',
'DocumentExtension' => 'pdf',
'DocumentReference' => '24DE85123822923B8',
'CreationDateTime' => '2024-01-30T10:55:21'
]
]
]),
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}/send-additional-required-documents-url"
payload := strings.NewReader("{\n \"OrderId\": \"Sample order id\",\n \"MerchantOrderId\": \"Sample order id from the merchant’s system\",\n \"CountryCode\": \"US\",\n \"AdditionalRequiredDocuments\": [\n {\n \"TrackingNumber\": \"98789723874839\",\n \"DocumentData\": \"base 64 string\",\n \"URL\": \"URL do download document\",\n \"DocumentTypeCode\": \"11\",\n \"DocumentTypeName\": \"EAD\",\n \"DocumentExtension\": \"pdf\",\n \"DocumentReference\": \"24DE85123822923B8\",\n \"CreationDateTime\": \"2024-01-30T10:55:21\"\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://{merchant_site_domain}/send-additional-required-documents-url")
.header("Content-Type", "application/json")
.body("{\n \"OrderId\": \"Sample order id\",\n \"MerchantOrderId\": \"Sample order id from the merchant’s system\",\n \"CountryCode\": \"US\",\n \"AdditionalRequiredDocuments\": [\n {\n \"TrackingNumber\": \"98789723874839\",\n \"DocumentData\": \"base 64 string\",\n \"URL\": \"URL do download document\",\n \"DocumentTypeCode\": \"11\",\n \"DocumentTypeName\": \"EAD\",\n \"DocumentExtension\": \"pdf\",\n \"DocumentReference\": \"24DE85123822923B8\",\n \"CreationDateTime\": \"2024-01-30T10:55:21\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{merchant_site_domain}/send-additional-required-documents-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 \"OrderId\": \"Sample order id\",\n \"MerchantOrderId\": \"Sample order id from the merchant’s system\",\n \"CountryCode\": \"US\",\n \"AdditionalRequiredDocuments\": [\n {\n \"TrackingNumber\": \"98789723874839\",\n \"DocumentData\": \"base 64 string\",\n \"URL\": \"URL do download document\",\n \"DocumentTypeCode\": \"11\",\n \"DocumentTypeName\": \"EAD\",\n \"DocumentExtension\": \"pdf\",\n \"DocumentReference\": \"24DE85123822923B8\",\n \"CreationDateTime\": \"2024-01-30T10:55:21\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"StatusCode": "200",
"Success": "true",
"Message": "...",
"ErrorCode": "...",
"ErrorText": "..."
}SendAdditionalRequiredDocumentsToMerchant (Global-e to Merchant)
Posts the required shipping documents of the order to the Merchant’s site.
POST
/
send-additional-required-documents-url
SendAdditionalRequiredDocumentsToMerchant (Global-e to Merchant)
curl --request POST \
--url https://{merchant_site_domain}/send-additional-required-documents-url \
--header 'Content-Type: application/json' \
--data '
{
"OrderId": "Sample order id",
"MerchantOrderId": "Sample order id from the merchant’s system",
"CountryCode": "US",
"AdditionalRequiredDocuments": [
{
"TrackingNumber": "98789723874839",
"DocumentData": "base 64 string",
"URL": "URL do download document",
"DocumentTypeCode": "11",
"DocumentTypeName": "EAD",
"DocumentExtension": "pdf",
"DocumentReference": "24DE85123822923B8",
"CreationDateTime": "2024-01-30T10:55:21"
}
]
}
'import requests
url = "https://{merchant_site_domain}/send-additional-required-documents-url"
payload = {
"OrderId": "Sample order id",
"MerchantOrderId": "Sample order id from the merchant’s system",
"CountryCode": "US",
"AdditionalRequiredDocuments": [
{
"TrackingNumber": "98789723874839",
"DocumentData": "base 64 string",
"URL": "URL do download document",
"DocumentTypeCode": "11",
"DocumentTypeName": "EAD",
"DocumentExtension": "pdf",
"DocumentReference": "24DE85123822923B8",
"CreationDateTime": "2024-01-30T10:55:21"
}
]
}
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: 'Sample order id',
MerchantOrderId: 'Sample order id from the merchant’s system',
CountryCode: 'US',
AdditionalRequiredDocuments: [
{
TrackingNumber: '98789723874839',
DocumentData: 'base 64 string',
URL: 'URL do download document',
DocumentTypeCode: '11',
DocumentTypeName: 'EAD',
DocumentExtension: 'pdf',
DocumentReference: '24DE85123822923B8',
CreationDateTime: '2024-01-30T10:55:21'
}
]
})
};
fetch('https://{merchant_site_domain}/send-additional-required-documents-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}/send-additional-required-documents-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([
'OrderId' => 'Sample order id',
'MerchantOrderId' => 'Sample order id from the merchant’s system',
'CountryCode' => 'US',
'AdditionalRequiredDocuments' => [
[
'TrackingNumber' => '98789723874839',
'DocumentData' => 'base 64 string',
'URL' => 'URL do download document',
'DocumentTypeCode' => '11',
'DocumentTypeName' => 'EAD',
'DocumentExtension' => 'pdf',
'DocumentReference' => '24DE85123822923B8',
'CreationDateTime' => '2024-01-30T10:55:21'
]
]
]),
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}/send-additional-required-documents-url"
payload := strings.NewReader("{\n \"OrderId\": \"Sample order id\",\n \"MerchantOrderId\": \"Sample order id from the merchant’s system\",\n \"CountryCode\": \"US\",\n \"AdditionalRequiredDocuments\": [\n {\n \"TrackingNumber\": \"98789723874839\",\n \"DocumentData\": \"base 64 string\",\n \"URL\": \"URL do download document\",\n \"DocumentTypeCode\": \"11\",\n \"DocumentTypeName\": \"EAD\",\n \"DocumentExtension\": \"pdf\",\n \"DocumentReference\": \"24DE85123822923B8\",\n \"CreationDateTime\": \"2024-01-30T10:55:21\"\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://{merchant_site_domain}/send-additional-required-documents-url")
.header("Content-Type", "application/json")
.body("{\n \"OrderId\": \"Sample order id\",\n \"MerchantOrderId\": \"Sample order id from the merchant’s system\",\n \"CountryCode\": \"US\",\n \"AdditionalRequiredDocuments\": [\n {\n \"TrackingNumber\": \"98789723874839\",\n \"DocumentData\": \"base 64 string\",\n \"URL\": \"URL do download document\",\n \"DocumentTypeCode\": \"11\",\n \"DocumentTypeName\": \"EAD\",\n \"DocumentExtension\": \"pdf\",\n \"DocumentReference\": \"24DE85123822923B8\",\n \"CreationDateTime\": \"2024-01-30T10:55:21\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{merchant_site_domain}/send-additional-required-documents-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 \"OrderId\": \"Sample order id\",\n \"MerchantOrderId\": \"Sample order id from the merchant’s system\",\n \"CountryCode\": \"US\",\n \"AdditionalRequiredDocuments\": [\n {\n \"TrackingNumber\": \"98789723874839\",\n \"DocumentData\": \"base 64 string\",\n \"URL\": \"URL do download document\",\n \"DocumentTypeCode\": \"11\",\n \"DocumentTypeName\": \"EAD\",\n \"DocumentExtension\": \"pdf\",\n \"DocumentReference\": \"24DE85123822923B8\",\n \"CreationDateTime\": \"2024-01-30T10:55:21\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"StatusCode": "200",
"Success": "true",
"Message": "...",
"ErrorCode": "...",
"ErrorText": "..."
}Part of the Export Documents integration guide — see it for when and how to use this endpoint.
AdditionalRequiredDocuments), and generated via CreateAdditionalRequiredDocuments, are ready. The document content is included in this notification, base64-encoded.
This API is part of Global-e’s extensions and plug-ins. Merchants do not need to implement it unless a custom integration is required.
Security Requirements
- IP whitelist
- Secret GUID
- Authorization header
Body
application/json
Additional documents to send to merchant
Additional documents which are required to ship the order
Show child attributes
Show child attributes
2-char ISO country code
Order unique identifier on the Merchant’s site returned from a previous call to the SendOrderToMerchant method for this order
Global‑e’s order id
⌘I

