Skip to main content
POST
/
shipments
/
pickups
Create shipment
curl --request POST \
  --url https://api.quivo.co/shipments/pickups \
  --header 'Content-Type: application/json' \
  --data '
{
  "sellerId": 123,
  "shippingServiceGroupId": 123,
  "parcelCount": 2,
  "pickupDate": "2023-12-25",
  "pickupFrom": {
    "name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "countryIso2": "<string>",
    "street": "<string>",
    "street2": "<string>"
  }
}
'
This response has no body data.

Body

application/json

Data to create a new resource at /shipments/pickups

Request payload for scheduling a new carrier pickup. Contains pickup location details, preferred pickup time window, and shipment references.

​
sellerId
integer<int64>
required

Required seller for which to book the pickup.

​
shippingServiceGroupId
integer<int64>
required

Required shipping service group for which to book the pickup.

​
parcelCount
integer<int32>
required

Required count of parcels which need to be picked up.

Required range: x >= 1
​
pickupDate
string<date>
required

Required day when the booked shipments should be picked up.

​
pickupFrom
object

The

Response

Bad request - the request payload is invalid, missing required fields, or contains invalid data.