Get Shippo customs declaration by ID

Use a GET operation and the following URL to send this request:
{api_url}/shippo/customs/{customsDeclarationId}
where:
  • {api_url} is the API's URL
  • {customsDeclarationId} is the ID from the object_id field in the Shippo customs declaration.
.
For example:
https://api.epalglobal.co/generate-labels/shippo/customs/{customsDeclarationId}

Details

Table 1. Request Details
Detail Value
Operation GET
Endpoint /shippo/customs/{customsDeclarationId}
Fields Query parameter and response parameters.

Query Parameter

Table 2.
Query Parameter Details Description
customsDeclarationId
  • Type:
  • Status:
  • Required Values: object_id
 You must specify the ID from the object_id field in the Shippo customs declaration. For example d4fe6327d02e4ddf98b92b4ecf2ab6ed.

Response Parameters

Table 3.
Response Parameter Details Description
certify
  • Type: Boolean
 Indicates whther the document is certified or not.
certify_signer
  • Type: String
 The party who signed the certificate.
contents_explanation
  • Type: String
 Text to explain the contents.
contents_type
  • Type: String
 The type of content.
eel_pfc
  • Type: String
 Exclusion Legend (EEL) and Proof of Filing Citation (PFC) are used for shipping outside the US.
exporter_identification
  • Type: Object
 Groups information about the exporter.
exporter_identification.eori_number
  • Type: String
 The EORI number.
exporter_identification.tax_id
  • Type: Object
 Groups information about the Tax ID.
exporter_identification.tax_id.number
  • Type: String
 The Tax ID.
exporter_identification.tax_id.type
  • Type: String
 The type of Tax ID, such as VAT for a VAT ID.
exporter_reference
  • Type: String
 The reference to the exporter.
importer_reference
  • Type: String
 The reference to the importer.
incoterm
  • Type: String
 The Incoterm for the shipment.
invoice
  • Type: String
 The invoice.
is_vat_collected
  • Type: Boolean
 Indicates whether VAT has been collected or not.
items
  • Type: Array of strings
 Array of object IDs for customs items.
non_delivery_options
  • Type: String
 Details about options for things other than delivery.
object_id
  • Type: String
 The IDs for the objects.
object_state
  • Type: String
 The object's state.

Response Example

The following is an example response for a successful request:
{
  "object_id": "string",
  "object_state": "string",
  "contents_type": "string",
  "contents_explanation": "string",
  "non_delivery_option": "string",
  "incoterm": "string",
  "eel_pfc": "string",
  "certify": true,
  "certify_signer": "string",
  "items": [
    "string"
  ],
  "exporter_identification": {
    "eori_number": "string",
    "tax_id": {
      "type": "string",
      "number": "string"
    }
  },
  "is_vat_collected": true,
  "invoice": "string",
  "exporter_reference": "string",
  "importer_reference": "string"
}