{"info":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","description":"<html><head></head><body><h1 id=\"new-ai-powered-docs-available\"><strong>🆕 New AI-Powered Docs Available</strong></h1>\n<h4 id=\"weve-launched-a-new-documentation-site-with-ai-search--better-examples-and-up-to-date-implementation-guides\">We've launched a new documentation site with AI search , better examples, and up-to-date implementation guides.</h4>\n<h4 id=\"visit-the-new-docs-at-docsrendrdelivery-→\"><a href=\"https://docs.rendr.delivery/\"><b>Visit the new docs at docs.rendr.delivery →</b></a></h4>\n<p>Rendr is a delivery orchestration platform that enables merchants to unify, automate, and optimise their delivery operations. Our platform connects seamlessly with carriers, in-store teams, and internal systems to ensure that every order is fulfilled efficiently, cost-effectively, and with a great customer experience.</p>\n<p>You can access Rendr’s capabilities through the Rendr Dashboard or programmatically via the Rendr API, which allows you to create, manage, and track deliveries; configure stores and networks; and build workflows that integrate directly into your commerce stack.</p>\n<hr>\n<h2 id=\"how-it-works\">How it works</h2>\n<p>To get the most value from Rendr, it is important to understand the key features that make up our orchestration platform:</p>\n<ul>\n<li><p><strong>Location Management</strong><br>  Define and manage your store network, including address, operating hours, and courier pickup availability. Each location goes through a pending → active approval process to ensure quality and compliance.</p>\n</li>\n<li><p><strong>Order Ingestion</strong><br>  Submit orders directly to Rendr via the API, Dashboard, or integrations. Rendr validates the details and provides allocation logic across carriers or your own fleet.</p>\n</li>\n<li><p><strong>Delivery Orchestration</strong><br>  Use Rendr’s allocation engine to automatically route orders to the best provider based on cost, speed, service levels, and business rules.</p>\n</li>\n<li><p><strong>Automations &amp; Rules</strong><br>  Dynamic business rules to handle scenarios such as delivery cut-offs, order types, or regulated items (e.g., prescriptions, alcohol).</p>\n</li>\n<li><p><strong>Notifications &amp; Tracking</strong><br>  Customise customer-facing communications and branded live tracking experiences. Receive operational updates via webhooks to power real-time workflows.</p>\n</li>\n<li><p><strong>Analytics &amp; Oversight</strong><br>  Access reporting and monitoring tools to evaluate DIFOT (Delivered In Full On Time), carrier performance, cost efficiency, and exception management.</p>\n</li>\n</ul>\n<h2 id=\"general-workflow\">General Workflow</h2>\n<ol>\n<li><p><strong>Authenticate</strong> – Connect securely with your API key.</p>\n</li>\n<li><p><strong>Create &amp; Manage Locations</strong> – Register your stores with addresses, pickup hours, and geo-coordinates.</p>\n</li>\n<li><p><strong>Quote</strong> – (Optional) Retrieve availble service options; Rendr’s orchestration engine selects the best provider.</p>\n</li>\n<li><p><strong>Create Orders</strong> – Submit orders including customer and delivery details.</p>\n</li>\n<li><p><strong>Track Deliveries</strong> – Monitor real-time delivery status updates.</p>\n</li>\n<li><p><strong>Manage Exceptions</strong> – Handle address corrections, delivery failures, or customer reschedules.</p>\n</li>\n<li><p><strong>Analyse Performance</strong> – Use reporting metrics and dashboards to track delivery SLAs and costs.</p>\n</li>\n</ol>\n<h2 id=\"webhook-overview\">Webhook Overview</h2>\n<p>Rendr supports webhooks to provide merchants with real-time delivery status updates. Webhooks enable seamless system-to-system communication by automatically sending event data to a merchant-defined endpoint whenever a delivery progresses through key lifecycle stages.</p>\n<p>When a delivery transitions between states, such as booked, assigned, collected, or delivered**,** Rendr generates a structured JSON payload and delivers it via an HTTP <code>POST</code> request to the configured webhook URL.</p>\n<p>This mechanism ensures merchants receive immediate, machine-readable notifications that can be used to:</p>\n<ul>\n<li><p>Trigger internal workflows (e.g., order management updates, CRM notifications).</p>\n</li>\n<li><p>Synchronize delivery status across eCommerce, ERP, and customer-facing systems.</p>\n</li>\n<li><p>Enhance customer communication and visibility in real time.</p>\n</li>\n</ul>\n<p>To learn more about webhooks and configure them for your business, please contact your Rendr Account Manager.</p>\n<h2 id=\"getting-connected\">Getting Connected</h2>\n<p>Consumers of the API can be configured with access scoped to either a brand/organisation as a whole OR a brand/organisation and store combination.</p>\n<p>This access level is set via the <code>tenant_id</code> attribute and accommodates both <code>brand_id</code> and <code>store_id</code> variables combined.</p>\n<p>For example:</p>\n<p><code>brand_id</code> -&gt; <code>brandname</code><br><code>store_id</code> -&gt; <code>brandname-storename</code><br><code>tenant_id</code> -&gt; <code>brandname</code> OR <code>brandname-storename</code></p>\n<h2 id=\"delivery-types\">Delivery Types</h2>\n<p>Several delivery types are offered by Rendr. The definition of each of those is described here.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Delivery type name</th>\n<th>Delivery type description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>fast</code></td>\n<td>A delivery service with a 3hr pick-up and delivery window.</td>\n</tr>\n<tr>\n<td><code>flexible</code></td>\n<td>A delivery service with a same day pick-up and delivery window.</td>\n</tr>\n<tr>\n<td><code>standard</code></td>\n<td>A delivery service with a minimum overnight and potentially multi day pick-up and delivery window.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Please note: All prices quoted are GST inclusive.</p>\n<p><strong>Delivery Entity Attributes</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>data.reference</code></td>\n<td>String</td>\n<td>A unique identifier that you use to refer to the booking. This may correspond with an order number in your OMS/POS.</td>\n</tr>\n<tr>\n<td><code>data.id</code></td>\n<td>String</td>\n<td>the unique ID used by the Rendr platform to identify this booked delivery. While this is an additional unique identifier, the Get request utilises your own <code>reference</code> for ease of integration.</td>\n</tr>\n<tr>\n<td><code>data.store_handle</code></td>\n<td>String</td>\n<td>The handle of the delivery pickup store/location which is preconfigured by your Rendr implementation partner.</td>\n</tr>\n<tr>\n<td><code>data.ready_for_pickup_at</code></td>\n<td>String</td>\n<td>The earliest time/date that the order can be collected from the pickup store/location. If you require a minimum amount of time to pick/pack orders this buffer should be accounted for within the earliest time/date value. The time/date format complies with ISO 8601</td>\n</tr>\n<tr>\n<td><code>data.address.business</code></td>\n<td>Boolean</td>\n<td>Whether the delivery address is a business address.</td>\n</tr>\n<tr>\n<td><code>data.address.company_name</code></td>\n<td>String</td>\n<td>The name of the business to which the delivery is to be made.</td>\n</tr>\n<tr>\n<td><code>data.address.address</code></td>\n<td>String</td>\n<td>The street address of the delivery address. this comprises [Unit Number/Street Number] [Street Name] [Street Type] - e.g. 3/20 Smith Street</td>\n</tr>\n<tr>\n<td><code>data.address.city</code></td>\n<td>String</td>\n<td>The city, town, or village of the delivery address.</td>\n</tr>\n<tr>\n<td><code>data.address.state</code></td>\n<td>String</td>\n<td>The state in which the delivery address exists. Must be state abbreviated i.e VIC, NSW</td>\n</tr>\n<tr>\n<td><code>data.address.post_code</code></td>\n<td>String</td>\n<td>The Australian Post Code of the delivery address.</td>\n</tr>\n<tr>\n<td><code>data.customer.first_name</code></td>\n<td>String</td>\n<td>The first name of the person associated with the delivery. This should be the person who will be receiving/accepting the delivery.</td>\n</tr>\n<tr>\n<td><code>data.customer.last_name</code></td>\n<td>String</td>\n<td>The last name of the person associated with the delivery. This should be the person who will be receiving/accepting the delivery.</td>\n</tr>\n<tr>\n<td><code>data.customer.phone</code></td>\n<td>String</td>\n<td>The phone number of the person who will be receiving/accepting the delivery.</td>\n</tr>\n<tr>\n<td><code>data.customer.email</code></td>\n<td>String</td>\n<td>The email address of the customer for whom the delivery is being made. This is typically the person who completed the purchase transaction.</td>\n</tr>\n<tr>\n<td><code>data.line_items</code></td>\n<td>Array</td>\n<td>An array of the line items comprising the delivery.</td>\n</tr>\n<tr>\n<td><code>data.line_items.code</code></td>\n<td>String</td>\n<td>The SKU code for the given delivery line item that is presented to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>data.line_items.name</code></td>\n<td>String</td>\n<td>(Optional) The name for the given delivery line item that is presented to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>data.line_items.price_cents</code></td>\n<td>Number</td>\n<td>(Optional) The price in cents for the given delivery line item, being the price per qty of that line item, that is presented to both the customer and brand fulfilment team.</td>\n</tr>\n<tr>\n<td><code>data.line_items.quantity</code></td>\n<td>Number</td>\n<td>Used to determine the total size and weight of the line items and is present to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>data.parcels</code></td>\n<td>Array</td>\n<td>An array of the parcels comprising the delivery.</td>\n</tr>\n<tr>\n<td><code>data.parcels.reference</code></td>\n<td>String</td>\n<td>A reference that can be used to identify the parcel when packing and delivering.</td>\n</tr>\n<tr>\n<td><code>data.parcels.description</code></td>\n<td>String</td>\n<td>(Optional) A description/instruction that is presented on the Store Portal to assist those packing.</td>\n</tr>\n<tr>\n<td><code>data.parcels.type</code></td>\n<td>String (Optional)</td>\n<td>Applicable parcel type. If not defined parcel will be set by default. Options include: carton, crate, hanging_bag, length, pallet, satchel, skid</td>\n</tr>\n<tr>\n<td><code>data.parcels.length_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>data.parcels.width_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>data.parcels.height_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>data.parcels.weight_kg</code></td>\n<td>Number</td>\n<td>Used to determine the total weight of the parcel.</td>\n</tr>\n<tr>\n<td><code>data.consignment_number</code></td>\n<td>String</td>\n<td>An additional unique booking identifier which is unused at this time, however will support additional future functionality.</td>\n</tr>\n<tr>\n<td><code>data.status</code></td>\n<td>String</td>\n<td>The current status of the delivery. Status values include: <code>booked</code>(a driver is assigned and will pickup the order at or after the earliest pickup time) <code>ready_for_pickup</code> (a status used to indicate the next pick/packing tasks to be completed by store team members) <code>in_transit</code> (the order has been collected and is with the driver for delivery) <code>delivered</code> (the order has been delivered) <code>cancelled</code> (the order/delivery has been cancelled).</td>\n</tr>\n<tr>\n<td><code>data.created_at</code></td>\n<td>String</td>\n<td>The time time/date that the delivery was booked. The time/date format complies with ISO 8601.</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Error Entity Attributes</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field Name</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>request_id</code></td>\n<td>String</td>\n<td>A unique ID generated with the response to assist with investigations of a reported issue.</td>\n</tr>\n<tr>\n<td><code>code</code></td>\n<td>Integer</td>\n<td>HTTP response code</td>\n</tr>\n<tr>\n<td><code>title</code></td>\n<td>String</td>\n<td>Error title</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>String</td>\n<td>Error description. Where possible, the message will be simple and descriptive so that it may be used in user error messages.</td>\n</tr>\n<tr>\n<td><code>errors</code></td>\n<td>Array</td>\n<td>Machine readable error payload. Payload structure and content will vary based on the error case.</td>\n</tr>\n<tr>\n<td><code>details</code></td>\n<td>String</td>\n<td>A flat, technical description of the errors payload for use in logging and with systems which cannot support data structures.</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Example Error Responses</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Title</th>\n<th>Code</th>\n<th>Message</th>\n<th>Details</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Invalid delivery payload</td>\n<td>400</td>\n<td>The data format of your delivery request is incorrect. Please review the payload and re-request the delivery.</td>\n<td>Invalid format or missing fields in delivery payload.</td>\n</tr>\n<tr>\n<td>Invalid delivery address</td>\n<td>400</td>\n<td>The address provided for the delivery is invalid. Please review the destination address and re-request the delivery</td>\n<td>Incomplete or improperly formatted delivery address details.</td>\n</tr>\n<tr>\n<td>Empty quote</td>\n<td>400</td>\n<td>The quote you are requesting has no results available. Please review the payload or contact Rendr for support.</td>\n<td>The quote you are requesting has no results available.</td>\n</tr>\n<tr>\n<td>Distance calculation</td>\n<td>400</td>\n<td>The delivery distance is outside of the defined range. Please review the payload or contact Rendr for support.</td>\n<td>The delivery distance is outside of the defined range.</td>\n</tr>\n<tr>\n<td>Distance configuration</td>\n<td>400</td>\n<td>The distance configuration for your location prevents quotes from being returned. Please review the payload or contact Rendr for support.</td>\n<td>The distance configuration for your location prevents quotes from being returned.</td>\n</tr>\n<tr>\n<td>Weight configuration</td>\n<td>400</td>\n<td>The configuration of your dead weight rules prevent quotes from being returned. Please review the payload or contact Rendr for support.</td>\n<td>The configuration of your dead weight rules prevent quotes from being returned.</td>\n</tr>\n<tr>\n<td>Cubic weight configuration</td>\n<td>400</td>\n<td>The configuration of your cubic weight rules prevent quotes from being returned. Please review the payload or contact Rendr for support.</td>\n<td>The configuration of your cubic weight rules prevent quotes from being returned</td>\n</tr>\n<tr>\n<td>Location configuration</td>\n<td>400</td>\n<td>The requested store is not active. Please contact Rendr for support</td>\n<td>The requested store is not active.</td>\n</tr>\n<tr>\n<td>Service configuration</td>\n<td>400</td>\n<td>The quote you are requesting has no results available. Please review the payload or contact Rendr for support.</td>\n<td>The quote you are requesting has no results available.</td>\n</tr>\n<tr>\n<td>Freight profile configuration</td>\n<td>400</td>\n<td>The configuration of your freight profile prevent quotes from being returned. Please review the payload or contact Rendr for support.</td>\n<td>The configuration of your freight profile prevent quotes from being returned.</td>\n</tr>\n</tbody>\n</table>\n</div></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"🆕 New AI-Powered Docs Available","slug":"new-ai-powered-docs-available"}],"owner":"12638497","collectionId":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","publishedId":"TVeiEX6c","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-24T01:22:11.000Z"},"item":[{"name":"Auth Token","id":"e91ab464-764c-4ab2-bd04-c51c0d718ff7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"grant_type\": \"client_credentials\",\n    \"client_id\": \"{{client_id}}\",\n    \"client_secret\": \"{{client_secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/auth/token","description":"<h2 id=\"authentication\">Authentication</h2>\n<p>On order to authenticate you will need to use your <code>client_id</code> and <code>client_secret</code> provided by your Rendr implementation partner.</p>\n<p>The generated token can be used for a maximum of 3600 seconds (1 hour).</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","auth","token"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"4549e434-2865-4a42-82f8-c087f5951a32","name":"Auth Token - Client Credentials","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"grant_type\": \"client_credentials\",\n    \"client_id\": \"{{client_id}}\",\n    \"client_secret\": \"{{client_secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Content-Length","value":"829","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Cache-Control","value":"private","enabled":true},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Etag","value":"W/\"33d-TNBZM0YDweJJw//8k24nn2ITkVA\"","enabled":true},{"key":"Expect-Ct","value":"max-age=0","enabled":true},{"key":"Function-Execution-Id","value":"y4kf950trx49","enabled":true},{"key":"Referrer-Policy","value":"no-referrer","enabled":true},{"key":"Server","value":"Google Frontend","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains","enabled":true},{"key":"X-Cloud-Trace-Context","value":"d548fa05b779c06e68c9e6fdd2ebee05;o=1","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Country-Code","value":"AU","enabled":true},{"key":"X-Dns-Prefetch-Control","value":"off","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-Xss-Protection","value":"0","enabled":true},{"key":"Accept-Ranges","value":"bytes","enabled":true},{"key":"Date","value":"Mon, 21 Dec 2020 02:19:07 GMT","enabled":true},{"key":"X-Served-By","value":"cache-mel11276-MEL","enabled":true},{"key":"X-Cache","value":"MISS","enabled":true},{"key":"X-Cache-Hits","value":"0","enabled":true},{"key":"X-Timer","value":"S1608517147.805771,VS0,VE880","enabled":true},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"data\": {\n        \"access_token\": \"eyJ...Rrlg\",\n        \"expires_at\": \"2020-12-21T03:19:07.000Z\"\n    }\n}"},{"id":"6a1a4066-f92d-45de-afe3-8fcc28f8a3b4","name":"Auth Token - Password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"grant_type\": \"password\",\n    \"email\": \"{{email}}\",\n    \"password\": \"{{password}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Content-Length","value":"829","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Cache-Control","value":"private","enabled":true},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Etag","value":"W/\"33d-Hjn4A65sUE3KUNX19x961CQBd3s\"","enabled":true},{"key":"Expect-Ct","value":"max-age=0","enabled":true},{"key":"Function-Execution-Id","value":"y4kfckzx3q9m","enabled":true},{"key":"Referrer-Policy","value":"no-referrer","enabled":true},{"key":"Server","value":"Google Frontend","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains","enabled":true},{"key":"X-Cloud-Trace-Context","value":"3b1f2dafab53384b6261c8b06affd472;o=1","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Country-Code","value":"AU","enabled":true},{"key":"X-Dns-Prefetch-Control","value":"off","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-Xss-Protection","value":"0","enabled":true},{"key":"Accept-Ranges","value":"bytes","enabled":true},{"key":"Date","value":"Mon, 21 Dec 2020 02:20:35 GMT","enabled":true},{"key":"X-Served-By","value":"cache-mel11276-MEL","enabled":true},{"key":"X-Cache","value":"MISS","enabled":true},{"key":"X-Cache-Hits","value":"0","enabled":true},{"key":"X-Timer","value":"S1608517235.544043,VS0,VE916","enabled":true},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"data\": {\n        \"access_token\": \"eyJ...hJzg\",\n        \"expires_at\": \"2020-12-21T03:20:35.000Z\"\n    }\n}"}],"_postman_id":"e91ab464-764c-4ab2-bd04-c51c0d718ff7"},{"name":"View Tenant Info","id":"f33d059c-9d75-4be7-bf8d-cd8b981571cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{domain}}/{{tenant_id}}","description":"<p>The <code>View Tenant Info</code> endpoint is used when querying for information of a tenant that has already been created on the Rendr platform.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"6cfa2747-c56f-4d8d-9627-53842dea64ff","name":"View Brand Info","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{domain}}/arkade"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"data\": {\n        \"id\": \"rendr\",\n        \"name\": \"Rendr\",\n        \"contact\": {\n            \"phone\": \"1300 697 363\",\n            \"email\": \"tech@rendr.delivery\",\n            \"name\": \"Rendr\"\n        },\n        \"return_policy\": \"https://rendr.delivery/information/terms-and-conditions\"\n    }\n}"},{"id":"cd900027-1392-4537-88b2-4223c9b29a7d","name":"View Store Info","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{domain}}/arkade-melbourne"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"data\": {\n        \"id\": \"rendr-test\",\n        \"brand_id\": \"rendr\",\n        \"timezone\": \"Australia/Melbourne\",\n        \"name\": \"Rendr Test\",\n        \"opening_hours\": [\n            {\n                \"from\": \"11:00\",\n                \"to\": \"15:00\",\n                \"buffer_minutes\": 45\n            },\n            {\n              \"from\": \"09:00\",\n                \"to\": \"17:00\",\n                \"buffer_minutes\": 30\n            },\n            {\n                \"from\": \"09:00\",\n                \"to\": \"17:00\",\n                \"buffer_minutes\": 30\n            },\n            {\n                \"from\": \"09:00\",\n                \"to\": \"17:00\",\n                \"buffer_minutes\": 30\n            },\n            {\n                \"from\": \"09:00\",\n                \"to\": \"17:00\",\n                \"buffer_minutes\": 30\n            },\n            {\n                \"from\": \"09:00\",\n                \"to\": \"17:00\",\n                \"buffer_minutes\": 30\n            },\n            {\n                \"to\": \"17:00\",\n                \"from\": \"09:00\",\n                \"buffer_minutes\": 60\n            }\n        ],\n        \"address\": {\n            \"city\": \"Richmond\",\n            \"state\": \"VIC\",\n            \"post_code\": \"3121\",\n            \"address\": \"7 Howard Street\"\n        },\n        \"post_code_coverage\": [\n            \"3000\",\n            \"3001\",\n            \"3002\"\n        ],\n        \"contact\": {\n            \"name\": \"Rendr Test\",\n            \"email\": \"tech@rendr.delivery\",\n            \"phone\": \"1300 697 363\"\n        }\n    }\n}"}],"_postman_id":"f33d059c-9d75-4be7-bf8d-cd8b981571cf"},{"name":"Quote a Delivery","id":"34ed1110-ff5d-4ded-8885-cbb50c9fc1ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n    \"store_id\": \"rendr-test\",\n    \"ready_for_pickup_at\": \"2023-10-21T11:45:00+11:00\",\n    \"address\": {\n        \"address\": \"7 Howard Street\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"PARCEL_001\",\n            \"length_cm\": 20,\n            \"width_cm\": 40,\n            \"height_cm\": 60,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\": \"carton\"\n        }\n    ],\n    \"product_types\": {\n        \"alcohol\": true\n    }\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/deliveries/quote-next-available","description":"<p>The <code>Quote a delivery</code> endpoint is used when requesting a delivery quote including service availability and price.</p>\n<p>This endpoint can be used in a range of contexts, for example:</p>\n<ol>\n<li><p>On a website product page the customer can be prompted to provide their postcode to see when a given item could be delivered and the relevant delivery option(s) and price(s)</p>\n</li>\n<li><p>On a website cart page the customer can be prompted to provide their postcode to see when all the items in their cart could be delivered and the relevant delivery option(s) and price(s)</p>\n</li>\n<li><p>During the checkout process customer can be shown delivery options to choose from</p>\n</li>\n</ol>\n<p>Before a delivery can be booked, Rendr needs to know some information about the order such as the pick up location, SKUs, item weights and dimensions, parcel weights and dimensions as well as delivery location/destination.</p>\n<p>The following table details the attributes that can be provided to Rendr in order to generate a Quote.</p>\n<p>Please note: A pickup address is not required/relevant to this process as the pickup address will be assigned based on the <code>store_id</code> attribute sent with the request, which is configured by your Rendr implementation partner.</p>\n<p>Various attributes noted as Optional in the table below are included in the case that logging quote requests with additional information enables simpler tracing for customer service/support purposes.</p>\n<p>💡 TIP: To display all delivery options for a scenario where <code>ready_for_pickup_at</code> will not make it possible to have all or some delivery options available on the current day, a request can be made to the endpoint <strong><code>/quote-next-available</code></strong> which will return available options for the current day as well as available options for next available pickup considering opening hours, public holidays and other configuration</p>\n<p><strong>Request attributes</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>store_id</code></td>\n<td>String</td>\n<td>The ID of the delivery pickup store/location which is preconfigured by your Rendr implementation partner.</td>\n</tr>\n<tr>\n<td><code>store_reference</code></td>\n<td>String</td>\n<td>(Optional) Your internal location identifier preconfigured by your Rendr implementation partner. Used instead of store_id</td>\n</tr>\n<tr>\n<td><code>ready_for_pickup_at</code></td>\n<td>String</td>\n<td>The earliest time/date that the order can be collected from the pickup store/location. If you require a minimum amount of time to pick/pack orders this buffer should be accounted for within the earliest time/date value. The time/date format complies with ISO 8601. Where this attribute is not provided the earliest time/date for pick up will be assumed to be now.</td>\n</tr>\n<tr>\n<td><code>address.address</code></td>\n<td>String (Optional)</td>\n<td>The street address of the delivery address. this comprises [Street Number] [Street Name] [Street Type] - e.g. 20 Smith Street</td>\n</tr>\n<tr>\n<td><code>address.address2</code></td>\n<td>String (Optional)</td>\n<td>The address line2 of the delivery address. - e.g Unit 1, Level 1.</td>\n</tr>\n<tr>\n<td><code>address.city</code></td>\n<td>String</td>\n<td>The city, town, or village of the delivery address.</td>\n</tr>\n<tr>\n<td><code>address.state</code></td>\n<td>String</td>\n<td>The state in which the delivery address exists.</td>\n</tr>\n<tr>\n<td><code>address.post_code</code></td>\n<td>String</td>\n<td>The Australian Post Code of the delivery address.</td>\n</tr>\n<tr>\n<td><code>line_items</code></td>\n<td>Array</td>\n<td>An array of the line items comprising the delivery.</td>\n</tr>\n<tr>\n<td><code>line_items.code</code></td>\n<td>String</td>\n<td>The SKU code for the given delivery line item that is presented to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>line_items.name</code></td>\n<td>String</td>\n<td>The name for the given delivery line item that is presented to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>line_items.price_cents</code></td>\n<td>Number</td>\n<td>The price in cents for the given delivery line item, being the price per qty of that line item, that is presented to both the customer and brand fulfilment team.</td>\n</tr>\n<tr>\n<td><code>line_items.quantity</code></td>\n<td>Number</td>\n<td>Used to determine the total size and weight of the line items and is present to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>parcels</code></td>\n<td>Array</td>\n<td>An array of the parcels comprising the delivery.</td>\n</tr>\n<tr>\n<td><code>parcels.reference</code></td>\n<td>String</td>\n<td>A reference that can be used to identify the parcel when packing and delivering.</td>\n</tr>\n<tr>\n<td><code>parcels.description</code></td>\n<td>String</td>\n<td>(Optional) A description/instruction that is presented on the Store Portal to assist those packing.</td>\n</tr>\n<tr>\n<td><code>data.parcels.type</code></td>\n<td>String (Optional)</td>\n<td>Applicable parcel type. If not defined parcel will be set by default. Options include: carton, crate, hanging_bag, length, pallet, satchel, skid</td>\n</tr>\n<tr>\n<td><code>parcels.length_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>parcels.width_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>parcels.height_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>parcels.weight_kg</code></td>\n<td>Number</td>\n<td>Used to determine the total weight of the parcel.</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Response attributes</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>data</code></td>\n<td>Object</td>\n<td>An object containing all of the available delivery services and associated prices</td>\n</tr>\n<tr>\n<td><code>data.fast</code></td>\n<td>Object</td>\n<td>An object containing the details of the available express courier service which is available to be booked.</td>\n</tr>\n<tr>\n<td><code>data.fast.price_cents</code></td>\n<td>Number</td>\n<td>The price (in cents) that will be charged by Rendr for the fast option if booked.</td>\n</tr>\n<tr>\n<td><code>data.fast.from_datetime</code></td>\n<td>String</td>\n<td>The beginning date/time of the applicable delivery window being the earliest possible delivery date/time.</td>\n</tr>\n<tr>\n<td><code>data.fast.to_datetime</code></td>\n<td>String</td>\n<td>The ending date/time of the applicable delivery window being the latest possible delivery date/time.</td>\n</tr>\n<tr>\n<td><code>data.flexible</code></td>\n<td>Object</td>\n<td>An object containing the details of the available standard courier service which is available to be booked.</td>\n</tr>\n<tr>\n<td><code>data.flexible.price_cents</code></td>\n<td></td>\n<td>Number</td>\n</tr>\n<tr>\n<td><code>data.flexible.from_datetime</code></td>\n<td>String</td>\n<td>The beginning date/time of the applicable delivery window being the earliest possible delivery date/time.</td>\n</tr>\n<tr>\n<td><code>data.flexible.to_datetime</code></td>\n<td>String</td>\n<td>The ending date/time of the applicable delivery window being the latest possible delivery date/time.</td>\n</tr>\n<tr>\n<td><code>data.standard</code></td>\n<td>Object</td>\n<td>An object containing the details of the available express freight service which is available to be booked.</td>\n</tr>\n<tr>\n<td><code>data.standard.price_cents</code></td>\n<td>Number</td>\n<td>The price (in cents) that will be charged by Rendr for the standard option if booked.</td>\n</tr>\n<tr>\n<td><code>data.standard.from_datetime</code></td>\n<td>String</td>\n<td>The beginning date/time of the applicable delivery window being the earliest possible delivery date/time.</td>\n</tr>\n<tr>\n<td><code>data.standard.to_datetime</code></td>\n<td>String</td>\n<td>The ending date/time of the applicable delivery window being the latest possible delivery date/time.</td>\n</tr>\n</tbody>\n</table>\n</div><p>We are always looking for ways to improve our API documentation. Please let us know if you have any feedback or notes that might be helpful to others who may be integrating with our platform.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries","quote-next-available"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"42c42bbc-1190-4942-9102-03f9a31e07f4","name":"Quote a Delivery Before 12PM","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n    \"store_id\": \"rendr-test\",\n    \"ready_for_pickup_at\": \"2022-03-04T10:00:00+11:00\", \n    \"address\": {\n        \"address\":\"7 Howard Street\",\n        \"addrees2\":\"Level 3\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2\n        },\n        {\n            \"code\": \"sku-code-002\",\n            \"name\": \"SKU Item Name #002\",\n            \"price_cents\": 1999,\n            \"quantity\": 2\n        },\n        {\n            \"code\": \"sku-code-003\",\n            \"name\": \"SKU Item Name #003\",\n            \"price_cents\": 9999,\n            \"quantity\": 3\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"PARCEL_001\",\n            \"length_cm\": 20,\n            \"width_cm\": 40,\n            \"height_cm\": 60,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\":\"carton\"\n        },\n        {\n            \"reference\": \"PARCEL_002\",\n            \"length_cm\": 10,\n            \"width_cm\": 10,\n            \"height_cm\": 10,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\":\"satchel\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/deliveries/quote"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Content-Length","value":"398","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Cache-Control","value":"private","enabled":true},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Etag","value":"W/\"18e-5RYBxsbtN7YJjhEPMh212fIWVj4\"","enabled":true},{"key":"Expect-Ct","value":"max-age=0","enabled":true},{"key":"Function-Execution-Id","value":"y4kfk83irlu9","enabled":true},{"key":"Referrer-Policy","value":"no-referrer","enabled":true},{"key":"Server","value":"Google Frontend","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains","enabled":true},{"key":"X-Cloud-Trace-Context","value":"0ba1a6e070980b104b1d20a699d2e03a;o=1","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Country-Code","value":"AU","enabled":true},{"key":"X-Dns-Prefetch-Control","value":"off","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-Xss-Protection","value":"0","enabled":true},{"key":"Accept-Ranges","value":"bytes","enabled":true},{"key":"Date","value":"Mon, 21 Dec 2020 02:21:52 GMT","enabled":true},{"key":"X-Served-By","value":"cache-mel11276-MEL","enabled":true},{"key":"X-Cache","value":"MISS","enabled":true},{"key":"X-Cache-Hits","value":"0","enabled":true},{"key":"X-Timer","value":"S1608517308.342111,VS0,VE4402","enabled":true},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"data\": {\n        \"fast\": {\n            \"price_cents\": 1342,\n            \"from_datetime\": \"2022-03-03T10:00:00+11:00\",\n            \"to_datetime\": \"2022-03-03T12:00:00+11:00\",\n            \"num_days\": 0\n        },\n        \"flexible\": {\n            \"price_cents\": 879,\n            \"from_datetime\": \"2022-03-03T10:00:00+11:00\",\n            \"to_datetime\": \"2022-03-03T15:00:00+11:00\",\n            \"num_days\": 0\n        },\n        \"standard\": {\n            \"price_cents\": 673,\n            \"from_datetime\": \"2022-03-03T10:00:00+11:00\",\n            \"to_datetime\": \"2022-03-06T10:00:00+11:00\",\n            \"num_days\": 3\n        }\n    }\n}"},{"id":"c1131138-15a0-43d1-889b-5321c7623ac7","name":"Quote a Delivery After 12PM","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n    \"store_id\": \"rendr-test\",\n    \"ready_for_pickup_at\": \"2022-03-04T13:00:00+11:00\",\n    \"address\": {\n        \"address\": \"7 Howard Street\",\n        \"addrees2\": \"Level 3\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2\n        },\n        {\n            \"code\": \"sku-code-002\",\n            \"name\": \"SKU Item Name #002\",\n            \"price_cents\": 1999,\n            \"quantity\": 2\n        },\n        {\n            \"code\": \"sku-code-003\",\n            \"name\": \"SKU Item Name #003\",\n            \"price_cents\": 9999,\n            \"quantity\": 3\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"PARCEL_001\",\n            \"length_cm\": 20,\n            \"width_cm\": 40,\n            \"height_cm\": 60,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\": \"carton\"\n        },\n        {\n            \"reference\": \"PARCEL_002\",\n            \"length_cm\": 10,\n            \"width_cm\": 10,\n            \"height_cm\": 10,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\": \"satchel\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/deliveries/quote"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"data\": {\n        \"fast\": {\n            \"price_cents\": 1342,\n            \"from_datetime\": \"2022-03-03T13:00:00+11:00\",\n            \"to_datetime\": \"2022-03-03T15:00:00+11:00\",\n            \"num_days\": 0\n        }\n    }\n}"},{"id":"ac8c7d08-a712-4764-9ed9-561aefdeb1e6","name":"Quote a Delivery Validation Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n    \"store_id\": \"rendr-test\",\n    \"ready_for_pickup_at\": \"2022-03-03T10:00:00+11:00\", \n    \"address\": {\n        \"address\":\"7 Howard Street\",\n        \"addrees2\":\"Level 3\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2\n        },\n        {\n            \"code\": \"sku-code-002\",\n            \"name\": \"SKU Item Name #002\",\n            \"price_cents\": 1999,\n            \"quantity\": 2\n        },\n        {\n            \"code\": \"sku-code-003\",\n            \"name\": \"SKU Item Name #003\",\n            \"price_cents\": 9999,\n            \"quantity\": 3\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"PARCEL_001\",\n            \"length_cm\": 20,\n            \"width_cm\": 40,\n            \"height_cm\": 60,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\":\"carton\"\n        },\n        {\n            \"reference\": \"PARCEL_002\",\n            \"length_cm\": 10,\n            \"width_cm\": 10,\n            \"height_cm\": 10,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\":\"satchel\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/deliveries/quote"},"code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"request_id\": \"u7f1iLShxNH3AEOfc5FEg\",\n    \"code\": 422,\n    \"title\": \"Unprocessable Entity\",\n    \"message\": \"The request is missing a parameter, contains an invalid parameter, includes a parameter more than once, or is otherwise invalid.\",\n    \"errors\": [\n        {\n            \"value\": \"2022-01-25T11:00:00+11:00\",\n            \"property\": \"ready_for_pickup_at\",\n            \"children\": [],\n            \"constraints\": {\n                \"min_date_string\": \"ready_for_pickup_at must be at least 2022-02-07T05:45:10.321Z\"\n            }\n        }\n    ],\n    \"details\": \"ready_for_pickup_at.min_date_string\"\n}"}],"_postman_id":"34ed1110-ff5d-4ded-8885-cbb50c9fc1ce"},{"name":"Request a Delivery","id":"318269fc-167c-405e-9ded-d106448d9921","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n    \"store_id\": \"rendr-hq\",\n    \"book_delivery_now\": true,\n    \"reference\": \"79964249-2\",\n    \"ready_for_pickup_at\": \"2022-10-21T15:45:00+11:00\",\n    \"delivery_type\": \"fast\",\n    \"use_dynamic_RPF\": true,\n    \"address\": {\n        \"address\": \"7 Howard Street\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"customer\": {\n        \"phone\": \"0400000000\",\n        \"email\": \"rendr@rendr.delivery\",\n        \"first_name\": \"Rendr\",\n        \"last_name\": \"Test\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2,\n            \"packing_instructions\": \"\"\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"PARCEL_001\",\n            \"description\": \"BOX A\",\n            \"length_cm\": 20,\n            \"width_cm\": 40,\n            \"height_cm\": 60,\n            \"weight_kg\": 1,\n            \"quantity\": 1\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/deliveries","description":"<p>The <code>Request a Delivery</code> endpoint is used when capturing a customers request for a delivery to be completed.</p>\n<p>This step is typically completed when either:</p>\n<ul>\n<li>A customer has completed the payment step of the checkout on your website; OR</li>\n<li>An order has been completed via another channel (e.g. in-store)</li>\n</ul>\n<p>Before a delivery can be booked, Rendr needs to know some information about the order such as the pick up location, item weights and dimensions, as well as delivery location/destination.</p>\n<p>The following table details the attributes that can be provided to Rendr in order to Book a Delivery.</p>\n<p>Please note: A pickup address is not required/relevant to this process as the pickup address will be assigned based on the store_handle attribute sent with the request, which is configured by your Rendr implementation partner.</p>\n<p>Various attributes noted as Optional in the table below are included in the case that logging quote requests with additional information enables simpler tracing for customer service/support purposes.</p>\n<p>💡 TIP: To ensure the request's <code>ready_for_pickup_at</code> is within the service hours of the location, a quote should be requested prior to the booking request being made. The quote responses' <code>from_datetime</code> should be used as the <code>ready_for_pickup_at</code> in the request delivery's body.</p>\n<p>Alterntatively to achieve the same behaviour of ensuring the booking is created within configured hours, define the field <code>use_dynamic_RFP</code> in the Request a Delivery payload.</p>\n<p><strong>Request attributes</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>reference</code></td>\n<td>String</td>\n<td>A unique identifier that you use to refer to the booking. This may correspond with an order number in your OMS/POS.</td>\n</tr>\n<tr>\n<td><code>store_id</code></td>\n<td>String</td>\n<td>The ID of the delivery pickup store/location which is preconfigured by your Rendr implementation partner.</td>\n</tr>\n<tr>\n<td><code>ready_for_pickup_at</code></td>\n<td>String</td>\n<td>The earliest time/date that the order can be collected from the pickup store/location. If you require a minimum amount of time to pick/pack orders this buffer should be accounted for within the earliest time/date value. The time/date format complies with ISO 8601</td>\n</tr>\n<tr>\n<td><code>special_instructions</code></td>\n<td>String</td>\n<td>(Optional) Delivery instructions which will be provided to the driver upon delivery. In the case special_instructions are pre-configured at the brand / store, request payload values will override the pre-defined value.</td>\n</tr>\n<tr>\n<td><code>pickup_instructions</code></td>\n<td>String</td>\n<td>(Optional) Delivery instructions which will be provided to the driver upon collection. In the case pickup_instructions are pre-configured at the brand / store, request payload values will override the pre-defined value.</td>\n</tr>\n<tr>\n<td><code>book_delivery_now</code></td>\n<td>Boolean</td>\n<td>(Optional) This field can be used to bypass the need for an additonal PATCH Book a Delivery request. When set to true, the delivery will be booked automatically after the delivery is successfully requested.</td>\n</tr>\n<tr>\n<td><code>use_dynamic_RFP</code></td>\n<td>Boolean</td>\n<td>(Optional) This field can be used to ensure the ready_for_pickup_at defined is within the opening hours, buffers and special holidays of a location. This field can be used to bypass the need for a Quote a Delivery request where the from_datetime is used to define the ready_for_pickup_at</td>\n</tr>\n<tr>\n<td><code>delivery_type</code></td>\n<td>String</td>\n<td>The name of the relevant service type which may be either <code>fast</code>, <code>flexible</code> OR <code>standard</code>. Each of these service types is defined further below.</td>\n</tr>\n<tr>\n<td><code>authority_to_leave</code></td>\n<td>Boolean</td>\n<td>Whether the order can be left at the delivery destination without confirming of receipt. This may be overriden by Rendr defined rules such as order value &gt;=1000</td>\n</tr>\n<tr>\n<td><code>address.business</code></td>\n<td>Boolean</td>\n<td>(Optional) Whether the delivery address is a business address.</td>\n</tr>\n<tr>\n<td><code>address.company_name</code></td>\n<td>String</td>\n<td>(Optional) The name of the business to which the delivery is to be made.</td>\n</tr>\n<tr>\n<td><code>address.address</code></td>\n<td>String</td>\n<td>The street address of the delivery address. this comprises [Street Number] [Street Name] [Street Type] - e.g. 20 Smith Street</td>\n</tr>\n<tr>\n<td><code>address.address2</code></td>\n<td>String</td>\n<td>The address line2 of the delivery address. - e.g Unit 1, Level 1.</td>\n</tr>\n<tr>\n<td><code>address.city</code></td>\n<td>String</td>\n<td>The city, town, or village of the delivery address.</td>\n</tr>\n<tr>\n<td><code>address.state</code></td>\n<td>String</td>\n<td>The state in which the delivery address exists.</td>\n</tr>\n<tr>\n<td><code>address.post_code</code></td>\n<td>String</td>\n<td>The state in which the delivery address exists. Must be state abbreviated i.e VIC, NSW</td>\n</tr>\n<tr>\n<td><code>customer.first_name</code></td>\n<td>String</td>\n<td>The first name of the person associated with the delivery. This should be the person who will be receiving/accepting the delivery.</td>\n</tr>\n<tr>\n<td><code>customer.last_name</code></td>\n<td>String</td>\n<td>The last name of the person associated with the delivery. This should be the person who will be receiving/accepting the delivery.</td>\n</tr>\n<tr>\n<td><code>customer.phone</code></td>\n<td>String</td>\n<td>The phone number of the person who will be receiving/accepting the delivery.</td>\n</tr>\n<tr>\n<td><code>customer.email</code></td>\n<td>String</td>\n<td>The email address of the customer for whom the delivery is being made. This is typically the person who completed the purchase transaction.</td>\n</tr>\n<tr>\n<td><code>line_items</code></td>\n<td>Array (Optional)</td>\n<td>An array of the line items comprising the delivery.  <br />Note: If no line items are provided, default values will be passed through to our driver partners</td>\n</tr>\n<tr>\n<td><code>line_items.code</code></td>\n<td>String</td>\n<td>The SKU code for the given delivery line item that is presented to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>line_items.name</code></td>\n<td>String</td>\n<td>The name for the given delivery line item that is presented to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>line_items.price_cents</code></td>\n<td>Number</td>\n<td>The price in cents for the given delivery line item, being the price per qty of that line item, that is presented to both the customer and brand fulfilment team.</td>\n</tr>\n<tr>\n<td><code>line_items.quantity</code></td>\n<td>Number</td>\n<td>Used to determine the total size and weight of the line items and is present to both the customer, brand fulfilment team and delivery driver.</td>\n</tr>\n<tr>\n<td><code>parcels</code></td>\n<td>Array</td>\n<td>An array of the parcels comprising the delivery.</td>\n</tr>\n<tr>\n<td><code>parcels.reference</code></td>\n<td>String</td>\n<td>A reference that can be used to identify the parcel when packing and delivering.</td>\n</tr>\n<tr>\n<td><code>parcels.description</code></td>\n<td>String</td>\n<td>(Optional) A description/instruction that is presented on the Store Portal to assist those packing.</td>\n</tr>\n<tr>\n<td><code>parcels.type</code></td>\n<td>String (Optional)</td>\n<td>Applicable parcel type. If not defined parcel will be set by default. Options include: carton, crate, hanging_bag, length, pallet, satchel, skid</td>\n</tr>\n<tr>\n<td><code>parcels.length_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>parcels.width_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>parcels.height_cm</code></td>\n<td>Number</td>\n<td>Used to determine the total size of the parcel.</td>\n</tr>\n<tr>\n<td><code>parcels.weight_kg</code></td>\n<td>Number</td>\n<td>Used to determine the total weight of the parcel.</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Response attributes</strong></p>\n<p>The response attributes will the same as the <code>Delivery Entity Attributes</code> attributes referenced in the introduction</p>\n<p>We are always looking for ways to improve our API documentation. Please let us know if you have any feedback or notes that might be helpful to others who may be integrating with our platform.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"080afbb3-7654-4b9a-a79b-4dde13f06e5a","name":"Send and Book a Delivery","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"store_id\": \"rendr-test\",\n    \"reference\": \"123456\",\n    \"ready_for_pickup_at\": \"2022-03-03T10:00:00+11:00\",\n    \"special_instructions\": \"Leave at front door\",\n    \"pickup_instructions\": \"Collect from reception\",\n    \"book_delivery_now\": true,\n    \"use_dynamic_RFP\": true,\n    \"delivery_type\": \"fast\",\n    \"authority_to_leave\":true,\n    \"address\": {\n        \"business\": true,\n        \"address\": \"7 Howard Street\",\n        \"address2\": \"Level 3\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\",\n        \"company_name\": \"Sample Company\",\n        \"country\":\"AU\"\n    },\n    \"customer\": {\n        \"phone\": \"0400000000\",\n        \"email\": \"john@doe.com\",\n        \"first_name\": \"John\",\n        \"last_name\": \"Doe\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2,\n            \"packing_instructions\": \"\"\n        },\n        {\n            \"code\": \"sku-code-002\",\n            \"name\": \"SKU Item Name #002\",\n            \"price_cents\": 1999,\n            \"quantity\": 2,\n            \"packing_instructions\": \"\"\n        },\n        {\n            \"code\": \"sku-code-003\",\n            \"name\": \"SKU Item Name #003\",\n            \"price_cents\": 9999,\n            \"quantity\": 3,\n            \"packing_instructions\": \"\"\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"PARCEL_001\",\n            \"description\": \"BOX A\",\n            \"length_cm\": 20,\n            \"width_cm\": 40,\n            \"height_cm\": 60,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\": \"carton\"\n        },\n        {\n            \"reference\": \"PARCEL_002\",\n            \"description\": \"BOX B\",\n            \"length_cm\": 10,\n            \"width_cm\": 10,\n            \"height_cm\": 10,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\": \"satchel\"\n        }\n    ],\n    \"product_types\": {\n        \"alcohol\": true,\n        \"tobacco\": true,\n        \"cannabis\": true,\n        \"prescription_meds_s2\": true,\n        \"prescription_meds_s4\": true,\n        \"prescription_meds_s8\": true,\n        \"secure_documents\": true,\n        \"high_value\": true,\n        \"item_schedule_class\": 2\n    }\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/deliveries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n  \"data\": {\n    \"id\": \"iYEHYCqJ4NiemJyr9Iqr\",\n    \"reference\": \"123456\",\n    \"reference_origin\": \"ecomm\",\n    \"special_instructions\": \"Leave at front door\",\n    \"status\": \"requested\",\n    \"delivery_type\": \"fast\",\n    \"created_at\": \"2021-02-15T22:42:01.236Z\",\n    \"brand_id\": \"acme\",\n    \"store_id\": \"acme-xyz\",\n    \"ready_for_pickup_at\": \"2021-02-16T10:00:00+11:00\",\n    \"customer\": {\n        \"phone\": \"0400000000\",\n        \"email\": \"john@doe.com\",\n        \"first_name\": \"John\",\n        \"last_name\": \"Doe\"\n    },\n    \"address\": {\n        \"business\": true,\n        \"address\": \"7 Howard Street\",\n        \"address2\": \"Level 3\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\",\n        \"company_name\": \"Sample Company\",\n        \"country\":\"AU\"\n    },\n    \"line_items\": [\n      {\n        \"code\": \"sku-code-001\",\n        \"name\": \"SKU Item Name #001\",\n        \"price_cents\": 999,\n        \"quantity\": 2,\n        \"packing_instructions\": \"\"\n      },\n      {\n        \"code\": \"sku-code-002\",\n        \"name\": \"SKU Item Name #002\",\n        \"price_cents\": 1999,\n        \"quantity\": 2,\n        \"packing_instructions\": \"\"\n      },\n      {\n        \"code\": \"sku-code-003\",\n        \"name\": \"SKU Item Name #003\",\n        \"price_cents\": 9999,\n        \"quantity\": 3,\n        \"packing_instructions\": \"\"\n      }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"PARCEL_001\",\n            \"description\": \"BOX A\",\n            \"length_cm\": 20,\n            \"width_cm\": 40,\n            \"height_cm\": 60,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\":\"carton\"\n        },\n        {\n            \"reference\": \"PARCEL_002\",\n            \"description\": \"BOX B\",\n            \"length_cm\": 10,\n            \"width_cm\": 10,\n            \"height_cm\": 10,\n            \"weight_kg\": 1,\n            \"quantity\": 1,\n            \"type\":\"satchel\"\n        }\n    ]\n  },\n  \"tracking_entries\": [\n    {\n      \"status\": \"requested\",\n      \"updated_at\": \"2021-02-15T22:42:01.236Z\"\n    }\n  ]\n}\n"}],"_postman_id":"318269fc-167c-405e-9ded-d106448d9921"},{"name":"Book a Delivery","id":"c95a2aeb-b7f9-4c4b-9913-19580a1972d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/book","description":"<p>The <code>Book a Delivery</code> endpoint is used to book a delivery that was requested using the Request a Delivery endpoint.</p>\n<p>A single delivery may be requested using either the <code>id</code> or the <code>reference</code> provided when the delivery was requested as the unique identifier.</p>\n<p><strong>Response attributes</strong>\nResponse attributes The response attributes will the same as the <code>Delivery Entity Attributes</code> attributes referenced in the introduction</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries","{{delivery_id_or_reference}}","book"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c95a2aeb-b7f9-4c4b-9913-19580a1972d4"},{"name":"Get a Delivery","id":"06a69ff0-245c-43b4-905a-b07164bee246","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"url":"{{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}","description":"<p>The <code>Get a Delivery</code> endpoint is used when querying a delivery that has already been created on the Rendr platform.</p>\n<p>This function can be used once a delivery has been created using the <code>Capture a Delivery</code> endpoint.</p>\n<p>A single delivery may be requested using either the <code>id</code> or the <code>reference</code> provided when the booking was created as the unique identifier.</p>\n<p>The following table details the attributes that can be retrieved in the response.</p>\n<p><strong>Response attributes</strong></p>\n<p>The response attributes will the same as the <code>Delivery Entity Attributes</code> attributes referenced in the introduction.</p>\n<p>We are always looking for ways to improve our API documentation. Please let us know if you have any feedback or notes that might be helpful to others who may be integrating with our platform.</p>\n<p><strong>Delivery Statuses</strong></p>\n<p>Each of Rendr's delivery providers will send different statuses depending on the service type or specific carrier. The full list of statuses is listed below.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Status Name</strong></th>\n<th><strong>API Value</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Created</td>\n<td>created</td>\n<td>Delivery has been created on Rendr, but an issue has occurred. Rendr’s team is notified and will resolve the issue.</td>\n</tr>\n<tr>\n<td>Requested</td>\n<td>requested</td>\n<td>Delivery is ready to be booked</td>\n</tr>\n<tr>\n<td>On Hold</td>\n<td>on_hold</td>\n<td>Delivery has been put on hold to be booked at a later stage, or not.</td>\n</tr>\n<tr>\n<td>Booked</td>\n<td>booked</td>\n<td>Delivery has been booked and the courier has been notified</td>\n</tr>\n<tr>\n<td>Assigned</td>\n<td>assigned</td>\n<td>Delivery has been assigned to a courier</td>\n</tr>\n<tr>\n<td>Approaching</td>\n<td>approaching</td>\n<td>Courier is approaching the pickup location</td>\n</tr>\n<tr>\n<td>Collected</td>\n<td>collected</td>\n<td>Delivery has been collected</td>\n</tr>\n<tr>\n<td>Delivered</td>\n<td>delivered</td>\n<td>Order is successfully delivered</td>\n</tr>\n<tr>\n<td>Pending Reassignment</td>\n<td>pending_reassignment</td>\n<td>Delivery is in the process of being reassigned to another courier since the SLA has not been met.</td>\n</tr>\n<tr>\n<td>Reassigned</td>\n<td>reassigned</td>\n<td>The delivery has been rebooked with another provide to ensure the customer’s expectations are met.</td>\n</tr>\n<tr>\n<td>Cancelled</td>\n<td>cancelled</td>\n<td>Delivery has been canceled</td>\n</tr>\n<tr>\n<td>Pending Return</td>\n<td>pending_return</td>\n<td>Delivery could not be complete. The order is being returned to the pickup location</td>\n</tr>\n<tr>\n<td>Returned</td>\n<td>returned</td>\n<td>Delivery has been returned</td>\n</tr>\n</tbody>\n</table>\n</div><img src=\"https://content.pstmn.io/7af762dc-ca92-4349-b1cc-68302993629b/ZGlhZ3JhbS5wbmc=\" alt />","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries","{{delivery_id_or_reference}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"e35a4d3a-71a5-4e70-b606-fc3c79d4c4a1","name":"Get a Delivery","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"vqHL1yb3Z18iA6E6l69M\",\n    \"brand_id\": \"rendr\",\n    \"store_id\": \"rendr-test\",\n    \"status\": \"delivered\",\n    \"delivery_type\": \"fast\",\n    \"reference\": \"1234\",\n    \"consignment_number\": \"consignment123\",\n    \"address\": {\n        \"business\": false,\n        \"address\": \"6 Howard St\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"customer\": {\n        \"first_name\": \"John\",\n        \"last_name\": \"Doh\",\n        \"phone\": \"0400000000\",\n        \"email\": \"john@doe.com\"\n    },\n    \"line_items\": [\n        {\n            \"price_cents\": 999,\n            \"quantity\": 2,\n            \"name\": \"SKU Item Name #001\",\n            \"code\": \"sku-code-001\"\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"Parcel 1\",\n            \"length_cm\": 30,\n            \"width_cm\": 20,\n            \"height_cm\": 5,\n            \"weight_kg\": 1,\n            \"quantity\": 1\n        }\n    ],\n    \"ready_for_pickup_at\": \"2022-03-02T11:30:41.529+11:00\",\n    \"eta\": \"2022-03-02T04:30:00.000Z\",\n    \"created_at\": \"2022-02-28T23:06:37.765Z\",\n    \"updated_at\": \"2022-03-02T00:48:36.096Z\",\n    \"requested_at\": \"2022-02-28T23:07:02.450Z\",\n    \"booked_at\": \"2022-03-01T01:21:54.794Z\",\n    \"authority_to_leave\": true,\n    \"from_datetime\": \"2022-03-01T11:18:59+11:00\",\n    \"to_datetime\": \"2022-03-01T15:18:59+11:00\",\n    \"num_days\": 0,\n    \"label_url\":\"https://rendr.delivery.pdf\",\n    \"tracking_entries\": [\n        {\n            \"status\": \"requested\",\n            \"updated_at\": \"2022-02-28T23:07:02.491Z\"\n        },\n        {\n            \"status\": \"booked\",\n            \"updated_at\": \"2022-02-28T23:08:02.491Z\"\n        },\n        {\n            \"status\": \"assigned\",\n            \"updated_at\": \"2022-02-28T23:09:02.491Z\"\n        },\n        {\n            \"status\": \"collected\",\n            \"updated_at\": \"2022-02-28T23:10:02.491Z\"\n        },\n        {\n            \"status\": \"collected\",\n            \"updated_at\": \"2022-02-28T23:11:02.491Z\"\n        },\n        {\n            \"status\": \"delivered\",\n            \"updated_at\": \"2022-02-28T23:12:02.491Z\"\n        }\n    ]\n}"}],"_postman_id":"06a69ff0-245c-43b4-905a-b07164bee246"},{"name":"List Deliveries","id":"d85be83d-3606-40ed-a922-3a0baa477458","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{domain}}/{{tenant_id}}/deliveries?page=1","description":"<p>The <code>List Deliveries</code> endpoint is used when querying multiple deliveries that have already been created on the Rendr platform.</p>\n<p>A single request can return a specific page of delivery results.</p>\n<p>Each page of responses will contain a maximum of 50 deliveries with the most recent being presented first.</p>\n<p>Each delivery will be presented as per the response detailed within the <code>Get a Delivery</code> endpoint documentation.</p>\n<h4 id=\"response-attributes\"><strong>Response attributes</strong></h4>\n<p>The response attributes will the same as the <code>Delivery Entity Attributes</code> attributes referenced in the introduction</p>\n<p>We are always looking for ways to improve our API documentation. Please let us know if you have any feedback or notes that might be helpful to others who may be integrating with our platform.</p>\n<h4 id=\"available-filters\">Available Filters</h4>\n<ul>\n<li><p><code>?store_reference=</code> (string, optional)<br />  Filter deliveries by the store’s internal id<br />  <strong>Example:</strong> <code>?store_reference=STORE123</code></p>\n</li>\n<li><p><code>?status=</code> (string, optional)<br />  Filter deliveries by their current status.<br />  Eligible values can be found in the <a href=\"#order-statuses\">Order Statuses</a> section.<br />  <strong>Example:</strong> <code>?status=collected</code></p>\n</li>\n<li><p><code>?manifest_status=</code> (string, optional)<br />  Filter deliveries based on their manifest status.<br />  Eligible values include:</p>\n<ul>\n<li><p><code>pending</code></p>\n</li>\n<li><p><code>ready</code></p>\n</li>\n<li><p><code>manifested</code></p>\n</li>\n</ul>\n</li>\n<li><p><code>within_days</code> (integer, optional)<br />  Returns deliveries created within the last <strong>X</strong> days.<br />  <strong>Example:</strong> <code>?within_days=7</code></p>\n</li>\n</ul>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries"],"host":["{{domain}}"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"b2385f0f-1f80-47ba-992a-45f1d59aa2b8","name":"List Deliveries","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"{{domain}}/{{tenant_id}}/deliveries?page=1","host":["{{domain}}"],"path":["{{tenant_id}}","deliveries"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Content-Length","value":"871","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Cache-Control","value":"private","enabled":true},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Etag","value":"W/\"367-jGFi82qFWh0Lg3RnoLzovUkU7Hc\"","enabled":true},{"key":"Expect-Ct","value":"max-age=0","enabled":true},{"key":"Function-Execution-Id","value":"y4kflbmruumb","enabled":true},{"key":"Referrer-Policy","value":"no-referrer","enabled":true},{"key":"Server","value":"Google Frontend","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains","enabled":true},{"key":"X-Cloud-Trace-Context","value":"38e999385964ecd236215ac08cceb051;o=1","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Country-Code","value":"AU","enabled":true},{"key":"X-Dns-Prefetch-Control","value":"off","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-Xss-Protection","value":"0","enabled":true},{"key":"Accept-Ranges","value":"bytes","enabled":true},{"key":"Date","value":"Mon, 21 Dec 2020 02:24:34 GMT","enabled":true},{"key":"X-Served-By","value":"cache-mel11276-MEL","enabled":true},{"key":"X-Cache","value":"MISS","enabled":true},{"key":"X-Cache-Hits","value":"0","enabled":true},{"key":"X-Timer","value":"S1608517474.547386,VS0,VE907","enabled":true},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n            \"id\": \"vqHL1yb3Z18iA6E6l69M\",\n            \"brand_id\": \"rendr\",\n            \"store_id\": \"rendr-test\",\n            \"status\": \"delivered\",\n            \"delivery_type\": \"fast\",\n            \"reference\": \"1234\",\n            \"consignment_number\": \"consignment123\",\n            \"address\": {\n                \"business\": false,\n                \"address\": \"6 Howard St\",\n                \"city\": \"Richmond\",\n                \"state\": \"VIC\",\n                \"post_code\": \"3121\"\n            },\n            \"customer\": {\n                \"first_name\": \"John\",\n                \"last_name\": \"Doh\",\n                \"phone\": \"0400000000\",\n                \"email\": \"john@doe.com\"\n            },\n            \"line_items\": [\n                {\n          \"price_cents\": 999,\n          \"quantity\": 2,\n          \"name\": \"SKU Item Name #001\",\n          \"code\": \"sku-code-001\"\n                }\n            ],\n            \"parcels\": [\n                {\n                    \"reference\": \"Parcel 1\",\n                    \"length_cm\": 30,\n                    \"width_cm\": 20,\n                    \"height_cm\": 5,\n                    \"weight_kg\": 1,\n                    \"quantity\": 1\n                }\n            ],\n            \"ready_for_pickup_at\": \"2022-03-02T11:30:41.529+11:00\",\n            \"eta\": \"2022-03-02T04:30:00.000Z\",\n            \"created_at\": \"2022-02-28T23:06:37.765Z\",\n            \"updated_at\": \"2022-03-02T00:48:36.096Z\",\n            \"requested_at\": \"2022-02-28T23:07:02.450Z\",\n            \"booked_at\": \"2022-03-01T01:21:54.794Z\",\n            \"authority_to_leave\": true,\n            \"from_datetime\": \"2022-03-01T11:18:59+11:00\",\n            \"to_datetime\": \"2022-03-01T15:18:59+11:00\",\n            \"num_days\": 0,\n            \"tracking_entries\": [\n                {\n                    \"status\": \"requested\",\n                    \"updated_at\": \"2022-02-28T23:07:02.491Z\"\n                },\n                {\n                    \"status\": \"booked\",\n                    \"updated_at\": \"2022-02-28T23:08:02.491Z\"\n                },\n                {\n                    \"status\": \"assigned\",\n                    \"updated_at\": \"2022-02-28T23:09:02.491Z\"\n                },\n                {\n                    \"status\": \"collected\",\n                    \"updated_at\": \"2022-02-28T23:10:02.491Z\"\n                },\n                {\n                    \"status\": \"collected\",\n                    \"updated_at\": \"2022-02-28T23:11:02.491Z\"\n                },\n                {\n                    \"status\": \"delivered\",\n                    \"updated_at\": \"2022-02-28T23:12:02.491Z\"\n                }\n            ]\n        }"}],"_postman_id":"d85be83d-3606-40ed-a922-3a0baa477458"},{"name":"Get a Delivery Label","id":"c9958c85-7bf7-4653-9ed1-9babbb835a9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/label","description":"<p>The <code>Get a Delivery Label</code> endpoint is used when generating one or more labels for a given delivery.</p>\n<p>This function can be used once a delivery has been created using the <code>Create a Delivery</code> endpoint.</p>\n<p>A single delivery may be requested using either the <code>delivery_id</code> provided when the booking was created as the unique identifier.</p>\n<p><strong>Response attributes</strong></p>\n<p>Binary PDF.</p>\n<p>We are always looking for ways to improve our API documentation. Please let us know if you have any feedback or notes that might be helpful to others who may be integrating with our platform.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries","{{delivery_id_or_reference}}","label"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9958c85-7bf7-4653-9ed1-9babbb835a9a"},{"name":"Request Delivery Cancellation","id":"fbbde502-c2c9-4fd0-8b8a-654a1beee9ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"reason\": \"out_of_stock\"\n}"},"url":"{{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/request-cancel","description":"<p>The <code>Request Delivery Cancellation</code> endpoint is used when requesting for a delivery that has already been created on the Rendr platform to be cancelled.</p>\n<p>This function can be used once a delivery has been created using the <code>Create a Delivery</code> endpoint.</p>\n<p>A single delivery may be requested using either the <code>delivery_id</code> provided when the booking was created as the unique identifier.</p>\n<p>The following table details the attributes that can be retrieved in the response.</p>\n<p><strong>Request attributes</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>reason</code></td>\n<td>String</td>\n<td>The reason for needing to cancel the delivery. This is a free text attribute and is used to communicate the reason for customer service handling purposes.</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Response attributes</strong></p>\n<p>The response attributes will the same as the Delivery Entity Attributes attributes referenced in the introduction.</p>\n<p>We are always looking for ways to improve our API documentation. Please let us know if you have any feedback or notes that might be helpful to others who may be integrating with our platform.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries","{{delivery_id_or_reference}}","request-cancel"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fbbde502-c2c9-4fd0-8b8a-654a1beee9ef"},{"name":"Create Store Manifests","id":"e2e11ef1-0eab-4efb-9ac0-5b4cf7701b6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"ready_to_manifest\": true,\n  \"store_reference/store_id\": \"1234\",\n  \"create_manifest_now\": true,\n  \"generate_order_summary\": true,\n  \"delivery_references\": [\n    \"#00001\"\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/store-manifests","description":"<p>The <strong>\"Create Store Manifest\"</strong> endpoint is used to consolidate Australia Post deliveries into one or more manifests, grouped automatically by carrier service (e.g., Parcel Post or Express Post). By submitting the relevant delivery references, Rendr handles the grouping logic internally, eliminating the need for merchants to manage multiple carrier-specific splits.</p>\n<p>A key parameter in this request is <code>create_manifest_now: true</code>, which ensures manifests are created immediately rather than being returned as drafts. In addition, setting <code>generate_order_summary: true</code> will return an <code>order_summary_url</code>, linking directly to a PDF summary of the manifest for quick review or record-keeping.</p>\n<p>When making a request, it’s important to include either <code>store_id</code> or <code>store_reference</code> to properly associate the manifest with the correct store. For flexibility, you may pass <code>delivery_references</code> (merchant-defined identifiers from delivery creation) instead of <code>delivery_ids</code>. This enables seamless alignment with your existing reference system.</p>\n<p>Together, these features simplify manifest creation, reduce operational overhead, and provide ready-to-use documentation for downstream processing.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","store-manifests"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"bd031e19-8f27-42af-89c1-e104e66b6a5c","name":"Store Manifests","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"ready_to_manifest\": true,\n  \"store_reference/store_id\": \"1234\",\n  \"create_manifest_now\": true,\n  \"generate_order_summary\": true,\n  \"delivery_references\": [\n    \"#00001\"\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/store-manifests"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [\n    {\n      \"id\": \"demo-location_one-AUP-20250408041245402\",\n      \"manifest_group\": \"Express Post\",\n      \"delivery_ids\": [\"B6UN5bvyMWvsBVky4MPc\"],\n      \"external_ref\": {\n        \"order_id\": \"TB02944895\",\n        \"order_summary\": {\n          \"number_of_items\": 1,\n          \"total_cost\": 30.53\n        }\n      },\n      \"manifest_deliveries\": [\n        {\n          \"delivery_id\": \"B6UN5bvyMWvsBVky4MPc\",\n          \"tracking_details\": {\n            \"article_id\": \"111JD795013401000964509\"\n          }\n        }\n      ]\n    },\n    {\n      \"id\": \"demo-location_one-AUP-20250408041245327\",\n      \"manifest_group\": \"Parcel Post\",\n      \"delivery_ids\": [\"fa1YSlbS5bu7yWLG6pQ3\"]\n    }\n  ]\n}\n"}],"_postman_id":"e2e11ef1-0eab-4efb-9ac0-5b4cf7701b6d"},{"name":"Get Manifests","id":"057e5f3c-2f45-41fe-94cf-42dae5096818","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{domain}}/{{tenant_id}}/manifests","description":"<p>The <code>Get Manifests</code> endpoint is used to retrieve a list of manifests that has been created on the Rendr platform.</p>\n<p>The following table details the attributes that can be retrieved in the response.</p>\n<h3 id=\"query-parameters\">Query Parameters</h3>\n<p>The <strong>Get Manifests</strong> endpoint supports a few optional query parameters:</p>\n<ul>\n<li><p><strong>last_id</strong> – used for pagination. Pass the <code>id</code> of the last manifest from the previous response to get the next page of results.</p>\n</li>\n<li><p><strong>status</strong> – filter manifests by status (<code>open</code>, <code>in_process</code>, or <code>complete</code>).</p>\n</li>\n<li><p><strong>store_id</strong> – filter manifests for a specific store using the Rendr store_id</p>\n</li>\n<li><p><strong>store_reference</strong> – filter manifests for a specific store using the store’s reference ID.</p>\n</li>\n</ul>\n<h3 id=\"pagination\">Pagination</h3>\n<p>Each request returns up to 50 manifests.  </p>\n<p>To get the next page, pass the <code>last_id</code> from the last manifest in your previous response.  </p>\n<p><strong>Response attributes</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field name</strong></th>\n<th><strong>Type</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>store_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>manifest_deliveries</code></td>\n<td>array[ManifestDelivery]</td>\n</tr>\n<tr>\n<td><code>external_ref</code></td>\n<td>ExternalRef</td>\n</tr>\n<tr>\n<td><code>created_at</code></td>\n<td>string[date]</td>\n</tr>\n<tr>\n<td><code>services</code></td>\n<td>array[string]</td>\n</tr>\n<tr>\n<td><code>created_by</code></td>\n<td>string[email]</td>\n</tr>\n<tr>\n<td><code>brand_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>manifest_delivery_type</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>manifest_group</code></td>\n<td>string</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>ManifestDelivery</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field name</strong></th>\n<th><strong>Type</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>delivery_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>tracking_details</code></td>\n<td>object</td>\n</tr>\n<tr>\n<td><code>tracking_details.article_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>tracking_details.consignment_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>tracking_details.barcode_id</code></td>\n<td>string</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>ExternalRef</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field name</strong></th>\n<th><strong>Type</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>created_at</code></td>\n<td>string[date]</td>\n</tr>\n<tr>\n<td><code>order_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>shipments</code></td>\n<td>array[Shipment]</td>\n</tr>\n<tr>\n<td><code>order_summary</code></td>\n<td>OrderSummary</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Shipment</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field name</strong></th>\n<th><strong>Type</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>shipment_creation_date</code></td>\n<td>string[date]</td>\n</tr>\n<tr>\n<td><code>shipment_reference</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>shipment_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>items</code></td>\n<td>array[ShipmentItem]</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>ShipmentItem</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field name</strong></th>\n<th><strong>Type</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>item_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>item_reference</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>product_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>weight</code></td>\n<td>number</td>\n</tr>\n<tr>\n<td><code>tracking_details</code></td>\n<td>object</td>\n</tr>\n<tr>\n<td><code>tracking_details.article_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>tracking_details.consignment_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>tracking_details.barcode_id</code></td>\n<td>string</td>\n</tr>\n<tr>\n<td><code>item_summary</code></td>\n<td>object</td>\n</tr>\n<tr>\n<td><code>item_summary.status</code></td>\n<td>string</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>OrderSummary</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field name</strong></th>\n<th><strong>Type</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>total_gst</code></td>\n<td>number</td>\n</tr>\n<tr>\n<td><code>number_of_items</code></td>\n<td>number</td>\n</tr>\n<tr>\n<td><code>total_cost_ex_gst</code></td>\n<td>number</td>\n</tr>\n<tr>\n<td><code>total_cost</code></td>\n<td>number</td>\n</tr>\n<tr>\n<td><code>number_of_shipments</code></td>\n<td>number</td>\n</tr>\n<tr>\n<td><code>total_weight</code></td>\n<td>number</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"manifest-statuses\">Manifest Statuses</h3>\n<p>Each manifest returned by the API will include a <code>status</code> attribute. The status reflects the overall progress of deliveries within the manifest:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Status</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><strong>open</strong></td>\n<td>Deliveries have been grouped into a manifest, but the manifest has not yet been finalised. No delivery progress has started.</td>\n</tr>\n<tr>\n<td><strong>in_process</strong></td>\n<td>Deliveries have been manifested and are in progress. Not all deliveries have been completed.</td>\n</tr>\n<tr>\n<td><strong>complete</strong></td>\n<td>All deliveries included in the manifest have been successfully delivered.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","manifests"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"1efb42f7-97c9-4773-9344-b0cc97169c17","name":"Get Manifests","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{domain}}/{{tenant_id}}/manifests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n  \"data\": [\n    {\n      \"id\": \"arkade-sample-STP-20230607061428448\",\n      \"store_id\": \"arkade-sample\",\n      \"manifest_deliveries\": [\n          {\n              \"delivery_id\": \"8DJIALvl6uY1cfCHA86i\",\n              \"tracking_details\": {\n                  \"article_id\": \"162V50000114FPP00001\",\n                  \"consignment_id\": \"162V50000114\",\n                  \"barcode_id\": \"162V50000114FPP00001\"\n              }\n          }\n      ],\n      \"external_ref\": {\n          \"created_at\": \"2023-06-06T23:14:29.000Z\",\n          \"order_id\": \"TB02288744\",\n          \"shipments\": [\n              {\n                  \"shipment_creation_date\": \"2023-06-07T09:14:27+10:00\",\n                  \"shipment_reference\": \"vdv-sample-010\",\n                  \"shipment_id\": \"vSYK0EOp2FkAAAGIP4ACFpL9\",\n                  \"items\": [\n                      {\n                          \"item_id\": \"lX4K0EOp_RgAAAGIQYACFpL9\",\n                          \"item_reference\": \"PARCEL 001\",\n                          \"product_id\": \"FPP\",\n                          \"weight\": 1,\n                          \"tracking_details\": {\n                              \"article_id\": \"162V50000114FPP00001\",\n                              \"consignment_id\": \"162V50000114\",\n                              \"barcode_id\": \"162V50000114FPP00001\"\n                          },\n                          \"item_summary\": {\n                              \"status\": \"Sealed\"\n                          }\n                      }\n                  ]\n              }\n          ],\n          \"order_summary\": {\n              \"total_gst\": 1.76,\n              \"number_of_items\": 1,\n              \"total_cost_ex_gst\": 17.58,\n              \"total_cost\": 19.34,\n              \"number_of_shipments\": 1,\n              \"total_weight\": 1\n          }\n      },\n      \"created_at\": \"2023-06-06T23:14:29.606Z\",\n      \"services\": [\n          \"st_premium_and_express\"\n      ],\n      \"created_by\": \"user@email.com\",\n      \"brand_id\": \"arkade\",\n      \"status\": \"in_process\",\n      \"manifest_delivery_type\": \"standard\",\n      \"manifest_group\": \"StarTrack\"\n    }\n  ]\n}"}],"_postman_id":"057e5f3c-2f45-41fe-94cf-42dae5096818"},{"name":"Create Link","id":"1f5dfe94-d3b8-47c1-8336-6c5b2536a842","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"store_reference\": \"Rendr Richmond\",\n    \"reference\": \"123456\",\n    \"expires_at\":\"2022-03-03T10:00:00+10:00\",\n    \"customer\": {\n        \"phone\": \"0400000000\",\n        \"email\": \"status@rendr.delivery\",\n        \"first_name\": \"Rendr\",\n        \"last_name\": \"Delivery\"\n    },\n    \"address\": {\n        \"address\": \"7 Howard Street\",\n        \"address2\": \"Level 3\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2,\n            \"packing_instructions\": \"\"\n        },\n        {\n            \"code\": \"sku-code-002\",\n            \"name\": \"SKU Item Name #002\",\n            \"price_cents\": 1999,\n            \"quantity\": 2\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"Carton\",\n            \"length_cm\": 30,\n            \"width_cm\": 20,\n            \"height_cm\": 10,\n            \"weight_kg\": 3,\n            \"quantity\": 1\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/rendr/links","description":"<p>Rendr's Link Creation endpoint allows partnering brands or integrators to create a delivery link to be sent to users.</p>\n<p>Links are typically used for Rendr's <a href=\"https://rendr.delivery/click-deliver\">Click and Deliver</a> product, to verify a customer's Click and Collect order exists, allowing verification before a user books their delivery for collection.</p>\n<p>💡 NOTE: If you would like to enable Click and Deliver, Rendr's implementation team provision access to your account.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["rendr","links"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"92102c88-ecfb-471d-9a6e-54d0275bdae7","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"store_reference\": \"Rendr Richmond\",\n    \"reference\": \"123456\",\n    \"expires_at\":\"2022-03-03T10:00:00+10:00\",\n    \"customer\": {\n        \"phone\": \"0400000000\",\n        \"email\": \"status@rendr.delivery\",\n        \"first_name\": \"Rendr\",\n        \"last_name\": \"Delivery\"\n    },\n    \"address\": {\n        \"address\": \"7 Howard Street\",\n        \"address2\": \"Level 3\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2,\n            \"packing_instructions\": \"\"\n        },\n        {\n            \"code\": \"sku-code-002\",\n            \"name\": \"SKU Item Name #002\",\n            \"price_cents\": 1999,\n            \"quantity\": 2\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"Carton\",\n            \"length_cm\": 30,\n            \"width_cm\": 20,\n            \"height_cm\": 10,\n            \"weight_kg\": 3,\n            \"quantity\": 1\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/rendr/links"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","enabled":true},{"key":"content-type","value":"application/json; charset=utf-8","enabled":true},{"key":"etag","value":"W/\"57-V8HsseUA0bZvTeHmc1i+G07dN8U\"","enabled":true},{"key":"expect-ct","value":"max-age=0","enabled":true},{"key":"function-execution-id","value":"xanimelmh5tn","enabled":true},{"key":"referrer-policy","value":"no-referrer","enabled":true},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains","enabled":true},{"key":"x-content-type-options","value":"nosniff","enabled":true},{"key":"x-dns-prefetch-control","value":"off","enabled":true},{"key":"x-download-options","value":"noopen","enabled":true},{"key":"x-frame-options","value":"SAMEORIGIN","enabled":true},{"key":"x-permitted-cross-domain-policies","value":"none","enabled":true},{"key":"x-xss-protection","value":"0","enabled":true},{"key":"X-Cloud-Trace-Context","value":"82be9ab22c1592b25e28a5c7bbf927ce","enabled":true},{"key":"Date","value":"Fri, 14 Oct 2022 01:39:22 GMT","enabled":true},{"key":"Server","value":"Google Frontend","enabled":true},{"key":"Content-Length","value":"87","enabled":true},{"key":"Via","value":"1.1 google","enabled":true},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"data\": {\n        \"id\": \"oVI32gAE1mWaWeuQ0awJ\",\n        \"link\": \"https://rendr.link/oVI32gAE1mWaWeuQ0awJ\"\n    }\n}"},{"id":"f1e7dfe8-92e0-460d-a6d0-acbf4fd3371c","name":"Create Link","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"store_reference\": \"Rendr Richmond\",\n    \"reference\": \"123457\",\n    \"expires_at\":\"2022-03-03T10:00:00+10:00\",\n    \"customer\": {\n        \"phone\": \"0400000000\",\n        \"email\": \"status@rendr.delivery\",\n        \"first_name\": \"Rendr\",\n        \"last_name\": \"Delivery\"\n    },\n    \"address\": {\n        \"address\": \"7 Howard Street\",\n        \"address2\": \"Level 3\",\n        \"city\": \"Richmond\",\n        \"state\": \"VIC\",\n        \"post_code\": \"3121\"\n    },\n    \"line_items\": [\n        {\n            \"code\": \"sku-code-001\",\n            \"name\": \"SKU Item Name #001\",\n            \"price_cents\": 999,\n            \"quantity\": 2,\n            \"packing_instructions\": \"\"\n        },\n        {\n            \"code\": \"sku-code-002\",\n            \"name\": \"SKU Item Name #002\",\n            \"price_cents\": 1999,\n            \"quantity\": 2\n        }\n    ],\n    \"parcels\": [\n        {\n            \"reference\": \"Carton\",\n            \"length_cm\": 30,\n            \"width_cm\": 20,\n            \"height_cm\": 10,\n            \"weight_kg\": 3,\n            \"quantity\": 1\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/rendr/links"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","enabled":true},{"key":"content-type","value":"application/json; charset=utf-8","enabled":true},{"key":"etag","value":"W/\"ca-Mn1XsBcWW7l1dNhTSKwoqAWmneY\"","enabled":true},{"key":"expect-ct","value":"max-age=0","enabled":true},{"key":"function-execution-id","value":"ly676b51rtqo","enabled":true},{"key":"referrer-policy","value":"no-referrer","enabled":true},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains","enabled":true},{"key":"x-content-type-options","value":"nosniff","enabled":true},{"key":"x-dns-prefetch-control","value":"off","enabled":true},{"key":"x-download-options","value":"noopen","enabled":true},{"key":"x-frame-options","value":"SAMEORIGIN","enabled":true},{"key":"x-permitted-cross-domain-policies","value":"none","enabled":true},{"key":"x-xss-protection","value":"0","enabled":true},{"key":"X-Cloud-Trace-Context","value":"64017a6aa18250f2dbe65c96eb340aef","enabled":true},{"key":"Date","value":"Tue, 25 Oct 2022 06:21:38 GMT","enabled":true},{"key":"Server","value":"Google Frontend","enabled":true},{"key":"Content-Length","value":"202","enabled":true},{"key":"Via","value":"1.1 google","enabled":true},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"request_id\": \"_oQRg3xE4zzWrylM1XZ1W\",\n    \"code\": 401,\n    \"title\": \"Unauthorized\",\n    \"message\": \"You must authenticate yourself to use this endpoint.\",\n    \"details\": \"You must authenticate yourself to use this endpoint.\"\n}"}],"_postman_id":"1f5dfe94-d3b8-47c1-8336-6c5b2536a842"},{"name":"Get Manifest Summary","id":"595a84ad-df18-4451-afcd-e3f3aa1e3d3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{domain}}/{{tenant_id}}/manifest/{{manifest_id}}/summary","description":"<p>The <code>Get Order Summary</code> endpoint is used to download the order summary file for the manifest.</p>\n<p><strong>Response attributes</strong></p>\n<p>Type: application/pdf</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","manifest","{{manifest_id}}","summary"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"595a84ad-df18-4451-afcd-e3f3aa1e3d3c"},{"name":"Create a Re-Delivery","id":"e609758b-a0a1-4c2d-9f72-b6ae8bc95f47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"ready_for_pickup_at\": \"2023-10-03T11:30:00+10:00\",\n    \"use_dynamic_RFP\":true\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/redeliver","description":"<p>The Create a Re-Delivery endpoint is used to allow users to create a new delivery based on an original delivery that is ‘pending return’, ‘returned’ or ‘cancelled’ status</p>\n<p>When making a request to the Re-Delivery endpoint, the reference of the delivery will prefixed with RD-</p>\n<p>With a simple API call with no body, all other fields will be copied from the existing payload and a new record will be created and booked.</p>\n<p>The field ready_for_pickup_at is to be required at a minimum, where the full payload or select fields such as delivery_type can also be defined to override the existing reference's values for the new record</p>\n<p>To ensure the delivery is booked within configured location, public holidays and service hours define the field <code>use_dynamic_RFP:true</code> in the Re-Delivery payload.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries","{{delivery_id_or_reference}}","redeliver"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e609758b-a0a1-4c2d-9f72-b6ae8bc95f47"},{"name":"Confirm Return","id":"36a1225f-6fc6-450c-97d3-07793d2ba247","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"note\": \"all_return\", //\"partial_return\", \"no_return\"\n    \"notification_channels\": [\n        \"email\",\n        \"sms\"\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{tenant_id}}/deliveries/{{delivery_id_or_reference}}/confirm-return","description":"<p>The Order Return Confirmation API allows staff members at a merchant's store to confirm the status of an order return. This API is integrated into the merchant's system to provide a seamless process for acknowledging whether an order has been fully returned, partially returned, or not returned at all. Additionally, the API supports sending notifications through various channels.</p>\n<h4 id=\"request-body-schema\">Request Body Schema</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Name</th>\n<th>Type</th>\n<th>Description</th>\n<th>Required</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>note</code></td>\n<td><code>string</code></td>\n<td>Indicates the return status of the order. Valid values are: <code>all_return</code>, <code>partial_return</code>, <code>no_return</code>.</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td><code>notification_channels</code></td>\n<td><code>array</code></td>\n<td>Specifies the channels through which the confirmation notification should be sent. Valid values are <code>email</code> and <code>sms</code>.</td>\n<td>No</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","id":"09de7c83-8f0e-430e-b7a8-c3aa43dc40cf","name":"Rendr API Documentation","type":"collection"}},"urlObject":{"path":["{{tenant_id}}","deliveries","{{delivery_id_or_reference}}","confirm-return"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"36a1225f-6fc6-450c-97d3-07793d2ba247"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"f6b73839-1684-47b0-ab63-722f4aa680b6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"04e716fe-b34c-4cde-aad0-3237fa15eb31","type":"text/javascript","exec":[""]}}]}