v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB

Customs Declarations

List all customs declarations

Returns a list of all customs declaration objects

get/customs/declarations

Query parameters

pageinteger

The page number you want to select

resultsinteger

The number of results to return per page (max 100, default 5)

Headers

SHIPPO-API-VERSIONstring

Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Response

Paginated list of customs declarations

nextstring

previousstring

Example response

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    {
      "b13a_filing_option": "FILED_ELECTRONICALLY",
      "certify": true,
      "certify_signer": "Shawn Ippotle",
      "contents_explanation": "T-Shirt purchase",
      "duties_payor": {
        "account": "2323434543",
        "type": "THIRD_PARTY",
        "address": {
          "name": "Patrick Kavanagh",
          "zip": "80331",
          "country": "DE"
        }
      },
      "exporter_identification": {
        "eori_number": "PL123456790ABCDE",
        "tax_id": {
          "number": "123456789",
          "type": "EIN"
        }
      },
      "invoice": "#123123",
      "metadata": "Order ID #123123",
      "address_importer": "257ba08436604d2aaf069caafe7acb2a",
      "contents_type": "MERCHANDISE",
      "eel_pfc": "NOEEI_30_37_a",
      "incoterm": "DDP",
      "items": [
        "5087f181d1dc4b14b73fdbf636498886"
      ],
      "non_delivery_option": "RETURN",
      "object_created": "2014-07-17T01:01:08.306Z",
      "object_id": "e2197a54da9d470480f4f8796cc419cb",
      "object_owner": "shippotle@shippo.com",
      "object_updated": "2014-07-17T01:01:08.306Z",
      "test": true
    }
  ]
}