---
title: "List all pickup requests"
method: GET
path: "/pickup_requests"
tags: ["Pickup requests"]
---

# List all pickup requests

`GET /pickup_requests`

Returns a list of pickup requests.

## Query parameters

- `id` integer
- `carrier_code` 'fed_ex' | 'ups' | 'dhl_express' | 'geodis' | 'dhl_freight_se' | 'post_nord' | 'bring'
- `per_page` integer
- `page` integer

## Response `200`

Successful.

- PickupRequestNoShipments[]
  - `id` integer — ID of the pickup request
  - `carrier_code` string — Carrier code for the carrier the pickup is requested for.
  - `pickup_address` object — Address where the shipments will be picked up from.
    - `company_name` string
    - `address1` string
    - `address2` string — Second address line can be used for floor/room number, building name etc.
    - `zipcode` string
    - `city` string
    - `country_code` string
    - `contact_name` string — Name of the person that the carrier will contact about the pickup.
    - `contact_phone` string — Phone number of the person that the carrier will contact about the pickup.
  - `confirmation_number` string — Reference number for the pickup request. This should used as reference if contacting the carrier about the pickup.
  - `status` 'unconfirmed' | 'confirmed' | 'error' | 'cancelled' — Current status of the pickup request.
  - `date` string, date — Requested pickup date.
  - `ready_by` string, date-time — Requested pickup from this time. Ignore the date part of the date-time.
  - `closed_by` string, date-time — Requested pickup before this time. Ignore the date part of the date-time.
  - `package_location` string — Where on the address the packages should be picked up.
  - `number_of_pieces` integer — Number of pieces that should be picked up.
  - `weight` string — Total weight of all shipments in the pickup request.
  - `is_residential` boolean — Only valid for UPS. Whether or not the pickup address is a residential address.

## Other responses

- `401` — Unauthorized.

---

[API](https://skmtc.net/shipmondo/apis/shipmondo-api.md) · [All operations](https://skmtc.net/shipmondo/apis/shipmondo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipmondo/shipmondo-api/revisions/3b9f91693dec/schema)