Get all Shippo documents for a transaction

Use this request to retrieve all the documents and labels for a Shippo Transaction ID.

Use a GET operation and the following URL to send this request:

{api_url}/shippo/transaction/{transactionId}/documents

where:

{api_url} is the API's URL.
{transactionId} is the ID of the transaction whos documents you want to retrive.

For example:

https://api.epalglobal.co/generate-labels/shippo/transaction/{transactionId}/documents

Details

Table 1. Request Details
Detail	Value
Operation	`GET`
Endpoint	`/shippo/transaction/{transactionId}/documents`
Fields	Query parameter and response fields.

Query Parameters

Table 2.
Query Parameter	Details	Description
`transactionId`	Type: String Status: Mandatory	Specify the Transaction ID for the Shippo transaction.

Response Parameters

Table 3. Response Parameters
Response Parameter	Details	Description
`documents`	Type: Object	Groups information about the returned documents.
`documents.commercialInvoice`	Type: String or null	The commercial invoice.
`documents.customsDeclaration`	Type: Object	Groups information about the customs declaration.
`documents.customsDeclaration.data`	Type: Object or null	The data from the Customs declaration.
`documents.customsDeclaration.id`	Type: String or null	The Customs declaration's ID.
`documents.label`	Type: String or null	The shipping label.
`documents.qrcode`	Type: String or null	The QR code.
`messages`	Type: Array of strings	Any messages associated with the documents.
`paperlessTrade`	Type: Boolean	Indicates whether these documents are part of a paperless trade or not.
`shipment`	Type: Object	Groups shipment information.
`shipment.fromAddress`	Type:	The address that the shipment was sent from.
`shipment.id`	Type:	The Shipment ID.
`shipment.toAddress`	Type:	The address that the shipment was sent to.
`transaction`	Type: Object	Groups information about the transaction.
`transaction.carrier`	Type: String	The carrier.
`transaction.createdAt`	Type: String	The time the transaction was created.
`transaction.eta`	Type: String or null	The Estimated Time of Arrival (ETA).
`transaction.id`	Type: String	The transaction's ID.
`transaction.status`	Type: String	The status of the transaction.
`transaction.trackingNumber`	Type: String	The tracking number.
`transaction.trackingUrl`	Type: String	The URL for the tracking number.

Response Example

The following is an example of a successful response:

{
  "transaction": {
    "id": "string",
    "status": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "carrier": "string",
    "eta": "string",
    "createdAt": "string"
  },
  "documents": {
    "label": "string",
    "commercialInvoice": "string",
    "customsDeclaration": {
      "id": "string",
      "data": {}
    },
    "qrCode": "string"
  },
  "shipment": {
    "id": "string",
    "fromAddress": {},
    "toAddress": {}
  },
  "messages": [
    "string"
  ],
  "paperlessTrade": true
}