Customs Entries

Endpoints relating to Customs Entry objects

List customs entry objects

Returns a list of customs entries.

Request
query Parameters
page
integer >= 1
Default: 1

Page number of the page to retrieve

Example: page=1
per
integer [ 1 .. 100 ]
Default: 20

Count of items in each page. Should be between 1 and 100 (inclusive)

Example: per=20
f.shipment.id
string

The unique id for the shipment.

Responses
200

collection of customs entries

Response Schema: application/json
_object
string
self
string
version
integer
object
_object
string
prev
string or null
next
string or null
Array of objects (CustomsEntry)
get/customs_entries
Response samples
application/json

Success

{}

Retrieve a customs entry

Retrieves the details of a single customs entry.

Request
path Parameters
id
required
string

The unique id for the requested customs entry

Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
object (CustomsEntry)
_object
string

Type of the object. Always /customs_entry for this object.

id
string <string>

Unique identifier for the customs entry.

entry_number
string
release_status
string

The release status for this entry.

Enum: "cleared" "customs_hold" "pending"
release_date
string <date>

The cargo release date for this entry.

object (ShipmentRef)
get/customs_entries/{id}
Response samples
application/json

Success

{}