Get Delivery Details
Returns the complete details for a specific delivery, including sender, tracking info, and collection status.
Authentication
Requires a valid customer bearer token.
Path Parameters
Numeric identifier of the delivery.
Query Parameters
Comma-separated list of field paths to include in the response. When provided, only the
specified fields are returned — useful for reducing payload size. Supports nested paths
using dot notation. Example: _shape=Delivery.Name,Delivery.Collected.
Response
Returns an object containing a Delivery property with all delivery fields.
Delivery Fields
Identity
| Field | Type | Description |
|---|
Id | number | Unique numeric identifier for the delivery |
UniqueId | string | Globally unique identifier |
Core
| Field | Type | Description |
|---|
Name | string | Delivery reference number / name |
Notes | string | null | Notes added to the delivery |
Location | string | Physical location where the delivery is stored |
DeliveryType | string | Type of delivery (Parcel, Letter, etc.) |
CoworkerFullName | string | Full name of the customer the delivery is addressed to |
RecipientId | number | null | Id of the specific recipient contact, if applicable |
RecipientFullName | string | Full name of the recipient (falls back to customer name) |
RequiresSignature | boolean | Whether collection requires a signature |
| Field | Type | Description |
|---|
HasImage | boolean | Whether the delivery has a label image |
ImageUrl | string | URL to the delivery label image |
HasSignature | boolean | Whether a collection signature was captured |
HasScan | boolean | Whether a scanned copy exists |
HasForwardedFile | boolean | Whether a forwarding receipt file exists |
Status
| Field | Type | Description |
|---|
Collected | boolean | Whether the delivery has been collected |
StoredForCollection | boolean | Whether stored at the location |
ReturnedToSender | boolean | Whether returned to sender |
CheckDeposited | boolean | Whether a check was deposited |
Forwarded | boolean | Whether forwarded to another address |
Scanned | boolean | Whether scanned and sent digitally |
Recycled | boolean | Whether recycled |
Shredded | boolean | Whether shredded |
Status Dates
| Field | Type | Description |
|---|
CollectedOn | string | null | ISO date when collected |
StoredForCollectionOn | string | null | ISO date when stored for collection |
ReturnedToSenderOn | string | null | ISO date when returned to sender |
CheckDepositedOn | string | null | ISO date when check was deposited |
ForwardedOn | string | null | ISO date when forwarded |
ScannedOn | string | null | ISO date when scanned |
RecycledOn | string | null | ISO date when recycled |
ShreddedOn | string | null | ISO date when shredded |
Handling
| Field | Type | Description |
|---|
HandlingPreference | string | null | Current handling preference set by the customer |
HandlingPreferenceCanChange | boolean | Whether the handling preference can still change |
ForwardingAddressUniqueId | string | null | UniqueId of the forwarding address |
Timestamps (from base)
| Field | Type | Description |
|---|
CreatedOn | string | Date created (business-local time) |
UpdatedOn | string | null | Date last updated (business-local time) |
CreatedOnUtc | string | Date created (UTC) |
UpdatedOnUtc | string | null | Date last updated (UTC) |
Examples
Fetch delivery details
GET /api/public/deliveries/77
Authorization: Bearer {token}
Fetch with response shaping
GET /api/public/deliveries/77?_shape=Delivery.Name,Delivery.DeliveryType,Delivery.Collected
Authorization: Bearer {token}
TypeScript Integration
import endpoints from '@/api/endpoints'
const response = await httpClient.get(endpoints.deliveries.details(77))
Error Responses
The bearer token is missing, expired, or invalid.
No delivery exists with the given id.
| Method | Endpoint | Description |
|---|
GET | /api/public/deliveries/my | List all deliveries |
PUT | /api/public/deliveries/{id}/markAsCollected | Mark delivery as collected |
