API Documentation

Create a new delivery order.

Payload

{
    "pickupName": "Pickup Name",
    "pickupAddress": {
        "street": "908 Driggs Ave",
        "streetLine2": "Unit 123",
        "city": "Brooklyn",
        "state": "NY",
        "zipCode": "11205"
    },
    "pickupPhone": "7185048700",
    "dropoffName": "Drop off Name",
    "dropoffAddress": {
        "street": "907 Driggs Ave",
        "streetLine2": "",
        "city": "Brooklyn",
        "state": "NY",
        "zipCode": "11205"
    },
    "dropoffPhone": "7185048700",
    "numberOfPackages": 1,
    "packageType": "bag",

    // optional
    "note": "Sample Note",
    "poNumber": "Ref123",
    "tripScheduleTime": "2023-11-13T21:47:49.625Z"
}

This will return the full order object including the trip.id to use for status lookups.

Notes

• pickupPhone / dropoffPhone — must be a real US or Canada number, minimum 10 digits. Leading 1 or +1 is allowed. Only valid area codes are accepted. Always use a mobile number whenever possible — our Pros rely on direct contact to handle details like lock combinations, access codes, and delivery instructions that can make the difference between a successful delivery and a failed one.
• numberOfPackages — the total number of individual parcels in the order. For example, if 3 boxes are being delivered to a single recipient, set this to 3. For mixed items (e.g. a box and a bag), use whichever packageType best describes the contents. Inaccurate values may result in a price adjustment or refusal of delivery on the field.
• tripScheduleTime — ISO 8601 datetime in UTC. Leave blank to dispatch the order ASAP. Dates must be in the future or the order will be deleted. Since time is UTC, it's safest to either omit this field entirely, or pass a date only — e.g. "tripScheduleTime": "2027-11-14" — which will resolve to an appropriate time. If you need a specific time, note that 10:00:00Z is 10am UTC (5am ET in winter, 6am ET in summer).
• packageType — must be one of the following (all lowercase):
  • bag
  • box
  • invitation
  • luggage
  • envelope
  • flower
  • gift_arrangement
  • garment_bag
  • open_wrap
  • delicate
  • other
  • There are more types for seasonal and customer-specific needs — call us for details

Address Formatting

All addresses are validated against third-party services. Keep the following in mind:

Example Response

{
  "id": "clxyz123456",
  "orderNumber": "1234567",
  "status": "awaiting_driver",
  "pickupName": "Pickup Name",
  "dropoffName": "Drop off Name",
  "numberOfPackages": 1,
  "packageType": "bag",
  "note": "Sample Note",
  "poNumber": "Ref123",
  "paymentStatus": "unpaid",
  "createdAt": "2024-06-01T14:30:00.000Z"
}

Look up a trip by its UUID.

Look up a trip by its order number (e.g. 1234567).

Example Response

{
  "id": "clxyz123456",
  "orderNumber": "1234567",
  "status": "picked_up",
  "numberOfPackages": 1,
  "paymentStatus": "unpaid",
  ...
}