WOwove
Customs Entries

List customs entries

Retrieve a paginated list of your organization's customs entries, newest first. Requires customs:read.

get/api/v1/external/customs-entries

Request

Query parameters

pageinteger

Page number for pagination

limitinteger

Number of items per page

status'pending' | 'draft' | 'review' | 'filed' | 'released' | 'liquidated' | 'cancelled'

Filter by customs entry status

entryType'01' | '11' | 'export' | 'in_bond' | 'ca_b3' | 'ca_clvs' | 'ca_type_f'

Filter by entry type. Any other value returns 400.

filingCountrystring
Example:US

Filter by ISO-2 filing country

shipmentIdstring

Only entries linked to this shipment

searchstring

Search entry number, TMS reference, importer name and broker name. When set, createdAfter/createdBefore are ignored.

createdAfterstring date-time

Only entries created at or after this ISO 8601 date

createdBeforestring date-time

Only entries created at or before this ISO 8601 date

Response

Customs entries retrieved successfully

successboolean required
messagestring

Optional success message

Example response

{
  "success": true,
  "data": [
    {
      "creation": {
        "source": "email"
      },
      "sync": {
        "method": "manual",
        "status": "success",
        "syncedBy": {
          "name": "Jane Smith",
          "email": "jane@example.com"
        },
        "tmsReference": "C00012345"
      },
      "id": "1017334964043997190",
      "filingCountry": "US",
      "portOfEntry": {
        "type": "port",
        "portCode": "USLAX",
        "portName": "Los Angeles",
        "country": "US"
      },
      "portOfLoading": {
        "type": "port",
        "portCode": "USLAX",
        "portName": "Los Angeles",
        "country": "US"
      },
      "portOfOrigin": {
        "type": "port",
        "portCode": "USLAX",
        "portName": "Los Angeles",
        "country": "US"
      },
      "portOfDischarge": {
        "type": "port",
        "portCode": "USLAX",
        "portName": "Los Angeles",
        "country": "US"
      },
      "portOfDestination": {
        "type": "port",
        "portCode": "USLAX",
        "portName": "Los Angeles",
        "country": "US"
      },
      "totalCustomsValue": "12500.00",
      "currency": "USD",
      "tags": [
        {
          "authority": "section_338"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8,
    "hasNext": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.