Get Manifest | Rendr | Documentation

Retrieve a paginated list of manifests created on the Rendr platform. Results can be filtered by status or store.

Endpoint

GET {{domain}}/{{tenant_id}}/manifests

Authentication: Bearer token required via the Authorization header.

Query Parameters

Parameter	Type	Description
`last_id`	String	Used for pagination. Pass the `id` of the last manifest from the previous response to retrieve the next page.
`status`	String	Filter by manifest status. Accepted values: `open`, `in_process`, `complete`.
`store_id`	String	Filter manifests for a specific store using the Rendr `store_id`.
`store_reference`	String	Filter manifests for a specific store using the store’s reference ID.

Pagination

Each request returns up to 50 manifests. To retrieve the next page, pass the id of the last manifest in the current response as the last_id query parameter in your next request.

Response Fields

Manifest

Field	Type	Description
`id`	String	The unique identifier for the manifest.
`store_id`	String	The Rendr store ID associated with the manifest.
`brand_id`	String	The brand identifier associated with the manifest.
`status`	String	The current status of the manifest. See Manifest Statuses below.
`manifest_group`	String	The carrier service group for this manifest (e.g. `Express Post`, `Parcel Post`).
`manifest_delivery_type`	String	The delivery type classification used for this manifest.
`services`	Array[String]	The carrier services included in this manifest.
`created_at`	String (ISO 8601)	The date and time the manifest was created.
`created_by`	String (email)	The email address of the user or system that created the manifest.
`manifest_deliveries`	Array	The deliveries included in this manifest. See ManifestDelivery below.
`external_ref`	Object	Carrier-side manifest reference data. See ExternalRef below.

ManifestDelivery

Field	Type	Description
`delivery_id`	String	The Rendr delivery ID.
`tracking_details.article_id`	String	The carrier article ID assigned at manifest time.
`tracking_details.consignment_id`	String	The carrier consignment ID.
`tracking_details.barcode_id`	String	The carrier barcode ID for scanning at collection.

ExternalRef

Field	Type	Description
`created_at`	String (ISO 8601)	The date and time the carrier-side manifest was created.
`order_id`	String	The carrier’s manifest or order reference number.
`shipments`	Array	The individual shipments within the manifest. See Shipment below.
`order_summary`	Object	Aggregate totals for the manifest. See OrderSummary below.

Shipment

Field	Type	Description
`shipment_id`	String	The carrier-assigned shipment ID.
`shipment_reference`	String	The merchant reference for the shipment.
`shipment_creation_date`	String (ISO 8601)	The date and time the shipment was created with the carrier.
`items`	Array	The individual items within the shipment. See ShipmentItem below.

ShipmentItem

Field	Type	Description
`item_id`	String	The carrier-assigned item ID.
`item_reference`	String	The merchant item reference.
`product_id`	String	The carrier product ID for this item.
`weight`	Number	The weight of the item in kilograms.
`tracking_details.article_id`	String	The carrier article ID for this item.
`tracking_details.consignment_id`	String	The carrier consignment ID for this item.
`tracking_details.barcode_id`	String	The carrier barcode ID for this item.
`item_summary.status`	String	The current delivery status of this item.

OrderSummary

Field	Type	Description
`number_of_items`	Number	Total number of parcels in the manifest.
`number_of_shipments`	Number	Total number of shipments in the manifest.
`total_weight`	Number	Total weight of all parcels in kilograms.
`total_cost`	Number	Total shipping cost including GST, in dollars.
`total_cost_ex_gst`	Number	Total shipping cost excluding GST, in dollars.
`total_gst`	Number	Total GST amount, in dollars.

Manifest Statuses

Status	Description
`open`	Deliveries have been grouped into a manifest but it has not yet been finalised. No delivery progress has started.
`in_process`	The manifest has been submitted and deliveries are in progress. Not all deliveries have been completed.
`complete`	All deliveries included in the manifest have been successfully delivered.