Pickups and Dropoffs

The API defines the following resources:

  • Jobs
  • Deliveries
  • Parcels

However, within Jobs and Deliveries we also define a pickup and dropoff data structure.

Pickups

Pickups represent all the data associated with the parcel pickup event. Parcel definitions are always sent with the pickup when creating jobs and deliveries. A pickup contains the following data:

  • Pickup address.
  • Pickup timings.
  • Details relating to the person the parcel will be picked up from.
  • Special instructions relating to the pickup.
  • Pickup sequence - the order in which the pickup location should be visited by the courier.
  • The parcels to be picked up.

Dropoffs

Dropoffs represent all the data associated with a parcel dropoff event. A dropoff contains the following data:

  • Dropoff address.
  • Dropoff timings.
  • Details relating to the person the parcel will be dropped off with.
  • Special instructions relating to the dropoff.
  • Dropoff sequence - the order in which the dropoff location should be visited by the courier.
  • The parcels to be dropped off.