List deliveries
list_deliveriesFetches brewery deliveries, collections, courier shipments, and uplifts with scheduled dates, dispatch status, drop windows, and optional contact details.
Instructions
Deliveries, collections, courier shipments and uplifts (Breww calls them fulfillments) with scheduled date, customer, order, dispatch and completion status, drop window and what is on board. The town is returned by default; the full address, phone number, coordinates and delivery-note links only with include_contact_details. Uses GET /fulfillments/.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | API page to start from (use next_page from a previous call, with the same max_results) | |
| types | No | Only these types (API parameter `type__in`) | |
| failed | No | Failed or not (API parameter `failed`) | |
| run_id | No | Only this delivery run (API parameter `run`) | |
| date_to | No | Scheduled on or before (API parameter `date_scheduled__lte`) | |
| order_id | No | Only deliveries for this order (API parameter `invoice`) | |
| ordering | No | Sort order (API parameter `ordering`): a field name, - in front for descending, several separated by commas. The API's default is ascending id. | |
| completed | No | Completed or not (API parameter `completed`) | |
| date_from | No | Scheduled on or after (API parameter `date_scheduled__gte`) | |
| courier_id | No | Only this courier (API parameter `courier`) | |
| max_results | No | Most records to return in this call; whole API pages only (up to 200 per page), so fewer may come back with a next_page to continue from | |
| include_contact_details | No | Include delivery addresses, phone numbers, coordinates, delivery-note and invoice PDF links, staff names, and unredacted instructions. Off by default. |