Proof of delivery API

The Proof of Delivery API returns the photos and signatures a carrier captured when it delivered an order.

Proof of delivery is only available once the parcel has been delivered and the carrier has sent the documents through. Only some carriers offer it, and the documents can take up to 90 minutes after delivery to appear.

For more information about retrieving proof of delivery documents, and which carriers support this feature, see the proof of delivery section in the Developer Guide.

Endpoints

GET/orders/{tracking_number}/proof_of_deliveryRetrieve the delivery proofs for an order

The proof of delivery object

tracking_numberstringRequired

Unique random ID assigned by Shippit to an order. Use this as a reference for future API calls or support tickets.

delivery_proofsobjectRequired

Delivery proofs for the order, indexed by parcel label number

Delivery proofs are indexed by parcel label number, so a parcel with no proof returns an empty array rather than being left out.

Show child attributesHide child attributes

urlstringRequired: The URL of the proof of delivery file
typestringRequired: The type of proof of delivery document. Can be "PHOTO" or "SIGNATURE"
expires_onstringRequired: The date and time that the proof of delivery URL expires.

Sample responseJSON

{
  "response": {
    "tracking_number": "PPKFqy44U8Nff",
    "delivery_proofs": {
      "parcelWithPODLabelNumber": [
        {
          "url": "https://delivery-proof-dev.s3.ap-southeast-2.amazonaws.com/image.jpeg",
          "type": "PHOTO",
          "expires_on": "2025-12-31T21:00:00.000"
        }
      ],
      "parcelNoPODLabelNumber": []
    }
  }
}

Retrieve proof of delivery for an order

GET/orders/{tracking_number}/proof_of_delivery

Retrieves proof of delivery information for an order using the tracking number.

To perform this operation, you must authenticate with an authentication token.

Parameters

tracking_numberstringpathRequired: The tracking number of the order

Response codes

Status	Meaning	Description
200	OK	Returns an Order's proof of delivery information.
400	Bad Request	Returns an error indicating that the order isn't booked in Shippit, so there is no proof of delivery.
403	Forbidden	Returned when the API key doesn't match a valid merchant account, or the API secret is missing the permission this endpoint requires.
404	Not Found	Returns an error indicating that the order can't be found in Shippit.
500	Internal Server Error	Returned when an unknown error occurs. May be returned if Shippit has trouble with the combination of the input or merchant account configuration.

Response

JSON

{
  "response": {
    "tracking_number": "PPKFqy44U8Nff",
    "delivery_proofs": {
      "parcelWithPODLabelNumber": [
        {
          "url": "https://delivery-proof-dev.s3.ap-southeast-2.amazonaws.com/image.jpeg",
          "type": "PHOTO",
          "expires_on": "2025-12-31T21:00:00.000"
        }
      ],
      "parcelNoPODLabelNumber": []
    }
  }
}