Principles꞉ Collections

Summary

When consigning, a default PickupTypeId and PickupDetails property are automatically added to your consignment if they are not provided, ensuring a message is sent to your courier advising of the collection request

{
  "pickupTypeId": 1,
  "pickupDetails": {
      "preferredPickupDate": "yyyy-MM-ddTHH:mm:ss",
      "preferredPickupCycleId" : 0
  }
}

pickupTypeId - This is the Pickup Type required for the consignment, defaulting to 'Required'

pickupDetails.preferredPickupDate - This is the preferred collection date, defaulting to todays date. The preferred Pickup date is a 30 day window by default, excluding weekends and public holidays. To see the pickup dates available in your region you can you the Collections Dates in the Utils endpoint

pickupDetails.preferredPickupCycleId - This is the preferred Pickup Cycle, defaulting to 'NextCycle'

These properties can be overridden on a per consignment basis, by explicitly providing alternate values