Retrieve a list of shipping functionalities
GET {{baseUrl}}/shipping-functionalities
This endpoint lists all of the available shipping functionalities across the Sendcloud system. A shipping functionality is an additional characteristic or 'add on' service that defines one shipping method from another. Some functionalities are related to the form of the shipment that's accepted for shipment, such as letterbox, parcel or pallet, while other functionalities specify any additional handling that's required, such as Age check or Signature required. Functionalities can also denote specific delivery deadlines or weekend delivery availability.
The below Glossary of shipping functionalities provides a description of every possible shipping functionality associated with a Sendcloud-supported shipping method.
| Shipping functionality | Description |
|---|---|
age_check | Indicates whether the recipient must be above a certain age (e.g., to accept alcohol products). |
b2b | Indicates whether the shipment is a b2b shipment. |
b2c | Indicates whether the shipment is a b2c shipment. |
boxable | Indicates whether the shipment fits in a box. |
bulky_goods | Indicates whether the shipment is bulky, e.g. it does not fit in a box. |
carrier_billing_type | Indicates whether the shipment is billed on a country to country basis, or based on a shipping zone to shipping zone. Example is shipping from mainland Spain to the Canary Islands (a zone) or Netherlands to the Netherlands (country to country). |
cash_on_delivery | Indicates whether the receiver of the shipment should pay for the shipment when receiving it. |
dangerous_goods | Indicates whether the shipment can contain dangerous goods. |
delivery_attempts | Indicates the number of delivery attempts the carrier should attempt before returning (or discarding) the parcel. |
delivery_before | Indicates whether shipment will be delivered before a certain time of the day (Example: before 12:00). |
delivery_deadline | Indicates the period of time in which the shipment will be delivered (Example: 24 hours, 28 hours). |
direct_contract_only | Indicates whether shipping is only possible using your own carrier contract, or if it is possible using Sendcloud contract rates. |
eco_delivery | Indicates whether the shipping process will be environmently friendly. |
ers | Indicates whether shipment will use the ERS (Easy Return Solution) system. |
first_mile | Indicates how transportation of the first mile of the shipment will take place. Example is that the parcel is dropped of at a service point, or is picked up by the carrier. |
flex_delivery | Indicates whether the receiver of the parcel can, before delivery takes place, choose where and when the shipment should be delivered. |
form_factor | Indicates the form factor of the parcel. Examples are letter, pallet, parcel. |
fragile_goods | Indicates whether shipment can contain fragile goods (glass, electronics, etcetera). |
fresh_goods | Indicates whether shipment can contain fresh goods (e.g. food with an expiration date). |
harmonized_label | Indicates whether shipment label contains the customs information on as well. |
id_check | Indicates whether the receiver should identify him/herself to the carrier driver, conforming the identity of the receiver. |
incoterm | Indicates what incoterm is used for an (international) shipment. Mainly used to determine if the receiver or the sender pays the customs duties. |
insurance | Indicates whether the shipment has carrier insurance or not. |
labelless | Indicates whether a return shipment can be done using only a QR code or numerical number, needed by the end-consumer to return the parcel. In other words, no shipping label is required. |
last_mile | Indicates what the last mile of the shipment looks like. For instance, the shipment can be delivered to a service point or a home address. |
manually | Indicates a subset of Deutsche Post shipping methods where a consumer should manually attach the label to the parcel. |
multicollo | Indicates whether the shipment can be a multi-collo shipment. Note: Not all carriers support multicollo shipment. See the supported carriers and more in our help center |
neighbor_delivery | Indicates whether shipment is allowed to be delivered at the neighbours of the receiver. |
non_conveyable | Indicates whether the shipment fits on a conveyor belt. |
personalized_delivery | Indicates a subset of Deutsche Post shipping methods shipping to a consumer. |
premium | Indicates whether the carrier identifies the shipments shipping process as premium. |
priority | Indicates the priority level of the shipment. Examples are Express or Standard. |
registered_delivery | Indicates whether a Proof of Delivery (POD) is communicated to the sender. |
returns | Indicates whether the shipment should be a return shipment or not. |
segment | Indicates the international pricing zone for PostNL shipments. |
service_area | Indicates the service area of the shipment. Examples are domestic or international. |
signature | Indicates whether the shipment requires a signature upon delivery. |
size | Indicates the allowed size of the shipment. |
sorted | Indicates whether the shipment(s) are handed over the carrier in a sorted fashion, decreasing costs. |
surcharge | Indicates whether the carrier can surcharge the shipment later, based on (volumetric) weight. |
tracked | Indicates whether the shipment can be tracked online. |
tyres | Indicates whether the shipment can be used to ship tyres. |
weekend_delivery | Indicates whether shipment can delivery in the weekend or on a specific weekend-day. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"age_check":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"b2b":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"b2c":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"boxable":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"bulky_goods":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"carrier_billing_type":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"cash_on_delivery":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"dangerous_goods":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"delivery_attempts":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"delivery_before":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"delivery_deadline":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"direct_contract_only":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"eco_delivery":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"ers":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"first_mile":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"flex_delivery":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"form_factor":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"fragile_goods":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"fresh_goods":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"harmonized_label":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"id_check":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"incoterm":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"insurance":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"labelless":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"last_mile":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"manually":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"multicollo":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"neighbor_delivery":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"non_conveyable":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"personalized_delivery":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"premium":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"priority":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"registered_delivery":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"returns":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"segment":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"service_area":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"signature":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"size":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"sorted":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"surcharge":{"name":"\u003cstring\u003e","type":"boolean","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"tracked":{"name":"\u003cstring\u003e","type":"string","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"tyres":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"},"weekend_delivery":{"name":"\u003cstring\u003e","type":"integer","default_value":"\u003cstring\u003e","enum":{},"pattern":"\u003cstring\u003e"}}