For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LoginSign Up
DocumentationAPI Reference
DocumentationAPI Reference
  • Deliveries
    • Quote a Delivery
    • Create a Delivery
    • Dangerous Goods
    • Request vs Book
    • Product Types
    • Create International Order
    • Create Return Delivery
    • Create Customer Pickup
    • Create Own Network Deliveries
    • Amend Delivery
    • View Delivery Label
    • Request Delivery Cancellation
    • Create a Re-Delivery
    • Rebook a Delivery
  • Manifests
    • Create Manifest
    • Get Manifest
    • Get Manifest Summary
  • Store Allocation
    • Availability API
    • Allocation API
    • Quote API
  • Tracking, Statuses & Webhooks
    • Get Delivery
    • List Deliveries
    • Confirm Return
    • Webhooks
  • Links
    • Create Link
LogoLogo
LoginSign Up
On this page
  • How It Works
  • Endpoint
  • Request
  • Request Example
  • Response
  • Response Fields
Store Allocation

Quote API — Store Allocator

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Allocation API

Next

Get Delivery

Built with

The Quote Delivery endpoint supports automatic store selection as part of the quoting process. Rather than specifying a single store_id or store_reference, you can pass a list of candidate stores and instruct Rendr to calculate the best fulfilment location on your behalf.


How It Works

Set rendr_store_allocator: true in your quote request alongside an array of store_ids or store_references. Rendr evaluates each candidate store against the delivery destination using your configured location selection strategy and returns a single store_id in the response representing the optimal fulfilment location.

This removes the need to call the Allocation API separately before quoting — the allocation is resolved inline as part of the quote.


Endpoint

1POST {domain}/{tenant_id}/deliveries/quote-next-available

Request

Extend a standard quote request with the following fields:

FieldTypeRequiredDescription
store_idsArrayNo*Array of Rendr store IDs to consider for fulfilment.
store_referencesArrayNo*Array of your internal store references to consider for fulfilment.
rendr_store_allocatorBooleanYesSet to true to enable automatic store selection. Rendr will select the best store from the provided list and return its store_id in the response.

*Either store_ids or store_references is required when rendr_store_allocator is true.


Request Example

1{
2 "store_ids": [
3 "store_001",
4 "store_002",
5 "store_003"
6 ],
7 "rendr_store_allocator": true,
8 "ready_for_pickup_at": "2025-03-12T12:00:00.000",
9 "address": {
10 "address": "7 Howard Street",
11 "city": "Richmond",
12 "state": "VIC",
13 "post_code": "3121"
14 },
15 "line_items": [
16 {
17 "code": "sku-code-001",
18 "name": "SKU Item Name #001",
19 "price_cents": 999,
20 "quantity": 1
21 }
22 ],
23 "parcels": [
24 {
25 "reference": "PARCEL_001",
26 "length_cm": 20,
27 "width_cm": 40,
28 "height_cm": 60,
29 "weight_kg": 1,
30 "quantity": 1,
31 "type": "carton"
32 }
33 ]
34}

Response

The response follows the standard Quote Delivery structure with the addition of a store_id field at the top level, indicating the store Rendr selected as the best fulfilment location.

1{
2 "store_id": "store_001",
3 "data": {
4 "fast": {
5 "price_cents": 1342,
6 "from_datetime": "2025-03-12T12:00:00+11:00",
7 "to_datetime": "2025-03-12T15:00:00+11:00",
8 "num_days": 0
9 },
10 "flexible": {
11 "price_cents": 879,
12 "from_datetime": "2025-03-12T12:00:00+11:00",
13 "to_datetime": "2025-03-12T17:00:00+11:00",
14 "num_days": 0
15 },
16 "standard": {
17 "price_cents": 673,
18 "from_datetime": "2025-03-12T12:00:00+11:00",
19 "to_datetime": "2025-03-15T12:00:00+11:00",
20 "num_days": 3,
21 "provider": "Australia Post",
22 "service": "PARCEL POST + SIGNATURE"
23 }
24 }
25}

Response Fields

FieldTypeDescription
store_idStringThe Rendr store ID of the selected fulfilment location, as determined by the store allocator. Use this value when booking the delivery.
dataObjectStandard quote response containing available delivery options and pricing. See Get Delivery Quote for full field definitions.

The store_id returned in the response should be used as the store_id in your subsequent Create Delivery request to ensure the order is assigned to the correct fulfilment location.