Skip to main content
GET
List shipments
This page documents the Legacy API. For new integrations, use List Shipments in the Current API.
Required permissions:
  • shipment:basic:read
  • payment:basic:read

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

shipment:basic:read
payment:basic:read

Sorgu Parametreleri

after
string

Returns the elements in the list that come after the specified cursor.

before
string

Returns the elements in the list that come before the specified cursor.

first
integer

Returns the first n elements from the list.

Örnek:

42

last
integer

Returns the last n elements from the list.

Örnek:

42

payment_id
string

Filter shipments to only those associated with this specific payment.

Örnek:

"pay_xxxxxxxxxxxxxx"

user_id
string

Filter shipments to only those for this specific user.

Örnek:

"user_xxxxxxxxxxxxx"

account_id
string

Filter shipments to only those belonging to this company.

Örnek:

"biz_xxxxxxxxxxxxxx"

Yanıt

A successful response

The connection type for Shipment.

data
object[]
gerekli

A list of nodes.

page_info
object
gerekli

Information to aid in pagination.