Retrieve a list of shipping products
GET {{baseUrl}}/shipping-products?from_country=<string>&to_country=MY&carrier=<string>&contract=<integer>&weight=<integer>&weight_unit=gram&length=<integer>&length_unit=millimeter&width=<integer>&width_unit=millimeter&height=<integer>&height_unit=millimeter&lead_time_hours=<integer>&contract_pricing=<boolean>&from_postal_code=<string>&to_postal_code=<string>&returns=false
This endpoint allows you to retrieve a list of shipping methods that are associated with your default sender address, filtered by specific criteria such as parcel dimensions, weight classes, from and to country and shipping functionality.
In situations where you need to find a method which supports a specific means of delivery, type of parcel or delivery deadline, for example, this endpoint allows you to filter all available shipping methods based on one or more query parameters.
The response body will include the id of any suitable methods, which you can then use to Create a parcel and announce the shipment directly.
You must have either enabled a carrier in your Sendcloud account, or connected your own direct carrier contract, in order to be able to retrieve shipping methods related to that carrier via this endpoint.
If you have more than one added active contracts for specific carrier, you must fill
contractattribute with your desired contract's ID in your request. You can get your contracts ID from Retrieve a list of contracts.
To see zonal carrier shipping methods, you need to provide
from_postal_codeandto_postal_codequery parameters.
To filter by
{shipping_functionality}, you can find a glossary of accepted values and a description of each functionality under the Retrieve a list of shipping functionalities endpoint.
Use cases
Find a shipping method id for a parcel weighing 5kg, shipping from the Netherlands to the United States with carrier PostNL.
GET https://panel.sendcloud.sc/api/v2/shipping-products?from_country=NL&to_country=US&carrier=postnl&weight=5&weight_unit=kilogram
Find a shipping method which includes the Age Check functionality for shipping alcohol products from France to Belgium.
GET https://panel.sendcloud.sc/api/v2/shipping-products?from_country=NL&to_country=BE&age_check=18
Find a shipping method that supports same day delivery for a product shipping from the Netherlands to the Netherlands.
GET https://panel.sendcloud.sc/api/v2/shipping-products?from_country=NL&to_country=NL&delivery_deadline=sameday
Find a return shipping method for a parcel returning from France to the Netherlands:
GET https://panel.sendcloud.sc/api/v2/shipping-products?from_country=FR&to_country=NL&returns=true
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from_country | string | (Required) A country ISO 2 code for a from country (origin country). | |
to_country | string | A country ISO 2 code for the recipient country. Required if the carrier is zonal or contract_pricing parameter is provided. | |
carrier | string | A carrier code. | |
contract | string | The contract id used for shipping product/method filtering. It has a similar effect as using the carrier parameter. | |
If the contract_pricing parameter is used, the carrier is used to provide the correct contract pricing. | |||
| Only required if multiple contract prices exist for the same shipping method. | |||
weight | string | The weight of the shipment. | |
weight_unit | string | The unit for the shipment weight. Required if the weight parameter is provided. | |
length | string | The length of the shipment. Required if the width and/or height parameters are provided. | |
length_unit | string | The unit for the shipment length. Required if the length parameter is provided. | |
width | string | The width of the shipment. Required if the length and/or height parameters are provided. | |
width_unit | string | The unit for the shipment width. Required if the “width” parameter is provided. | |
height | string | The height of the shipment. Required if the “width” and/or “length” parameters are provided. | |
height_unit | string | The unit for the shipment height. Required if the “height” parameter is provided. | |
lead_time_hours | string | Filters shipping products (rather its associated shipping methods) by their transit time. This is the estimated time a shipment takes between a parcel is being picked up by a carrier and it reaching its destination. This parameter supports comparison operators (e.g. lead_time_hours[gte]=12 for filtering out shipments that have less than 12 hours transit time or lead_time_hours[gte=24]&lead_time_hours[lte]=48 for only including shipping products whose methods have a transit time between 24 and 48 hours). Available operators are “eq” (equal), “gt” (greater than), “lt” (less than), “gte” (greater than or equal), and “lte” (less than or equal). | |
contract_pricing | string | Whether to include contract prices in the response. This parameter is only available to users upon request. Please contact customer support. | |
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. | |
returns | boolean | If set to true the endpoint will return shipping methods which can be used for making a return shipment. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"name":"\u003cstring\u003e","carrier":"\u003cstring\u003e","service_points_carrier":"\u003cstring\u003e","code":"\u003cstring\u003e","weight_range":{"min_weight":"\u003cinteger\u003e","max_weight":"\u003cinteger\u003e"},"methods":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","shipping_product_code":"\u003cstring\u003e","lead_time_hours":{"mollit26":{"aliqua_3e5":"\u003cnumber\u003e","velit9":"\u003cnumber\u003e"},"in_6":{"laborise":"\u003cnumber\u003e","laboris_52":"\u003cnumber\u003e"}},"functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":null,"cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"best_effort","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"pickup_dropoff","flex_delivery":"\u003cboolean\u003e","form_factor":"long","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"dap","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"mailbox","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"priority","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"b","service_area":"domestic","signature":"\u003cboolean\u003e","size":"s","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"weekends"},"properties":{"min_weight":"\u003cinteger\u003e","max_weight":"\u003cinteger\u003e","max_dimensions":{"length":"\u003cinteger\u003e","width":"\u003cinteger\u003e","height":"\u003cinteger\u003e","unit":"centimeter"}}},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","shipping_product_code":"\u003cstring\u003e","lead_time_hours":{"in_819":{"irure_1a3":"\u003cnumber\u003e","ut_30f":"\u003cnumber\u003e"},"elit__b_":{"do_":"\u003cnumber\u003e","non_3e":"\u003cnumber\u003e","Ut_a":"\u003cnumber\u003e"},"velit575":{"dolore_613":"\u003cnumber\u003e"},"aliquip_49":{"velit_706":"\u003cnumber\u003e"}},"functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":"zonal","cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"within_48h","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"pickup","flex_delivery":"\u003cboolean\u003e","form_factor":"long","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"dap_dp","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"pobox","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"express","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"a","service_area":"international","signature":"\u003cboolean\u003e","size":"xl","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"sunday"},"properties":{"min_weight":"\u003cinteger\u003e","max_weight":"\u003cinteger\u003e","max_dimensions":{"length":"\u003cinteger\u003e","width":"\u003cinteger\u003e","height":"\u003cinteger\u003e","unit":"centimeter"}}}],"available_functionalities":{"age_check":["\u003cinteger\u003e","\u003cinteger\u003e"],"b2b":["\u003cboolean\u003e","\u003cboolean\u003e"],"b2c":["\u003cboolean\u003e","\u003cboolean\u003e"],"boxable":["\u003cboolean\u003e","\u003cboolean\u003e"],"bulky_goods":["\u003cboolean\u003e","\u003cboolean\u003e"],"carrier_billing_type":["zonal","country"],"cash_on_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"dangerous_goods":["\u003cboolean\u003e","\u003cboolean\u003e"],"delivery_attempts":["\u003cinteger\u003e","\u003cinteger\u003e"],"delivery_before":["\u003cstring\u003e","\u003cstring\u003e"],"delivery_deadline":["nextday","within_24h"],"direct_contract_only":["\u003cboolean\u003e","\u003cboolean\u003e"],"eco_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"ers":["\u003cboolean\u003e","\u003cboolean\u003e"],"first_mile":["pickup_dropoff","pickup_dropoff"],"flex_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"form_factor":["letter","long"],"fragile_goods":["\u003cboolean\u003e","\u003cboolean\u003e"],"fresh_goods":["\u003cboolean\u003e","\u003cboolean\u003e"],"harmonized_label":["\u003cboolean\u003e","\u003cboolean\u003e"],"id_check":["\u003cboolean\u003e","\u003cboolean\u003e"],"incoterm":["ddp","dap_dp"],"insurance":["\u003cinteger\u003e","\u003cinteger\u003e"],"labelless":["\u003cboolean\u003e","\u003cboolean\u003e"],"last_mile":["mailbox","service_point"],"manually":["\u003cboolean\u003e","\u003cboolean\u003e"],"multicollo":["\u003cboolean\u003e","\u003cboolean\u003e"],"neighbor_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"non_conveyable":["\u003cboolean\u003e","\u003cboolean\u003e"],"personalized_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"premium":["\u003cboolean\u003e","\u003cboolean\u003e"],"priority":["standard",null],"registered_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"returns":["\u003cboolean\u003e","\u003cboolean\u003e"],"segment":["a","b"],"service_area":[null,"domestic"],"signature":["\u003cboolean\u003e","\u003cboolean\u003e"],"size":["m","m"],"sorted":["\u003cboolean\u003e","\u003cboolean\u003e"],"surcharge":["\u003cboolean\u003e","\u003cboolean\u003e"],"tracked":["\u003cboolean\u003e","\u003cboolean\u003e"],"tyres":["\u003cboolean\u003e","\u003cboolean\u003e"],"weekend_delivery":["saturday","saturday"]}},{"name":"\u003cstring\u003e","carrier":"\u003cstring\u003e","service_points_carrier":"\u003cstring\u003e","code":"\u003cstring\u003e","weight_range":{"min_weight":"\u003cinteger\u003e","max_weight":"\u003cinteger\u003e"},"methods":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","shipping_product_code":"\u003cstring\u003e","lead_time_hours":{"officia_9f":{"ut06d":"\u003cnumber\u003e","occaecat_f":"\u003cnumber\u003e"},"voluptatef":{"magna_da":"\u003cnumber\u003e","esse8":"\u003cnumber\u003e","Ut0":"\u003cnumber\u003e"}},"functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":null,"cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"sameday","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"dropoff","flex_delivery":"\u003cboolean\u003e","form_factor":"parcel","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"dap_np","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"service_point","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"economical","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"c","service_area":"international","signature":"\u003cboolean\u003e","size":"xl","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"weekends"},"properties":{"min_weight":"\u003cinteger\u003e","max_weight":"\u003cinteger\u003e","max_dimensions":{"length":"\u003cinteger\u003e","width":"\u003cinteger\u003e","height":"\u003cinteger\u003e","unit":"millimeter"}}},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","shipping_product_code":"\u003cstring\u003e","lead_time_hours":{"ea_15":{"magna_c8":"\u003cnumber\u003e","ad_f":"\u003cnumber\u003e"},"consectetur_986":{"esse340":"\u003cnumber\u003e","qui1":"\u003cnumber\u003e","sit6":"\u003cnumber\u003e","sed333":"\u003cnumber\u003e"},"voluptate0":{"sed_a78":"\u003cnumber\u003e","commodo_6e6":"\u003cnumber\u003e","quisf":"\u003cnumber\u003e"}},"functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":"zonal","cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"within_24h","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"dropoff","flex_delivery":"\u003cboolean\u003e","form_factor":"parcel","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"ddu","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"pobox","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"express","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"c","service_area":"domestic_remote","signature":"\u003cboolean\u003e","size":"xxl","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"weekends"},"properties":{"min_weight":"\u003cinteger\u003e","max_weight":"\u003cinteger\u003e","max_dimensions":{"length":"\u003cinteger\u003e","width":"\u003cinteger\u003e","height":"\u003cinteger\u003e","unit":"millimeter"}}}],"available_functionalities":{"age_check":["\u003cinteger\u003e","\u003cinteger\u003e"],"b2b":["\u003cboolean\u003e","\u003cboolean\u003e"],"b2c":["\u003cboolean\u003e","\u003cboolean\u003e"],"boxable":["\u003cboolean\u003e","\u003cboolean\u003e"],"bulky_goods":["\u003cboolean\u003e","\u003cboolean\u003e"],"carrier_billing_type":["country",null],"cash_on_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"dangerous_goods":["\u003cboolean\u003e","\u003cboolean\u003e"],"delivery_attempts":["\u003cinteger\u003e","\u003cinteger\u003e"],"delivery_before":["\u003cstring\u003e","\u003cstring\u003e"],"delivery_deadline":["within_24h","within_24h"],"direct_contract_only":["\u003cboolean\u003e","\u003cboolean\u003e"],"eco_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"ers":["\u003cboolean\u003e","\u003cboolean\u003e"],"first_mile":["fulfilment",null],"flex_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"form_factor":["letter","parcel"],"fragile_goods":["\u003cboolean\u003e","\u003cboolean\u003e"],"fresh_goods":["\u003cboolean\u003e","\u003cboolean\u003e"],"harmonized_label":["\u003cboolean\u003e","\u003cboolean\u003e"],"id_check":["\u003cboolean\u003e","\u003cboolean\u003e"],"incoterm":["dap_np",null],"insurance":["\u003cinteger\u003e","\u003cinteger\u003e"],"labelless":["\u003cboolean\u003e","\u003cboolean\u003e"],"last_mile":["pobox","pobox"],"manually":["\u003cboolean\u003e","\u003cboolean\u003e"],"multicollo":["\u003cboolean\u003e","\u003cboolean\u003e"],"neighbor_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"non_conveyable":["\u003cboolean\u003e","\u003cboolean\u003e"],"personalized_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"premium":["\u003cboolean\u003e","\u003cboolean\u003e"],"priority":["standard","economical"],"registered_delivery":["\u003cboolean\u003e","\u003cboolean\u003e"],"returns":["\u003cboolean\u003e","\u003cboolean\u003e"],"segment":["a+","d"],"service_area":["domestic",null],"signature":["\u003cboolean\u003e","\u003cboolean\u003e"],"size":["s","m"],"sorted":["\u003cboolean\u003e","\u003cboolean\u003e"],"surcharge":["\u003cboolean\u003e","\u003cboolean\u003e"],"tracked":["\u003cboolean\u003e","\u003cboolean\u003e"],"tyres":["\u003cboolean\u003e","\u003cboolean\u003e"],"weekend_delivery":["weekends","saturday"]}}]