Create Manifest

View as Markdown

The Create Store Manifest endpoint consolidates booked deliveries into carrier manifests. Rendr handles all grouping logic internally — for example, automatically splitting into separate manifest groups by carrier service — eliminating the need to manage carrier-specific splits yourself.

Manifesting is required before carrier collection. Once deliveries are booked and ready for pickup, a manifest must be submitted to the carrier to authorise collection.


Endpoint

POST {{domain}}/{{tenant_id}}/store-manifests

Authentication: Bearer token required via the Authorization header.


Request Payload

POST /{{tenant_id}}/store-manifests
{
"store_reference": "1234",
"ready_to_manifest": true,
"create_manifest_now": true,
"generate_order_summary": true,
"delivery_references": [
"#00001"
]
}

Parameters

FieldTypeRequiredDescription
store_idStringYes*The Rendr store identifier. Either store_id or store_reference must be provided.
store_referenceStringYes*Your internal store identifier configured during onboarding. Can be used instead of store_id.
ready_to_manifestBooleanNoWhen true, marks all eligible deliveries for the store as ready to be included in the manifest.
create_manifest_nowBooleanYesWhen true, manifests are created and submitted immediately. If false, the manifest is returned as a draft without being submitted to the carrier.
generate_order_summaryBooleanNoWhen true, an order_summary_url is included in the response, linking to a PDF summary of the manifest for record-keeping or printing.
delivery_referencesArrayNoAn array of your merchant-defined delivery references (as supplied at delivery creation). Use this instead of delivery_ids to align with your existing reference system. If omitted, all booked and unmanifested deliveries for the store are included.

Either store_id or store_reference must be provided. If both are supplied, store_id takes precedence.


Sample Response

Rendr returns an array of manifests under data. Each object represents a distinct manifest group, split automatically by carrier service.

201 Created
{
"data": [
{
"id": "demo-location_one-AUP-20250408041245402",
"manifest_group": "Express Post",
"delivery_ids": [
"B6UN5bvyMWvsBVky4MPc"
],
"external_ref": {
"order_id": "TB02944895",
"order_summary": {
"number_of_items": 1,
"total_cost": 30.53
}
},
"manifest_deliveries": [
{
"delivery_id": "B6UN5bvyMWvsBVky4MPc",
"tracking_details": {
"article_id": "111JD795013401000964509"
}
}
]
},
{
"id": "demo-location_one-AUP-20250408041245327",
"manifest_group": "Parcel Post",
"delivery_ids": [
"fa1YSlbS5bu7yWLG6pQ3"
],
"order_summary_url": "https://storage.rendr.delivery/manifests/demo-location_one-AUP-20250408041245327/order-summary.pdf"
}
]
}

Response Fields

FieldTypeDescription
data[].idStringThe unique identifier for the manifest.
data[].manifest_groupStringThe carrier service group for this manifest (e.g. Express Post, Parcel Post). Rendr determines grouping automatically based on the delivery types included.
data[].delivery_idsArrayThe Rendr delivery IDs included in this manifest.
data[].external_ref.order_idStringThe carrier’s manifest or order reference number, returned once the manifest has been submitted.
data[].external_ref.order_summary.number_of_itemsNumberTotal number of parcels included in the manifest.
data[].external_ref.order_summary.total_costNumberTotal shipping cost for the manifest in dollars.
data[].manifest_deliveriesArrayDetailed tracking information for each delivery in the manifest.
data[].manifest_deliveries[].delivery_idStringThe Rendr delivery ID.
data[].manifest_deliveries[].tracking_details.article_idStringThe carrier article ID assigned at manifest time, used for carrier-side tracking.
data[].order_summary_urlStringA URL linking to a PDF summary of the manifest. Only present when generate_order_summary: true is set in the request.