Skip to main content
GET
/
shipments
/
{bookedShipmentId}
Get shipment
curl --request GET \
  --url https://api.quivo.co/shipments/{bookedShipmentId}
{
  "sellerId": 123,
  "shippingServiceId": 123,
  "request": {
    "shipTo": {
      "name": "<string>",
      "company": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "state": "<string>",
      "countryIso2": "<string>",
      "street": "<string>",
      "street2": "<string>",
      "latitude": 123,
      "longitude": 123
    },
    "shipFrom": {
      "name": "<string>",
      "company": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "state": "<string>",
      "countryIso2": "<string>",
      "street": "<string>",
      "street2": "<string>",
      "latitude": 123,
      "longitude": 123
    },
    "reference": "<string>",
    "grossWeightKg": 123,
    "lengthM": 123,
    "widthM": 123,
    "heightM": 123,
    "totalWeight": 123,
    "totalVolume": 123,
    "shipmentDate": "2023-11-07T05:31:56Z",
    "invoiceNumber": "<string>",
    "invoiceDate": "2023-11-07T05:31:56Z",
    "includeReturnLabel": true,
    "trackingEnabled": true,
    "userIdentifier": "<string>",
    "cashOnDeliveryAmount": 123,
    "cashOnDeliveryCurrency": {
      "currencyCode": "<string>",
      "defaultFractionDigits": 123,
      "numericCode": 123,
      "displayName": "<string>",
      "symbol": "<string>",
      "numericCodeAsString": "<string>"
    },
    "customsPositions": [
      {
        "currency": {
          "currencyCode": "<string>",
          "defaultFractionDigits": 123,
          "numericCode": 123,
          "displayName": "<string>",
          "symbol": "<string>",
          "numericCodeAsString": "<string>"
        },
        "quantity": 123,
        "origin": "AF",
        "tariff": "<string>",
        "warehouseSku": "<string>",
        "contentDescription": "<string>",
        "unNumber": "<string>",
        "description": "<string>",
        "pieceNetCustomsValue": 123,
        "pieceNetWeightKg": 123
      }
    ],
    "transportInsuranceAmount": 123,
    "termsOfTrade": "DAP",
    "additionalParcels": [
      {
        "weight": 1,
        "length": 123,
        "width": 123,
        "height": 123,
        "reference": "<string>"
      }
    ],
    "orderReference": "<string>"
  },
  "documents": [
    {
      "shipmentDocumentId": 123,
      "type": "LABEL"
    }
  ],
  "trackingDetails": [
    {
      "status": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "message": "<string>",
      "rawTag": "<string>"
    }
  ],
  "id": 123,
  "created": "2023-11-07T05:31:56Z",
  "requestId": "<string>",
  "trackingNumber": "<string>",
  "additionalTrackingNumbers": [
    {
      "trackingNumber": "<string>",
      "reference": "<string>"
    }
  ],
  "returnTrackingNumber": "<string>",
  "additionalReturnTrackingNumbers": [
    {
      "trackingNumber": "<string>",
      "reference": "<string>"
    }
  ],
  "shipmentIdentifier": "<string>",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "carrierCancelledAt": "2023-11-07T05:31:56Z",
  "shipTo": {
    "name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "countryIso2": "<string>",
    "street": "<string>",
    "street2": "<string>",
    "latitude": 123,
    "longitude": 123
  },
  "shipFrom": {
    "name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "countryIso2": "<string>",
    "street": "<string>",
    "street2": "<string>",
    "latitude": 123,
    "longitude": 123
  },
  "parcelWeight": 123,
  "parcelReference": "<string>",
  "piiDataRemoved": true,
  "contentDescription": "<string>",
  "trackingLink": "<string>",
  "returnTrackingLink": "<string>",
  "carrierSlug": "<string>",
  "carrierName": "<string>",
  "direction": "<string>"
}

Path Parameters

bookedShipmentId
integer<int64>
required

The unique identifier for a booked shipment.

Response

Returns shipment details including tracking information, label URLs, and current status.

Complete booked shipment information with all details. Contains shipment identifiers, addresses, dimensions, weight, carrier information, tracking details, and status.

sellerId
integer<int64>

The unique identifier for the seller

shippingServiceId
integer<int64>

The unique identifier for the shippingservice

request
object

Response object containing shippingorder details

documents
object[]

Array of document items

trackingDetails
object[]

Tracking information or tracking enabled status

id
integer<int64>

The unique identifier for the id

created
string<date-time>

Timestamp when the item was created

requestId
string

The unique identifier for the request

trackingNumber
string

Tracking information or tracking enabled status

additionalTrackingNumbers
object[]

Tracking information or tracking enabled status

returnTrackingNumber
string

Tracking information or tracking enabled status

additionalReturnTrackingNumbers
object[]

Tracking information or tracking enabled status

shipmentIdentifier
string

The unique identifier for the shipmententifier

cancelledAt
string<date-time>

The cancelled at timestamp

carrierCancelledAt
string<date-time>

Carrier identifier or information

shipTo
object

The

shipFrom
object

The

parcelWeight
number

Weight value

parcelReference
string

Reference number or identifier for the parcel

piiDataRemoved
boolean

Boolean flag indicating pii data removed

contentDescription
string

Description text

Tracking information or tracking enabled status

Tracking information or tracking enabled status

carrierSlug
string

Carrier identifier or information

carrierName
string

The name of the carrier

direction
string

The direction value