Get a Delivery | Zippd API

curl https://sandbox-api.deliveryapp.com/api/v1/deliveries/deliveryId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": {
    "id": 1024,
    "order_location_id": 58,
    "instruction": "safe-place",
    "instruction_details": "Leave the package behind the potted plant on the porch.",
    "status": "out-for-delivery",
    "tracking_code": "DA6A3U7U-13447",
    "web_tracking_url": "https://www.zippd.com/tracking/?code=DA6A3U7U-13447&email=recipient@example.com",
    "recipient_address": {
      "address_line_1": "123 Grovesby Road",
      "address_line_2": "Billingham House, Flat 45",
      "city": "Manchester",
      "postcode": "M1 2AB",
      "latitude": 53.477582,
      "longitude": -2.255331
    },
    "recipient_details": {
      "contact_name": "Jane Doe",
      "phone_number": "07123456789",
      "email": "recipient@example.com",
      "company_name": "Example Company"
    },
    "sender_details": {
      "company_name": "Example Company",
      "logo_url": "https://yourcompany.com/assets/logo.png"
    },
    "driver": {
      "details": {
        "first_name": "Tom",
        "full_name": "Tom Harrison",
        "profile_image": "https://cdn.deliveryapp.com/drivers/tom_harrison.jpg",
        "has_uploaded_profile_image": true,
        "total_deliveries": 245,
        "average_rating": 4.56
      },
      "recent_location": {
        "latitude": 53.480759,
        "longitude": -2.242631
      },
      "distance": 3.2
    },
    "milestones": {
      "order-received": {
        "datetime": "2024-04-10T08:52:11Z"
      },
      "driver-on-the-way-to-pickup": {
        "datetime": "2024-04-10T09:15:00Z"
      },
      "driver-arrived-at-first-pickup": {
        "datetime": "2024-04-10T09:30:00Z"
      },
      "out-for-delivery": {
        "datetime": "2024-04-10T10:00:00Z",
        "driver_expected_from": "2024-04-10T11:30:00Z",
        "driver_expected_to": "2024-04-10T12:00:00Z"
      },
      "delivered": {
        "datetime": "2024-04-10T11:45:00Z",
        "proof_of_delivery": {
          "photo": "https://cdn.deliveryapp.com/proofs/1024_photo.jpg",
          "signature": "https://cdn.deliveryapp.com/proofs/1024_signature.png",
          "signer_name": "Jane Doe"
        }
      },
      "delivery-partially-successful": {
        "datetime": "2024-04-10T11:45:00Z",
        "undeliverables": {
          "DA003175021383000253": {
            "item_code": "DA003175021383000253",
            "reason": "Damaged in transit"
          }
        },
        "undeliverable_item_count": 1,
        "deliverable_item_count": 2,
        "total_item_count": 3,
        "proof_of_delivery": {
          "photo": "https://cdn.deliveryapp.com/proofs/1024_photo.jpg",
          "signature": "https://cdn.deliveryapp.com/proofs/1024_signature.png",
          "signer_name": "Jane Doe"
        }
      },
      "delivery-unsuccessful": {
        "datetime": "2024-04-10T11:45:00Z",
        "undeliverables": {
          "DA003175021383000253": {
            "item_code": "DA003175021383000253",
            "reason": "Damaged in transit"
          }
        }
      }
    },
    "review": {
      "rating": 5,
      "message": "The delivery was prompt and the driver was very courteous.",
      "reviewer_name": "Jane Doe",
      "created_at": "2024-04-11T16:08:45Z"
    }
  },
  "meta": {
    "all_safe_places": [
      "behind the potted plant",
      "under the porch bench",
      "inside the garage"
    ],
    "all_statuses": [
      "order-received",
      "out-for-delivery",
      "delivered",
      "delivery-partially-successful",
      "delivery-unsuccessful",
      "status-unknown"
    ]
  }
}

Authentication

AuthorizationBearer

Path parameters

deliveryIdstringRequired

Response

dataobject

metaobject

Errors

404

Not Found Error