Skip to main content
GET
TypeScript

인증

Authorization
string
header
필수

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

shipment:basic:read

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

쿼리 매개변수

account_id
string

The account to list shipments for. Defaults to the acting account.

status
enum<string>

Filter to shipments with this delivery status.

사용 가능한 옵션:
unknown,
pre_transit,
in_transit,
out_for_delivery,
delivered,
available_for_pickup,
return_to_sender,
failure,
cancelled,
error
payment_id
string[]

Only shipments fulfilling these payments, each prefixed pay_. Repeat the parameter to pass several, up to 100 per request — one paginated list covers all of them.

created_before
string

Return shipments created before this ISO 8601 timestamp.

created_after
string

Return shipments created after this ISO 8601 timestamp.

order
enum<string>

The field to sort by.

사용 가능한 옵션:
created_at
direction
enum<string>

The sort direction.

사용 가능한 옵션:
asc,
desc
first
integer
기본값:20

Number of results to return from the start of the range.

필수 범위: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

필수 범위: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

응답

excludes the created_after boundary row

data
object[]
필수
page_info
object
필수