List shipments

GET/v1/shipmentsList shipments

Parameters

cursorstringquery

minLength 1

limitintegerquery

default 25 · maximum 100 · minimum 1

statusstringquery

one of "draft", "label_purchased", "in_transit", "out_for_delivery", "delivered", "exception", "canceled"

Responses

objectShipmentPage

dataarray of objectrequired

Show child attributes

Show array items

created_atstring · date-timerequired

delivery_instructionsnull | string

idstringrequired

metadataobject

objectvaluerequired

const "shipment"

parcelsarray of objectrequired

Show child attributes

Show array items

contentsarray of object

maxItems 50

Show child attributes

maxItems 50

Show array items

customs_codenull | string

descriptionstringrequired

quantityintegerrequired

minimum 1

unit_valueobjectrequired

Show child attributes

amountstringrequired

pattern ^[0-9]+(\.[0-9]{2})$

currencystringrequired

pattern ^[A-Z]{3}$

height_cmnumberrequired

exclusiveMinimum 0

length_cmnumberrequired

exclusiveMinimum 0

weight_gramsintegerrequired

minimum 1

width_cmnumberrequired

exclusiveMinimum 0

recipientobjectrequired

Show child attributes

citystringrequired

companynull | string

countrystringrequired

pattern ^[A-Z]{2}$

line1stringrequired

line2null | string

namestringrequired

minLength 1

phonenull | string

postal_codestringrequired

regionnull | string

referencestringrequired

senderobjectrequiredAddress ↑

servicestringrequired

one of "economy", "express", "same_day"

statusstringrequired

one of "draft", "label_purchased", "in_transit", "out_for_delivery", "delivered", "exception", "canceled"

tracking_numberstringrequired

updated_atstring · date-timerequired

has_morebooleanrequired

next_cursornull | stringrequired

Example response

{
  "data": [
    {
      "created_at": "2026-09-04T08:15:30Z",
      "delivery_instructions": "string",
      "id": "shp_00000000000000000001",
      "metadata": {
        "additionalProp1": "string"
      },
      "object": "shipment",
      "parcels": [
        {
          "contents": [
            {
              "customs_code": "610910",
              "description": "Synthetic cotton shirt",
              "quantity": 2,
              "unit_value": {
                "amount": "12.50",
                "currency": "XTS"
              }
            }
          ],
          "height_cm": 12,
          "length_cm": 30.5,
          "weight_grams": 1750,
          "width_cm": 20
        }
      ],
      "recipient": {
        "city": "Exampleton",
        "company": "Northstar Supplies",
        "country": "ZZ",
        "line1": "14 Fictional Quay",
        "line2": "Unit 7",
        "name": "Rowan Example",
        "phone": "+00000000000",
        "postal_code": "EX4 2PL",
        "region": "Test Province"
      },
      "reference": "synthetic-order-1042",
      "sender": {
        "city": "Exampleton",
        "company": "Northstar Supplies",
        "country": "ZZ",
        "line1": "14 Fictional Quay",
        "line2": "Unit 7",
        "name": "Rowan Example",
        "phone": "+00000000000",
        "postal_code": "EX4 2PL",
        "region": "Test Province"
      },
      "service": "economy",
      "status": "canceled",
      "tracking_number": "PE-000000000001",
      "updated_at": "2026-09-04T08:16:12Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

objectProblem

detailstring

errorsarray of object

Show child attributes

Show array items

messagestringrequired

pathstringrequired

request_idstringrequired

statusintegerrequired

maximum 599 · minimum 400

titlestringrequired

typestring · urirequired

Example response

{
  "request_id": "req_00000000000000000002",
  "status": 401,
  "title": "Synthetic credential was rejected",
  "type": "https://parcel-events.example/problems/unauthorized"
}

Examples

cursorquery parameter

limitquery parameter

statusquery parameter

curl -X GET 'https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled'

const response = await fetch('https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.parcel-events.example/v1/shipments?cursor=string&limit=25&status=canceled");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "created_at": "2026-09-04T08:15:30Z",
      "delivery_instructions": "string",
      "id": "shp_00000000000000000001",
      "metadata": {
        "additionalProp1": "string"
      },
      "object": "shipment",
      "parcels": [
        {
          "contents": [
            {
              "customs_code": "610910",
              "description": "Synthetic cotton shirt",
              "quantity": 2,
              "unit_value": {
                "amount": "12.50",
                "currency": "XTS"
              }
            }
          ],
          "height_cm": 12,
          "length_cm": 30.5,
          "weight_grams": 1750,
          "width_cm": 20
        }
      ],
      "recipient": {
        "city": "Exampleton",
        "company": "Northstar Supplies",
        "country": "ZZ",
        "line1": "14 Fictional Quay",
        "line2": "Unit 7",
        "name": "Rowan Example",
        "phone": "+00000000000",
        "postal_code": "EX4 2PL",
        "region": "Test Province"
      },
      "reference": "synthetic-order-1042",
      "sender": {
        "city": "Exampleton",
        "company": "Northstar Supplies",
        "country": "ZZ",
        "line1": "14 Fictional Quay",
        "line2": "Unit 7",
        "name": "Rowan Example",
        "phone": "+00000000000",
        "postal_code": "EX4 2PL",
        "region": "Test Province"
      },
      "service": "economy",
      "status": "canceled",
      "tracking_number": "PE-000000000001",
      "updated_at": "2026-09-04T08:16:12Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

{
  "request_id": "req_00000000000000000002",
  "status": 401,
  "title": "Synthetic credential was rejected",
  "type": "https://parcel-events.example/problems/unauthorized"
}

Search documentation

Parameters

Responses

Documentation menu