CreateAdditionalRequiredDocuments
curl --request POST \
--url https://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"Orders": [
{
"OrderId": "GE123874638GB",
"TrackingNumbers": [
"trackingnumber1",
"trackingnumber2"
]
}
]
}
'import requests
url = "https://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents"
payload = { "Orders": [
{
"OrderId": "GE123874638GB",
"TrackingNumbers": ["trackingnumber1", "trackingnumber2"]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Orders: [
{
OrderId: 'GE123874638GB',
TrackingNumbers: ['trackingnumber1', 'trackingnumber2']
}
]
})
};
fetch('https://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents', 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://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents",
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([
'Orders' => [
[
'OrderId' => 'GE123874638GB',
'TrackingNumbers' => [
'trackingnumber1',
'trackingnumber2'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents"
payload := strings.NewReader("{\n \"Orders\": [\n {\n \"OrderId\": \"GE123874638GB\",\n \"TrackingNumbers\": [\n \"trackingnumber1\",\n \"trackingnumber2\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"Orders\": [\n {\n \"OrderId\": \"GE123874638GB\",\n \"TrackingNumbers\": [\n \"trackingnumber1\",\n \"trackingnumber2\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Orders\": [\n {\n \"OrderId\": \"GE123874638GB\",\n \"TrackingNumbers\": [\n \"trackingnumber1\",\n \"trackingnumber2\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"Success": true
}{
"Code": "B001",
"Message": "Order ID not found",
"Description": "The Order GE12345US provided by the merchant does not exist."
}Create Additional Required Documents
Initiates the process of requesting additional required shipping documents, such as the German Customs EAD document.
POST
/
additional-required-documents
CreateAdditionalRequiredDocuments
curl --request POST \
--url https://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"Orders": [
{
"OrderId": "GE123874638GB",
"TrackingNumbers": [
"trackingnumber1",
"trackingnumber2"
]
}
]
}
'import requests
url = "https://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents"
payload = { "Orders": [
{
"OrderId": "GE123874638GB",
"TrackingNumbers": ["trackingnumber1", "trackingnumber2"]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Orders: [
{
OrderId: 'GE123874638GB',
TrackingNumbers: ['trackingnumber1', 'trackingnumber2']
}
]
})
};
fetch('https://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents', 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://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents",
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([
'Orders' => [
[
'OrderId' => 'GE123874638GB',
'TrackingNumbers' => [
'trackingnumber1',
'trackingnumber2'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents"
payload := strings.NewReader("{\n \"Orders\": [\n {\n \"OrderId\": \"GE123874638GB\",\n \"TrackingNumbers\": [\n \"trackingnumber1\",\n \"trackingnumber2\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"Orders\": [\n {\n \"OrderId\": \"GE123874638GB\",\n \"TrackingNumbers\": [\n \"trackingnumber1\",\n \"trackingnumber2\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{merchantName}-{environmentName}.global-e.com/additional-required-documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Orders\": [\n {\n \"OrderId\": \"GE123874638GB\",\n \"TrackingNumbers\": [\n \"trackingnumber1\",\n \"trackingnumber2\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"Success": true
}{
"Code": "B001",
"Message": "Order ID not found",
"Description": "The Order GE12345US provided by the merchant does not exist."
}Authorizations
JWT (optional).
Headers
MerchantGUID (optional).
Body
application/json
Array of OrderInfoForAdditionalDocuments objects with information about orders for which additional shipping documents are required.
Show child attributes
Show child attributes
Response
Indicates if an API call was successful or not and why.
⌘I