---
title: "Schedule Pickup"
method: POST
path: "/api/v1/admin/shipments/{shipment_id}/pickup"
tags: ["admin-shipping-logistics"]
---

# Schedule Pickup

`POST /api/v1/admin/shipments/{shipment_id}/pickup`

## Path parameters

- `shipment_id` string, uuid, required

## Request body

- ShipmentPickupCreate
  - `window_start` string, date-time, required
  - `window_end` string, date-time, required
  - `location` string, nullable
  - `instructions` string, nullable

## Response `201`

Successful Response

- ShipmentPickupResponse
  - `id` string, uuid, required
  - `shipment_id` string, uuid, required
  - `carrier` 'ups' | 'dhl' | 'fedex' | 'usps' | 'other', required
  - `pickup_confirmation_number` string, nullable
  - `status` 'not_scheduled' | 'scheduled' | 'cancelled' | 'failed', required
  - `window_start` string, date-time, nullable
  - `window_end` string, date-time, nullable
  - `location` string, nullable
  - `instructions` string, nullable
  - `cancelled_at` string, date-time, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/prototyping/apis/prototyping-io-api.md) · [All operations](https://skmtc.dev/prototyping/apis/prototyping-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/prototyping/prototyping-io-api/revisions/f4a0079fbb57/schema)