Skip to main content
GET
/
shipments
/
pickups
Get shipment
curl --request GET \
  --url https://api.quivo.co/shipments/pickups
[
  {
    "id": 123,
    "created": "2023-11-07T05:31:56Z",
    "sellerId": 123,
    "shippingServiceGroupId": 123,
    "parcelCount": 123,
    "pickupDate": "2023-12-25",
    "pickupFrom": {
      "name": "<string>",
      "company": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "state": "<string>",
      "countryIso2": "<string>",
      "street": "<string>",
      "street2": "<string>"
    },
    "sort": {
      "short": true,
      "nodeType": "ARRAY",
      "float": true,
      "binary": true,
      "number": true,
      "integralNumber": true,
      "boolean": true,
      "double": true,
      "long": true,
      "int": true,
      "valueNode": true,
      "containerNode": true,
      "missingNode": true,
      "object": true,
      "pojo": true,
      "floatingPointNumber": true,
      "bigDecimal": true,
      "bigInteger": true,
      "textual": true,
      "array": true,
      "null": true
    }
  }
]

Query Parameters

​
query
string

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

​
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