Links

Create Link

View as Markdown

Creates a delivery link to be sent to a customer. Links are primarily used for Rendr’s Click and Deliver product, allowing customers to verify their Click and Collect order exists and book their own delivery for collection.

Click and Deliver must be enabled on your account before this endpoint can be used. Contact Rendr’s implementation team to provision access.

Endpoint

POST {{domain}}/{{tenant_id}}/links

Authentication: Bearer token required via the Authorization header.

Request Payload

POST /rendr/links
1{
2    "store_reference": "Rendr Richmond",
3    "reference": "123456",
4    "expires_at": "2022-03-03T10:00:00+10:00",
5    "customer": {
6        "phone": "0400000000",
7        "email": "status@rendr.delivery",
8        "first_name": "Rendr",
9        "last_name": "Delivery"
10    },
11    "address": {
12        "address": "7 Howard Street",
13        "address2": "Level 3",
14        "city": "Richmond",
15        "state": "VIC",
16        "post_code": "3121"
17    },
18    "line_items": [
19        {
20            "code": "sku-code-001",
21            "name": "SKU Item Name #001",
22            "price_cents": 999,
23            "quantity": 2,
24            "packing_instructions": ""
25        },
26        {
27            "code": "sku-code-002",
28            "name": "SKU Item Name #002",
29            "price_cents": 1999,
30            "quantity": 2
31        }
32    ],
33    "parcels": [
34        {
35            "reference": "Carton",
36            "length_cm": 30,
37            "width_cm": 20,
38            "height_cm": 10,
39            "weight_kg": 3,
40            "quantity": 1
41        }
42    ]
43}

Request Fields

Top-Level Fields

FieldTypeRequiredDescription
store_referenceStringYesThe merchant’s internal store reference, preconfigured by your Rendr implementation partner.
referenceStringYesYour unique identifier for this link — typically an order number. Used to verify the customer’s order at the point of delivery booking.
expires_atString (ISO 8601)NoThe date and time after which the link will no longer be valid.

Customer

FieldTypeRequiredDescription
customer.first_nameStringYesThe recipient’s first name.
customer.last_nameStringYesThe recipient’s last name.
customer.phoneStringYesThe recipient’s mobile phone number. Used to send the delivery link via SMS.
customer.emailStringNoThe recipient’s email address. Used to send the delivery link via email.

Address

FieldTypeRequiredDescription
address.addressStringYesThe street address of the delivery destination.
address.address2StringNoSecondary address line (e.g. unit or level).
address.cityStringYesThe city or suburb of the delivery address.
address.stateStringYesThe abbreviated state or territory (e.g. VIC, NSW).
address.post_codeStringYesThe postcode of the delivery address.

Line Items

FieldTypeRequiredDescription
line_items[].codeStringYesThe SKU or product code for the item.
line_items[].nameStringYesThe human-readable product name.
line_items[].price_centsNumberYesThe unit price in cents (e.g. 999 = $9.99).
line_items[].quantityNumberYesThe number of units of this line item.
line_items[].packing_instructionsStringNoItem-level packing instructions for store staff.

Parcels

FieldTypeRequiredDescription
parcels[].referenceStringYesA reference to identify the parcel.
parcels[].length_cmNumberYesLength of the parcel in centimetres.
parcels[].width_cmNumberYesWidth of the parcel in centimetres.
parcels[].height_cmNumberYesHeight of the parcel in centimetres.
parcels[].weight_kgNumberYesWeight of the parcel in kilograms.
parcels[].quantityNumberYesNumber of identical parcels at these dimensions.

Sample Response

201 Created
1{
2    "data": {
3        "id": "oVI32gAE1mWaWeuQ0awJ",
4        "link": "https://rendr.link/oVI32gAE1mWaWeuQ0awJ"
5    }
6}
FieldTypeDescription
data.idStringThe unique ID for the created link.
data.linkStringThe shareable URL to send to the customer. When opened, the customer can verify their order and book their delivery.