Skip to main content
GET
List taxes collections

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
string

Filter by status

trackingNumber
string

Filter by tracking number

customerReference
string

Filter by customer reference

overdue
boolean

Filter overdue collections

includeArchived
boolean

Include archived collections

createdAt_gte
string<date-time>

Filter from date (createdAt >=)

createdAt_lte
string<date-time>

Filter to date (createdAt <=)

collectionDeadline_gte
string<date-time>

Deadline from date (collectionDeadline >=)

collectionDeadline_lte
string<date-time>

Deadline to date (collectionDeadline <=)

range
string

Range parameter in format [start, end]

Example:

"[0, 49]"

_end
string
_start
string
_sort
string
_order
string
q
string

Response

200 - application/json
id
string
required
trackingNumber
string
required
shipTo
object
required
shipFrom
object
required
weight
object
required
dimensions
object
required
customs
object
required
packageType
enum<string>
default:parcel
required
Available options:
envelope,
tube,
parcel
contentType
enum<string>
default:CommercialGoods
required
Available options:
Documents,
Gift,
Sample,
Other,
CommercialGoods,
ReturnOfGoods
isArchived
boolean
default:false
required
status
string
required

Collection status

Example:

"pending"

accountId
string
required
commodities
object[]
required
surcharges
object[]
required
events
object[]
required
attachments
object[]
required
transactions
object[]
required
updatedAt
string<date-time>
required
createdAt
string<date-time>
required
paymentUrl
string
required

Payment URL for consignee

Example:

"https://duties-taxes.com/abc123"

externalManifestId
string
description
string
customerReference
string
metadata
object
requestId
string
dutiesAndTaxes
object
stages
object[]

Timeline stages

collectionDeadline
string<date-time>

Payment deadline

customsPaidAt
string<date-time>

When customs was paid

stripePaymentIntentId
string

Stripe PaymentIntent ID