Pre-filled Send Parcel Form

Let your users send parcels with no setup or integration needed, just create one of these URLs and we'll do the rest.

This special URL lets you provide details like sender and receiver addresses, parcel weight and volume, the description to put on the label, and then we'll show a pre-filled form to the sender! If your users need to send parcels, this lets them do so without any API integration work needed.

The sender will need a Sendle account in order to use the prepared form, and if not already setup they'll be prompted to login or create one.

This is the prepared send parcel form URL:

https://www.sendle.com/dashboard/prepare_form?<details here>

For example:

https://www.sendle.com/dashboard/prepare_form?description=Yerba&customer_reference=110184167387-28149559001&delivery_address_line1=4+buyer+address&delivery_address_line2=Glebe&delivery_country=NZ&delivery_address_suburb=Sydney&delivery_address_state=New+South+Wales&delivery_address_postcode=2020&receiver_company=&receiver_name=BuyerName+BuyerLastName&receiver_email=au_sendle_buyer1%40gmail.com&receiver_contact_number=1000057221&parcel_weight_value=5&parcel_weight_units=kg&parcel_size_units=m&parcel_size_length=0.02&parcel_size_width=0.02&parcel_size_height=0.02

The ? in the URL starts the query string, and you can supply the params listed in the tables below.

Be sure to separate terms using <name>=<value> pairs in the query string, separated by &'s, and use percent-encoding when needed (e.g. encoding spaces as + or %20).

Sender Details

The form will be pre-filled with the sender's default pickup details. These are the details they've configured in their Sendle account, so this is the preferred way to set the sender details in the form.

You may also provide the sender_* and pickup_* params below. If you do this, then these will override the configured details in the user's Sendle account and be used instead.

🚧
We recommend not providing the sender_* and pickup_* params, so we can use the pickup details the user's saved in their Sendle dashboard. The details they've saved (including pickup address and instructions) are usually the correct ones.
However, if you provide any of the details in the below list, you'll need to provide all of them. For example, if you only provide sender_name then the user will need to manually give their contact number, pickup address, and pickup instructions. We do this so the form doesn't end up with conflicting names, addresses, or instructions.

Sender Params

Param	Description
`sender_company`	Business name for the sender.
`sender_name`	The sender's name.
`sender_email`	Email address for the sender.
`sender_contact_number`	Drivers can use this to coordinate pickup. This must be a valid local phone number including area code or a fully qualified international number. Examples: `(02) 1234 1234`, `+1 519 123 1234`, `+61 (0)4 1234 1234`, `(321) 555-1234`.
`pickup_instructions`	Short message with pickup instructions for the driver. Should be under 40 chars due to label size limitations.
`pickup_address_line1`	The street address for the location. Do not include the postcode, state, or suburb in this field. Best practice is to keep this under 40 chars due to label size limitations.
`pickup_address_line2`	Second line of the street address for the location. Best practice is to keep this under 40 chars due to label size limitations.
`pickup_address_suburb`	Suburb or town of the location. In certain regions the name here is validated against the postcode, so must be valid and match.
`pickup_address_postcode`	Postcode, postal code, or ZIP code of the location. For locations in Australia and the U.S. this is a four or five digit string. In Canada it's the six character postal code.
`pickup_address_state`	State, province, or territory of the location. For Australia these are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA, with the long-form (i.e. "Northern Territory") also accepted. For Canada these are province/territory 2 letter representations such as ON and AB. For United States these are the state's 2 letter representation such as CA and NY.

Keep in mind, the pickup_* params will be ignored if the order is for drop-off.

Other Details

Parcel Params

All of the below params are optional, and you can leave them out if you don't know them. We'll ask for the required details on the form.

Param	Description
`pickup_date`	If provided this must be at least one non-holiday, business day in the future – for example, `2021-09-24` (`YYYY-MM-DD`). If this is not given it will be set to the earliest available pickup date.
`description`	Lets the receiver track the parcel on their Sendle Dashboard and in emails. This should be human-readable, containing for example an order number, store name, and/or contents. This does not show up on the label.
`parcel_weight_value`	The weight of the parcel, e.g. `2.5`.
`parcel_weight_units`	The unit of measurement for the weight. Must be one of `kg` (kilograms), `lb` (pounds), `g` (grams) or `oz` (ounces).
`parcel_size_units`	The unit of measurement for the sizes. Must be one of `m` (metres), `in` (inches), or `ft` (feet).
`parcel_size_length`	The length of the parcel, e.g. `0.5`.
`parcel_size_width`	The width of the parcel, e.g. `1`.
`parcel_size_height`	The height of the parcel, e.g. `0.75`.
`customer_reference`	Reference that will appear on the label for parcel identification. This can also help senders pick and pack their parcel.

Receiver Params

All of the below params are optional, and you can leave them out if you don't know them.

Param	Description
`receiver_company`	Business name for the receiver. This helps the driver deliver the parcel.
`receiver_name`	The receiver's name.
`receiver_email`	Email address for the receiver. This lets Sendle give the receipient parcel updates.
`receiver_contact_number`	Drivers can use this to coordinate delivery. This must be a valid local phone number including area code or a fully qualified international number. Examples: `(02) 1234 1234`, `+1 519 123 1234`, `+61 (0)4 1234 1234`, `(321) 555-1234`.
`delivery_instructions`	Short message with delivery instructions for the driver. Should be under 40 chars due to label size limitations.
`delivery_address_line1`	The street address for the location. Do not include the postcode, state, or suburb in this field. Best practice is to keep this under 40 chars due to label size limitations.
`delivery_address_line2`	Second line of the street address for the location. Best practice is to keep this under 40 chars due to label size limitations.
`delivery_address_suburb`	Suburb or town of the location. In certain regions the name here is validated against the postcode, so must be valid and match.
`delivery_address_postcode`	Postcode, postal code, or ZIP code of the location. For locations in Australia and the U.S. this is a four or five digit string. In Canada it's the six character postal code.
`delivery_address_state`	State, province, or territory of the location. For Australia these are: ACT, NSW, NT, QLD, SA, TAS, VIC, WA, with the long-form (i.e. "Northern Territory") also accepted. For Canada these are province/territory 2 letter representations such as ON and AB. For United States these are the state's 2 letter representation such as CA and NY.
`delivery_country`	ISO 3166-1 alpha-2 country code of the country the parcel is being delivered to. e.g. AU, CA, US.