shipping_option_code for creating shipments or returns.
Some shipping options are only available when you connect a direct carrier contract, while others are enabled once you activate a carrier in your Sendcloud account, so you can start shipping with them straight away.
Note: When creating a return you will also be required to provide a
shipping_option_code. You can follow the exact
same process as when choosing a shipping_option_code for an outgoing shipment.Retrieve shipping options
To retrieve a list of shipping options which can be used to create a shipments, make aPOST request to the Return a list of available shipping options endpoint. The shipping options that will be retrieved appear based on the following factors:
- The carriers you have enabled in your Sendcloud account;
- The from and to countries you define;
- Weight and Dimensions of the parcels you define;
- More advanced options such as functionalities of the shipping options you wish to use or service points you wish to ship to
Example request payload
"from_country_code": "NL" and "carrier_code": "dhl" shows only DHL options available from the Netherlands. It does not include all Netherlands options plus all DHL options separately.
If the request is successful, you’ll receive:
- HTTP 200 status code
- A list of shipping options in the response body
code: The unique shipping option code to be used when creating a shipmentrequirements: List of fields that will be required when creating a shipment with a given option (e.g.: email, dimensions)- Other more advanced fields such as quotes and functionalities
You will still get a HTTP 200 status code when an empty list of shipping options is returned. This indicates no active
options in your account match the applied filters. Activate additional options by following this
guide.
Shipping options quotes
Receive discounts on your shipping labels
You don’t need to have a carrier contract to access shipping options in Sendcloud. You can create shipments using Sendcloud rates, and receive a discount on your label price based on your subscription plan. The higher your plan, the more discount you’ll receive.Retrieve shipping options quotes
Set"calculate_quotes": true in the request to the Shipping Options endpoint to include pricing in responses. The response then contains a quotes object for each matching option.
The quotes object returns empty if pricing can’t be calculated, which occurs when:
from_country_codeorto_country_codeis missing- Direct contracts lack uploaded rates (learn how to connect your own contracts and how to upload your direct contract rates)
Each API call returns quotes for one contract per carrier only. Without a specified
contract_id, Sendcloud uses your
default contract per carrier. Compare same carrier contracts by making separate calls with different contract_id
values.Advanced options
Shipping functionalities
Once you’re familiar with making API calls to retrieve shipping options, you may want to filter for shipping options based on their added-value services, known as shipping functionalities. An example of this would be the ability to only retrieve shipping options which require a “Signature on receipt” or that allow you to ship fresh goods. Available functionalities and their meanings are listed in the API reference.Service point shipping options
Use service point shipping options for shipments to pickup locations. Filter results with"functionalities.last_mile": "service_point" to show only compatible options.
For a specific service point, add its to_service_point_id to the request. You can retrieve service point IDs via the Service Points endpoint.
Service point IDs can be retrieved using the Service Points API. Although this endpoint is
currently available in API v2, it is fully compatible with API
v3 and can be
used together with the Shipments API V3.
Return shipping options
Return shipping options prioritize consumer experience and differ from standard outbound options. Filter for them by including"functionalities.returns": true in your request.