Skip to main content
GET
/
shipments
List shipments
curl --request GET \
  --url https://api.quivo.co/shipments
[
  {
    "bookedShipmentId": 123,
    "sellerId": 123,
    "shippingServiceId": 123,
    "trackingNumber": "<string>",
    "trackingLink": "<string>",
    "returnTrackingNumber": "<string>",
    "returnTrackingLink": "<string>",
    "shipmentIdentifier": "<string>",
    "reference": "<string>",
    "direction": "<string>",
    "shipToCountry": "<string>",
    "shipToZip": "<string>",
    "shipToCompany": "<string>",
    "shipToName1": "<string>",
    "shipToName2": "<string>",
    "carrierSlug": "<string>",
    "shipFromCountry": "<string>",
    "shipFromZip": "<string>",
    "shipFromCompany": "<string>",
    "shipFromName1": "<string>",
    "shipFromName2": "<string>",
    "piiDataRemoved": true,
    "weight": 123,
    "volume": 123,
    "lengthM": 123,
    "widthM": 123,
    "heightM": 123,
    "codAmount": 123,
    "codCurrency": {
      "currencyCode": "<string>",
      "defaultFractionDigits": 123,
      "numericCode": 123,
      "displayName": "<string>",
      "symbol": "<string>",
      "numericCodeAsString": "<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
    },
    "trackingEnabled": true,
    "userIdentifier": "<string>",
    "shipmentDate": "2023-12-25",
    "warehouseName": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "cancelledAt": "2023-11-07T05:31:56Z",
    "documents": [
      {
        "shipmentDocumentId": 123,
        "type": "<string>"
      }
    ],
    "exportPositions": [
      {
        "quantity": 123,
        "warehouseSku": "<string>",
        "unNumber": "<string>"
      }
    ]
  }
]

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.

bookedShipmentId
integer<int64>

The unique identifier for the bookedshipment

sellerId
integer<int64>

The unique identifier for the seller

shippingServiceId
integer<int64>

The unique identifier for the shippingservice

trackingNumber
string

Tracking information or tracking enabled status

Tracking information or tracking enabled status

returnTrackingNumber
string

Tracking information or tracking enabled status

Tracking information or tracking enabled status

shipmentIdentifier
string

The unique identifier for the shipmententifier

reference
string

Reference number or identifier for the item

direction
string

The direction value

shipToCountry
string

Country code or name

shipToZip
string

ZIP or postal code

shipToCompany
string

Company name

shipToName1
string

The name of the ship to

shipToName2
string

The name of the ship to

carrierSlug
string

Carrier identifier or information

shipFromCountry
string

Country code or name

shipFromZip
string

ZIP or postal code

shipFromCompany
string

Company name

shipFromName1
string

The name of the ship from

shipFromName2
string

The name of the ship from

piiDataRemoved
boolean

Boolean flag indicating pii data removed

weight
number

The total weight of the shipment in kg, which is the sum of the weight of the main as well as all additional parcels in this shipment.

volume
number

The total volume of the shipment in m3, which is the sum of the volume of the main as well as all additional parcels in this shipment.

lengthM
number

Length of the shipment in meters.

widthM
number

Width of the shipment in meters.

heightM
number

Height of the shipment in meters.

codAmount
number

Amount value

codCurrency
object

Currency information

sort
object

The

trackingEnabled
boolean

Indicates whether tracking is enabled

userIdentifier
string

The unique identifier for the userentifier

shipmentDate
string<date>

The shipment date date

warehouseName
string

The name of the warehouse

created
string<date-time>

Timestamp when the item was created

cancelledAt
string<date-time>

The cancelled at timestamp

documents
object[]

Array of document items

exportPositions
object[]

Array of export position