List scheduled pickups

GET/v1/pickupsList scheduled pickups

Parameters

cursorstringquery

minLength 1

limitintegerquery

default 25 · maximum 100 · minimum 1

scheduled_onstring · datequery

Responses

objectPickupPage

dataarray of objectrequired

Show child attributes

Show array items

addressobjectrequired

Show child attributes

citystringrequired

companynull | string

countrystringrequired

pattern ^[A-Z]{2}$

line1stringrequired

line2null | string

namestringrequired

minLength 1

phonenull | string

postal_codestringrequired

regionnull | string

created_atstring · date-timerequired

idstringrequired

objectvaluerequired

const "pickup"

shipment_idsarray of stringrequired

Show child attributes

statusstringrequired

one of "scheduled", "completed", "canceled", "missed"

windowobjectrequired

Show child attributes

ends_atstring · date-timerequired

starts_atstring · date-timerequired

has_morebooleanrequired

next_cursornull | stringrequired

Example response

{
  "data": [
    {
      "address": {
        "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"
      },
      "created_at": "2026-06-09T00:00:00Z",
      "id": "pku_00000000000000000001",
      "object": "pickup",
      "shipment_ids": [
        "string"
      ],
      "status": "canceled",
      "window": {
        "ends_at": "2026-09-06T12:00:00Z",
        "starts_at": "2026-09-06T09:00:00Z"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Examples

cursorquery parameter

limitquery parameter

scheduled_onquery parameter

curl -X GET 'https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09'

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

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

import requests

response = requests.request("GET", "https://api.parcel-events.example/v1/pickups?cursor=string&limit=25&scheduled_on=2026-06-09")
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/pickups?cursor=string&limit=25&scheduled_on=2026-06-09", 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/pickups?cursor=string&limit=25&scheduled_on=2026-06-09");
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/pickups?cursor=string&limit=25&scheduled_on=2026-06-09"))
    .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/pickups?cursor=string&limit=25&scheduled_on=2026-06-09")
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/pickups?cursor=string&limit=25&scheduled_on=2026-06-09");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "address": {
        "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"
      },
      "created_at": "2026-06-09T00:00:00Z",
      "id": "pku_00000000000000000001",
      "object": "pickup",
      "shipment_ids": [
        "string"
      ],
      "status": "canceled",
      "window": {
        "ends_at": "2026-09-06T12:00:00Z",
        "starts_at": "2026-09-06T09:00:00Z"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Search documentation

Parameters

Responses

Documentation menu