List Deliveries

View as Markdown

Retrieve a paginated list of deliveries created on the Rendr platform. Results are returned with the most recent deliveries first, with a maximum of 50 deliveries per page.


Endpoint

GET {{domain}}/{{tenant_id}}/deliveries?page=1

Authentication: Bearer token required via the Authorization header.


Pagination

ParameterTypeDescription
pageIntegerThe page number to retrieve. Defaults to 1. Each page returns up to 50 deliveries.

Filters

The following optional query parameters can be used to filter results:

ParameterTypeDescription
store_referenceStringFilter by the store’s internal reference ID. Example: ?store_reference=STORE123
statusStringFilter by the current delivery status. See Status Lifecycle for eligible values. Example: ?status=collected
manifest_statusStringFilter by manifest status. Accepted values: pending, ready, manifested. Example: ?manifest_status=pending
within_daysIntegerReturn only deliveries created within the last X days. Example: ?within_days=7

Response

Each delivery in the response is returned as a full delivery object. See Create Delivery for a complete description of all response fields.