Request a carrier pickup
shipcloud_create_pickup_requestWRITE: order a carrier (dpd, gls, hermes or ups) to pick up parcels at an address in a time window. A real request goes to the carrier and cannot be cancelled through this server; carriers may bill pickups. Without shipment_ids the carrier collects all shipments not yet picked up; return shipments cannot be picked up. Requires confirm=true after the user agreed. POST /pickup_requests.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| latest | Yes | Latest pickup, ISO 8601 with timezone. | |
| carrier | Yes | ||
| confirm | Yes | Must be exactly true. Set it ONLY after the user has explicitly agreed to order this carrier pickup. Ask first; do not assume. | |
| earliest | Yes | Earliest pickup, ISO 8601 with timezone. | |
| shipment_ids | No | Only these shipments; omitted = all not yet picked up. | |
| pickup_address | Yes | Where the carrier collects the parcels. |