Skip to main content

Documentation Portal

CreateAdditionalRequiredDocuments

Used to initiate the process of requesting additional required shipping document such as the German Customs EAD document. This API does not return the document itself, rather it initiates the process to receive the document from the authorities, for example the EAD document from German Customs, using SendAdditionalRequiredDocumentsToMerchant (Global-e to Merchant).

Security Requirements

  • Headers:

    • JWT (optional)

    • MerchantGUID (optional)

Method/URL

POST https://api-<merchantName>-<environmentName>.global-e.com/additional-required-documents
Parameters

Request

Name

Type

Description

Mandatory

Orders

List of OrderInfoForAdditionalDocuments

Array of OrderInfoForAdditionalDocuments objects with information about orders for which additional shipping documents are required.

Yes

Response

Name

Type

Description

ResponseInfo

Class ResponseInfo

Indicates if an API call was successful or not and why.

Error Codes

Code

Description

202

Successful request - request was accepted, and document will be provided when ready.

4xx

Error - the request not successful, incorrect data was sent by the merchant.

Reasons for failure:

  • OrderId was not provided by Merchant, or an OrderId was provided that does not belong to the Merchant.

  • TrackingNumbers field was not provided by the merchant, or a tracking number was provided that does not belong to the order.

5xx

Error - the request not successful due to an internal error on Global-e side.

Examples

Request

{
  "Orders": [
	{
	  "OrderId": "GE123874638GB",
              "TrackingNumbers": [
                   "trackingnumber1",
                   "trackingnumber2"
               ]
         }  
   ]
}

Response

Sample 1

Example of success, with HTTP Code 200:

{
"Success":true
}

Sample 2

Example of error with HTTP Code 400:

{ 
  "Code": "B001", 
  "Message": "Order ID not found", 
  "Description": "The Order GE12345US provided by the merchant does not exist." 
}