Skip to main content
GET
/
api
/
public
/
deliveries
/
my
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true,
  "401 Unauthorized": {}
}

​
List Deliveries

Returns deliveries addressed to the authenticated customer. Filter by pending status to show only uncollected parcels.

​
Authentication

Requires a valid customer bearer token.

​
Query Parameters

​
page
number
Page number for pagination. Default: 1.
​
size
number
Number of results per page. Default: 15.
​
showPending
boolean
required
true — return only uncollected deliveries. false — return collected/handled deliveries.
​
query
string
Free-text search string matched against the delivery name.
​
deliveryType
string
Filter by delivery type enum value (e.g. Parcel, Letter, LargeParcel).
​
_shape
string
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=Records.Name,Records.Collected,TotalItems.

​
Response

Returns a DeliveryList object — a paginated wrapper containing an array of delivery records.

​
Pagination

​
Records
Delivery[]
Array of delivery objects for the current page.
​
CurrentPage
number
Current page number (1-based).
​
TotalItems
number
Total number of matching deliveries.
​
TotalPages
number
Total number of pages.
​
HasNextPage
boolean
Whether there are more pages after the current one.
​
HasPreviousPage
boolean
Whether there are pages before the current one.

​
Delivery Fields (within Records[])

​
Identity

FieldTypeDescription
IdnumberUnique numeric identifier for the delivery
UniqueIdstringGlobally unique identifier

​
Core

FieldTypeDescription
NamestringDelivery reference number / name
Notesstring | nullNotes added to the delivery
LocationstringPhysical location where the delivery is stored
DeliveryTypestringType of delivery (Parcel, Letter, etc.)
CoworkerFullNamestringFull name of the customer the delivery is addressed to
RecipientIdnumber | nullId of the specific recipient contact, if applicable
RecipientFullNamestringFull name of the recipient (falls back to customer name)
RequiresSignaturebooleanWhether collection requires a signature

​
Media

FieldTypeDescription
HasImagebooleanWhether the delivery has a label image
ImageUrlstringURL to the delivery label image
HasSignaturebooleanWhether a collection signature was captured
HasScanbooleanWhether a scanned copy exists
HasForwardedFilebooleanWhether a forwarding receipt file exists

​
Status

FieldTypeDescription
CollectedbooleanWhether the delivery has been collected
StoredForCollectionbooleanWhether stored at the location
ReturnedToSenderbooleanWhether returned to sender
CheckDepositedbooleanWhether a check was deposited
ForwardedbooleanWhether forwarded to another address
ScannedbooleanWhether scanned and sent digitally
RecycledbooleanWhether recycled
ShreddedbooleanWhether shredded

​
Status Dates

FieldTypeDescription
CollectedOnstring | nullISO date when collected
StoredForCollectionOnstring | nullISO date when stored for collection
ReturnedToSenderOnstring | nullISO date when returned to sender
CheckDepositedOnstring | nullISO date when check was deposited
ForwardedOnstring | nullISO date when forwarded
ScannedOnstring | nullISO date when scanned
RecycledOnstring | nullISO date when recycled
ShreddedOnstring | nullISO date when shredded

​
Handling

FieldTypeDescription
HandlingPreferencestring | nullCurrent handling preference set by the customer
HandlingPreferenceCanChangebooleanWhether the handling preference can still change
ForwardingAddressUniqueIdstring | nullUniqueId of the forwarding address

​
Timestamps (from base)

FieldTypeDescription
CreatedOnstringDate created (business-local time)
UpdatedOnstring | nullDate last updated (business-local time)
CreatedOnUtcstringDate created (UTC)
UpdatedOnUtcstring | nullDate last updated (UTC)

​
Examples

​
Fetch pending deliveries

GET /api/public/deliveries/my?showPending=true
Authorization: Bearer {token}

​
Fetch with response shaping

GET /api/public/deliveries/my?showPending=true&_shape=Records.Name,Records.DeliveryType,Records.Collected,Records.CollectedOn,TotalItems
Authorization: Bearer {token}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: deliveries } = useTypedData(httpClient, endpoints.deliveries.list(true))

​
Error Responses

​
401 Unauthorized
error
The bearer token is missing, expired, or invalid.
MethodEndpointDescription
GET/api/public/deliveries/{id}Get a single delivery’s full details
PUT/api/public/deliveries/{id}/markAsCollectedMark a delivery as collected