Skip to main content
GET
Get shipment

Authorizations

Authorization
string
header
required

Access token from POST /v2/oauth2/token, requested with an API credential. See https://api-docs.quivo.co/api-reference/authentication.

Query Parameters

query
string

Elasticsearch query string: field:value, joined with AND by default; AND/OR/NOT in upper case; quotes around values with spaces, / or :; * wildcards; ranges like pickupDate:[2026-10-01 TO 2026-10-31] or pickupDate:>=now-7d; exists:field. A condition on a wrong field name matches nothing and gives no error, so OR still returns the other matches and NOT drops nothing, which widens the result. Guide: https://api-docs.quivo.co/docs/quivo-guides/using-queries. Fields include: sellerId, shippingServiceGroupId, pickupDate, parcelCount, created. The pickup address is flat: pickupFromCity, pickupFromZip, pickupFromCountryIso2 (pickupFrom.city returns 0). Examples: pickupFromCountryIso2:NL AND pickupDate:[2026-09-01 TO 2026-09-30].

sort
string

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

page
integer<int64>

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

searchAfter
string

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

pageSize
integer<int64>

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

Returns an array of shipment summaries with tracking information and status.

id
integer<int64>

The unique identifier for the scheduled pickup

created
string<date-time>

Timestamp when the pickup was scheduled

sellerId
integer<int64>

The unique identifier for the seller

shippingServiceGroupId
integer<int64>

The unique identifier for the shipping service group used for this pickup

parcelCount
integer<int32>

The number of parcels to be picked up by the carrier

pickupDate
string<date>

The scheduled date for the carrier pickup

pickupFrom
object

The

sort
object

The