Products
Our API exposes different products that orders can be shipped with (see the Get Products endpoint). This page has a description of each product we offer, the product code it uses, and how you should display it to users.
- Display name is how the product should be displayed to receivers/buyers as part of the ordering flow.
- First mile describes the first mile option used.
- Service describes the service this product uses.
- Region describes the region(s) this product is available in.
Product code | Display name | First mile | Service | Region | Description |
---|---|---|---|---|---|
SAVER-DROPOFF | Sendle Saver | Drop off | saver | US | Sendle's economy shipping product. |
SAVER-PICKUP | Sendle Saver | Pickup | saver | US | Sendle's economy shipping product. |
STANDARD-DROPOFF | Sendle Preferred (Global) Sendle Standard (AU only) | Drop off | standard | Global | Sendle's preferred shipping product. |
STANDARD-PICKUP | Sendle Preferred (Global) Sendle Standard (AU only) | Pickup | standard | Global | Sendle's preferred shipping product. |
EXPRESS-PICKUP | Sendle Express | Pickup | express | AU | Sendle's express shipping product. |
THREE-DAY-PICKUP | Sendle 3-Day Guaranteed | Pickup | threeday | US | Sendle's Three Day service. |
THREE-DAY-DROPOFF | Sendle 3-Day Guaranteed | Drop off | threeday | US | Sendle's Three Day service. |
TWO-DAY-PICKUP | Sendle 2-Day Guaranteed | Pickup | twoday | US | Sendle's Two Day service. |
TWO-DAY-DROPOFF | Sendle 2-Day Guaranteed | Drop off | twoday | US | Sendle's Two Day service. |
GROUND-ADVANTAGE-PICKUP | Ground Advantage Plus | Pickup | groundadvantage | US | Affordable US delivery. |
GROUND-ADVANTAGE-DROPOFF | Ground Advantage Plus | Drop off | groundadvantage | US | Affordable US delivery. |
PRIORITY-PICKUP | Priority Mail Plus | Pickup | prioritymail | US | Priority US delivery. |
PRIORITY-DROPOFF | Priority Mail Plus | Drop off | prioritymail | US | Priority US delivery. |
PRIORITY-EXPRESS-PICKUP | Priority Mail Express Plus | Pickup | prioritymailexpress | US | Express US delivery. |
PRIORITY-EXPRESS-DROPOFF | Priority Mail Express Plus | Drop off | prioritymailexpress | US | Express US delivery. |
FIRST-CLASS-PICKUP | First Class Mail Plus | Pickup | firstclassparcel | US | (deprecated) Affordable US delivery for under 1lb. |
FIRST-CLASS-DROPOFF | First Class Mail Plus | Drop off | firstclassparcel | US | (deprecated) Affordable US delivery for under 1lb. |
PARCEL-SELECT-PICKUP | Parcel Select Ground Plus | Pickup | parcelselect | US | (deprecated) Affordable US delivery for large parcels. |
PARCEL-SELECT-DROPOFF | Parcel Select Ground Plus | Drop off | parcelselect | US | (deprecated) Affordable US delivery for large parcels. |
Size limits
It's important to note that each delivery product can have different size limits. If you system uses the recommended Get products endpoint and supplies all known parcel details (weight, volume, dimensions), we will ensure that only valid products are returned. Using the Get products endpoint before booking helps make sure drivers won't reject parcel pickup due to size issues.
Displaying products to receivers
The names that are returned for products are ones that senders will understand. For example, they may include the first mile (e.g. "pickup" or "drop off"). When displaying products in a checkout flow or in a similar way, where receivers will see the names, you should replace these names with ones more appropriate for receivers.
For example, by using a display name like in the table above. We've got a recipe showing how this can work:
Selecting products via the API
How do you quote or book an order using a specific product? Depending on the endpoint, you'll select products in different ways.
Here's what to do for each one:
- Get products endpoint: This endpoint automatically returns quotes for all valid products on your account (and returns their product codes). We prefer integrations make quotes with this endpoint, as senders will be able to take advantage of new products without any extra work on your end.
- Get a quote or Create an order endpoint: Supply the
product_code
param with the selected product's code. Also make sure thefirst_mile_option
param is not being sent (as the first mile is configured by the product). - View an Order endpoint: You can see which product this order uses by looking at the
product
object on the response.
Updated about 2 months ago