Retrieve a list of shipping methods
GET {{baseUrl}}/shipping_methods?sender_address=<string>&service_point_id=<integer>&is_return=<boolean>&from_postal_code=<string>&to_postal_code=<string>&to_country=IO
This endpoint will return a detailed list of all the shipping methods which are available to you under your Sendcloud credentials. You can use this endpoint to find a specific shipping method id, which you can then specify in your request to Create a parcel.
If a shipping method id value is present, and if the request_label parameter has the value true, then a shipping label is created and the parcel is announced.
The shipping methods returned are based on the following factors: 1. The carriers you have enabled in your Sendcloud account; 2. (Optional) The direct carrier contracts you have connected; and, 3. Your sender address
Tip: Via this endpoint you can only retrieve shipping methods based on three parameters:
sender_address,service_point_idandis_return. If you need to filter the results because you require a method which contains a specific shipping functionality or other criteria, you can refer to the Retrieve a list of shipping products endpoint.
In order to view remote surcharges, you are required to provide the
to_countryandto_postal_code. Similarly, to access zonal prices, you need to provideto_country,from_postal_codeandto_postal_code. This information ensures accurate and customized pricing based on the specific location, enabling you to understand any additional charges associated with remote areas and access pricing based on their designated zones.
Specifying a sender address
You can have multiple sender addresses stored in your Sendcloud account. This endpoint will return the shipping methods associated with your default sender address, unless you provide a specific sender_adress id.
Tip: You can find the
idfor each of your sender addresses via the Retrieve a single sender address endpoint.
Use case
For example, your default sender address may be based in the Netherlands, but you have a second sender address based in Austria. If you don't specify a sender_address id, this endpoint will only return shipping methods applicable for shipments from the Netherlands.
To see shipping methods applicable for Austria, e.g. from DPD Austria, specify the id for your Austrian sender address in the HTTP request. The retrieved results will now include carriers such as Post AT, DPD Austria, etc, depending on your enabled carriers.
Example:
GET https://panel.sendcloud.sc/api/v2/shipping_methods?sender_address={ID}
Use cases
- Find a service point delivery shipping method
If you want to retrieve a list of shipping methods which are applicable for service point delivery, provide a service_point_id in the request. You can find an appropriate service_point_id via the Service Points API.
- Find a suitable shipping method for a return
Return shipping methods are treated differently than methods for outgoing parcels. If you want to filter the results to show only the methods which you can apply to return parcels, include the argument is_return: "true".
- Invalid shipment ID Error message
If you try to Create a parcel but receive the error message
Invalid shipment id
, this could be because the specifiedidrelates to a shipping method which is not possible for the given destination address.
For example, if you need to ship a parcel internationally but the specific shipping method only supports national (domestic) shipping, then you would need to lookup a new shipping method id which supports method of delivery and change the request.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sender_address | string | The ID of the sender address for which you would like to know the available shipping methods. If you want to retrieve all available shipping methods, please use all as a value for this parameter. Required if the carrier is zonal. | |
service_point_id | string | The ID of the service point for which you would like to know the available shipping methods. | |
is_return | string | If set to true the endpoint will return shipping methods which can be used for making a return shipment. | |
from_postal_code | string | Postal code of the sender. Required if the carrier is zonal. | |
to_postal_code | string | Postal code of the recipient. Required if the carrier is zonal. Also required to see if remote surcharges apply. | |
to_country | string | A country ISO 2 code for the recipient country. Required if the carrier is zonal. Also required to see if remote surcharges apply. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"shipping_methods":[{"id":"\u003clong\u003e","name":"\u003cstring\u003e","carrier":"\u003cstring\u003e","min_weight":"\u003cstring\u003e","max_weight":"\u003cstring\u003e","service_point_input":"none","price":"\u003clong\u003e","countries":[{"id":"\u003clong\u003e","name":"\u003cstring\u003e","price":"\u003cnumber\u003e","iso_2":"\u003cstring\u003e","iso_3":"\u003cstring\u003e","lead_time_hours":"\u003cinteger\u003e","price_breakdown":[{"type":"\u003cstring\u003e","label":"\u003cstring\u003e","value":"\u003cfloat\u003e"},{"type":"\u003cstring\u003e","label":"\u003cstring\u003e","value":"\u003cfloat\u003e"}]},{"id":"\u003clong\u003e","name":"\u003cstring\u003e","price":"\u003cnumber\u003e","iso_2":"\u003cstring\u003e","iso_3":"\u003cstring\u003e","lead_time_hours":"\u003cinteger\u003e","price_breakdown":[{"type":"\u003cstring\u003e","label":"\u003cstring\u003e","value":"\u003cfloat\u003e"},{"type":"\u003cstring\u003e","label":"\u003cstring\u003e","value":"\u003cfloat\u003e"}]}]}]}