Skip to main content
GET
Retrieve a list of shipping functionalities
API v2 is entering maintenance mode. New users should start with API v3 to access our latest features and improved performance. Already using v2? Don’t worry, your current integration remains fully functional. Read more about maintenance mode, or check out the migration guide for API v3.
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.

Glossary of shipping functionalities

This glossary provides a description of every possible shipping functionality associated with a Sendcloud-supported shipping method.

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Response

200 - application/json

The definitions of available shipping functionalities in the Sendcloud platform.

The shipping functionality definitions as they’re known in the Sendcloud platform.

age_check
Shipping Functionality Definition Object · object
required
Example:
b2b
Shipping Functionality Definition Object · object
required
Example:
b2c
Shipping Functionality Definition Object · object
required
Example:
boxable
Shipping Functionality Definition Object · object
required
Example:
bulky_goods
Shipping Functionality Definition Object · object
required
Example:
carrier_billing_type
Shipping Functionality Definition Object · object
required
Example:
cash_on_delivery
Shipping Functionality Definition Object · object
required
Example:
dangerous_goods
Shipping Functionality Definition Object · object
required
Example:
delivery_attempts
Shipping Functionality Definition Object · object
required
Example:
delivery_before
Shipping Functionality Definition Object · object
required
Example:
delivery_deadline
Shipping Functionality Definition Object · object
required
Example:
direct_contract_only
Shipping Functionality Definition Object · object
required
Example:
eco_delivery
Shipping Functionality Definition Object · object
required
Example:
ers
Shipping Functionality Definition Object · object
required
Example:
first_mile
Shipping Functionality Definition Object · object
required
Example:
flex_delivery
Shipping Functionality Definition Object · object
required
Example:
form_factor
Shipping Functionality Definition Object · object
required
Example:
fragile_goods
Shipping Functionality Definition Object · object
required
Example:
fresh_goods
Shipping Functionality Definition Object · object
required
Example:
harmonized_label
Shipping Functionality Definition Object · object
required
Example:
id_check
Shipping Functionality Definition Object · object
required
Example:
incoterm
Shipping Functionality Definition Object · object
required
Example:
insurance
Shipping Functionality Definition Object · object
required
Example:
labelless
Shipping Functionality Definition Object · object
required
Example:
last_mile
Shipping Functionality Definition Object · object
required
Example:
manually
Shipping Functionality Definition Object · object
required
Example:
multicollo
Shipping Functionality Definition Object · object
required
Example:
neighbor_delivery
Shipping Functionality Definition Object · object
required
Example:
non_conveyable
Shipping Functionality Definition Object · object
required
Example:
personalized_delivery
Shipping Functionality Definition Object · object
required
Example:
premium
Shipping Functionality Definition Object · object
required
Example:
priority
Shipping Functionality Definition Object · object
required
Example:
registered_delivery
Shipping Functionality Definition Object · object
required
Example:
returns
Shipping Functionality Definition Object · object
required
Example:
segment
Shipping Functionality Definition Object · object
required
Example:
service_area
Shipping Functionality Definition Object · object
required
Example:
signature
Shipping Functionality Definition Object · object
required
Example:
size
Shipping Functionality Definition Object · object
required
Example:
sorted
Shipping Functionality Definition Object · object
required
Example:
surcharge
Shipping Functionality Definition Object · object
required
Example:
tracked
Shipping Functionality Definition Object · object
required
Example:
tyres
Shipping Functionality Definition Object · object
required
Example:
weekend_delivery
Shipping Functionality Definition Object · object
required
Example: