---
title: "Request Pickup At Address"
method: POST
path: "/requestpickupataddress"
tags: ["PickupApi"]
---

# Request Pickup At Address

`POST /requestpickupataddress`

Schedules a pickup request for shipments at a specified address. Returns a generated PDF pickup document. Only committed shipments can be picked up; shipments must be committed before a pickup can be requested. If ShipmentIDs in the body is empty or omitted, the pickup is created for all committed shipments that have not been picked up yet.

## Query parameters

- `prefferedpickuptime` string
- `copies` integer
- `mini` boolean

## Request body

- ClientAPIRequestPickUpAtAddress
  - `shipmentIDs` integer[], nullable — List of shipment IDs to include in this pickup request. If empty or omitted, all available shipments are included.
  - `pickupName` string, nullable — Name of the contact person at the pickup address.
  - `pickupCity` string, nullable — City of the pickup address.
  - `pickupZipcode` string, nullable — Postal/zip code of the pickup address.
  - `pickupStreetAndNumber` string, nullable — Street name and number of the pickup address.

## Response `200`

OK

- ClientAPIRequestPickupResultDto
  - `status` 'OK' | 'Error' | 'ValidationFailed' — 0 = OK, 1 = Error, 2 = ValidationFailed
  - `validations` ClientAPIValidation[], nullable
    - `code` integer
    - `message` string, nullable
    - `params` object, nullable
  - `shipmentids` integer[], nullable — List of shipment IDs included in the created pickup.
  - `pickupdocuments` string[], nullable — Base64-encoded PDF pickup documents generated for this request. One document per pickup list number.
  - `pickupintervals` TimeIntervalDate[], nullable — Available pickup time intervals for the scheduled pickup.
    - `from` string, nullable — Start of the pickup/delivery interval (ISO 8601 datetime string).
    - `until` string, nullable — End of the pickup/delivery interval (ISO 8601 datetime string).
  - `pickupIds` integer[], nullable — List of pickup IDs created by this request.
  - `error` ClientAPIError
    - `code` integer
    - `message` string, nullable
    - `stackTrace` string, nullable
    - `innerException` ClientAPIError — recursive
    - `validations` ClientAPIValidation[], nullable
      - `code` integer
      - `message` string, nullable
      - `params` object, nullable
    - `messageParams` string[], nullable
    - `payload` JToken[]
  - `traceID` string, nullable — Unique trace identifier for debugging and support purposes.

---

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