Skip to main content
GET
/
shipping-functionalities
Retrieve a list of shipping functionalities
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/shipping-functionalities \
  --header 'Authorization: Basic <encoded-value>'
{
  "age_check": {
    "name": "Age check",
    "default_value": null,
    "type": "integer"
  },
  "b2b": {
    "name": "B2B",
    "default_value": false,
    "type": "boolean"
  },
  "b2c": {
    "name": "B2C",
    "default_value": false,
    "type": "boolean"
  },
  "boxable": {
    "name": "Boxable",
    "default_value": false,
    "type": "boolean"
  },
  "bulky_goods": {
    "name": "Bulky goods",
    "default_value": false,
    "type": "boolean"
  },
  "carrier_billing_type": {
    "name": "Carrier billing type",
    "default_value": null,
    "type": "string",
    "values": {
      "country": {
        "name": "Country"
      },
      "zonal": {
        "name": "Zonal"
      }
    }
  },
  "cash_on_delivery": {
    "name": "Cash on delivery",
    "default_value": null,
    "type": "integer"
  },
  "dangerous_goods": {
    "name": "Dangerous goods",
    "default_value": false,
    "type": "boolean"
  },
  "delivery_attempts": {
    "name": "Delivery attempts",
    "default_value": null,
    "type": "integer"
  },
  "delivery_before": {
    "name": "Delivery before",
    "default_value": null,
    "type": "string",
    "pattern": "^(0[0-9]|1[0-9]|2[0-3])[0-5][0-9]$"
  },
  "delivery_deadline": {
    "name": "Delivery deadline",
    "default_value": null,
    "type": "string",
    "values": {
      "best_effort": {
        "name": "Best effort"
      },
      "sameday": {
        "name": "Same day"
      },
      "nextday": {
        "name": "Next day"
      },
      "within_24h": {
        "name": "Within 24 hours"
      },
      "within_48h": {
        "name": "Within 48 hours"
      },
      "within_72h": {
        "name": "Within 72 hours"
      }
    }
  },
  "direct_contract_only": {
    "name": "On direct contract only",
    "default_value": false,
    "type": "boolean"
  },
  "eco_delivery": {
    "name": "Eco delivery",
    "default_value": false,
    "type": "boolean"
  },
  "first_mile": {
    "name": "First mile",
    "default_value": null,
    "type": "string",
    "values": {
      "pickup": {
        "name": "Pickup"
      },
      "dropoff": {
        "name": "Drop-off"
      },
      "pickup_dropoff": {
        "name": "Pickup / Drop-off"
      },
      "fulfilment": {
        "name": "Fulfilment"
      }
    }
  },
  "flex_delivery": {
    "name": "Flex delivery",
    "default_value": false,
    "type": "boolean"
  },
  "form_factor": {
    "name": "Form factor",
    "default_value": null,
    "type": "string",
    "values": {
      "letter": {
        "name": "Letter"
      },
      "parcel": {
        "name": "Parcel"
      },
      "mailbox": {
        "name": "Mailbox"
      },
      "pallet": {
        "name": "Pallet"
      },
      "long": {
        "name": "Long"
      }
    }
  },
  "fragile_goods": {
    "name": "Fragile goods",
    "default_value": false,
    "type": "boolean"
  },
  "fresh_goods": {
    "name": "Fresh goods",
    "default_value": false,
    "type": "boolean"
  },
  "harmonized_label": {
    "name": "Harmonized label",
    "default_value": false,
    "type": "boolean"
  },
  "id_check": {
    "name": "ID check",
    "default_value": false,
    "type": "boolean"
  },
  "incoterm": {
    "name": "Incoterm",
    "default_value": null,
    "type": "string",
    "values": {
      "dap": {
        "name": "Delivery at place"
      },
      "ddp": {
        "name": "Delivery duty paid"
      },
      "ddu": {
        "name": "Delivery duty unpaid"
      },
      "dap_np": {
        "name": "Seller bears costs of shipping incl. clearance. Receiver bears the costs and risks of duties and VAT."
      },
      "dap_dp": {
        "name": "Seller bears the costs and risks of transport, clearance, duties and VAT."
      }
    }
  },
  "insurance": {
    "name": "Insurance",
    "default_value": null,
    "type": "integer"
  },
  "last_mile": {
    "name": "Last mile",
    "default_value": null,
    "type": "string",
    "values": {
      "home_delivery": {
        "name": "Home delivery"
      },
      "service_point": {
        "name": "Service point"
      },
      "mailbox": {
        "name": "Mailbox"
      },
      "pobox": {
        "name": "PO Box"
      }
    }
  },
  "manually": {
    "name": "Manually",
    "default_value": false,
    "type": "boolean"
  },
  "multicollo": {
    "name": "Multicollo",
    "default_value": false,
    "type": "boolean"
  },
  "neighbor_delivery": {
    "name": "Neighbor delivery",
    "default_value": false,
    "type": "boolean"
  },
  "non_conveyable": {
    "name": "Non conveyable",
    "default_value": false,
    "type": "boolean"
  },
  "personalized_delivery": {
    "name": "Personalized delivery",
    "default_value": false,
    "type": "boolean"
  },
  "premium": {
    "name": "Premium",
    "default_value": false,
    "type": "boolean"
  },
  "priority": {
    "name": "Priority",
    "default_value": null,
    "type": "string",
    "values": {
      "economical": {
        "name": "Economical"
      },
      "standard": {
        "name": "Standard"
      },
      "priority": {
        "name": "Priority"
      },
      "express": {
        "name": "Express"
      }
    }
  },
  "registered_delivery": {
    "name": "Registered delivery",
    "default_value": false,
    "type": "boolean"
  },
  "returns": {
    "name": "Returns",
    "default_value": false,
    "type": "boolean"
  },
  "segment": {
    "name": "Segment",
    "default_value": null,
    "type": "string",
    "values": {
      "a+": {
        "name": "A+"
      },
      "a": {
        "name": "A"
      },
      "b": {
        "name": "B"
      },
      "c": {
        "name": "C"
      },
      "d": {
        "name": "D"
      }
    }
  },
  "service_area": {
    "name": "Service area",
    "default_value": null,
    "type": "string",
    "values": {
      "domestic": {
        "name": "Domestic"
      },
      "domestic_remote": {
        "name": "Domestic & remote"
      },
      "international": {
        "name": "International"
      }
    }
  },
  "signature": {
    "name": "Signature",
    "default_value": false,
    "type": "boolean"
  },
  "size": {
    "name": "Size",
    "default_value": null,
    "type": "string",
    "values": {
      "xs": {
        "name": "Extra-small"
      },
      "s": {
        "name": "Small"
      },
      "m": {
        "name": "Medium"
      },
      "l": {
        "name": "Large"
      },
      "xl": {
        "name": "Extra-large"
      },
      "xxl": {
        "name": "Extra-extra-large"
      }
    }
  },
  "sorted": {
    "name": "Sorted",
    "default_value": false,
    "type": "boolean"
  },
  "surcharge": {
    "name": "Surcharge",
    "default_value": false,
    "type": "boolean"
  },
  "tracked": {
    "name": "Tracked",
    "default_value": false,
    "type": "boolean"
  },
  "tyres": {
    "name": "Tyres",
    "default_value": false,
    "type": "boolean"
  },
  "weekend_delivery": {
    "name": "Weekend delivery",
    "default_value": null,
    "type": "string",
    "values": {
      "saturday": {
        "name": "Saturday"
      },
      "sunday": {
        "name": "Sunday"
      },
      "weekends": {
        "name": "Weekends"
      }
    }
  },
  "labelless": {
    "name": "Labelless shipping",
    "default_value": false,
    "type": "boolean"
  },
  "ers": {
    "name": "Easy Return Solution",
    "default_value": false,
    "type": "boolean"
  }
}
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.
Shipping functionalityDescription
age_checkIndicates whether the recipient must be above a certain age (e.g., to accept alcohol products).
b2bIndicates whether the shipment is a b2b shipment.
b2cIndicates whether the shipment is a b2c shipment.
boxableIndicates whether the shipment fits in a box.
bulky_goodsIndicates whether the shipment is bulky, e.g. it does not fit in a box.
carrier_billing_typeIndicates 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_deliveryIndicates whether the receiver of the shipment should pay for the shipment when receiving it.
dangerous_goodsIndicates whether the shipment can contain dangerous goods.
delivery_attemptsIndicates the number of delivery attempts the carrier should attempt before returning (or discarding) the parcel.
delivery_beforeIndicates whether the shipment will be delivered before a certain time of the day (Example: before 12:00).
delivery_deadlineIndicates the period of time in which the shipment will be delivered (Example: 24 hours, 28 hours).
direct_contract_onlyIndicates whether shipping is only possible using your own carrier contract, or if it is possible using Sendcloud contract rates.
eco_deliveryIndicates whether the shipping process will be environmentally friendly.
ersIndicates whether the shipment will use the ERS (Easy Return Solution) system.
first_mileIndicates 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_deliveryIndicates whether the receiver of the parcel can, before delivery takes place, choose where and when the shipment should be delivered.
form_factorIndicates the form factor of the parcel. Examples are letter, pallet, parcel.
fragile_goodsIndicates whether the shipment can contain fragile goods (glass, electronics, etcetera).
fresh_goodsIndicates whether the shipment can contain fresh goods (e.g. food with an expiration date).
harmonized_labelIndicates whether the shipment label contains the customs information on it as well.
id_checkIndicates whether the receiver should identify him/herself to the carrier driver, conforming the identity of the receiver.
incotermIndicates what incoterm is used for an (international) shipment. Mainly used to determine if the receiver or the sender pays the customs duties.
insuranceIndicates whether the shipment has carrier insurance or not.
labellessIndicates 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_mileIndicates what the last mile of the shipment looks like. For instance, the shipment can be delivered to a service point or a home address.
manuallyIndicates a subset of Deutsche Post shipping methods where a consumer should manually attach the label to the parcel.
multicolloIndicates 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_deliveryIndicates whether the shipment is allowed to be delivered at the neighbours of the receiver.
non_conveyableIndicates whether the shipment fits on a conveyor belt.
personalized_deliveryIndicates a subset of Deutsche Post shipping methods shipping to a consumer.
premiumIndicates whether the carrier identifies the shipment’s shipping process as premium.
priorityIndicates the priority level of the shipment. Examples are Express or Standard.
registered_deliveryIndicates whether a Proof of Delivery (POD) is communicated to the sender.
returnsIndicates whether the shipment should be a return shipment or not.
segmentIndicates the international pricing zone for PostNL shipments.
service_areaIndicates the service area of the shipment. Examples are domestic or international.
signatureIndicates whether the shipment requires a signature upon delivery.
sizeIndicates the allowed size of the shipment.
sortedIndicates whether the shipment(s) are handed over the carrier in a sorted fashion, decreasing costs.
surchargeIndicates whether the carrier can surcharge the shipment later, based on (volumetric) weight.
trackedIndicates whether the shipment can be tracked online.
tyresIndicates whether the shipment can be used to ship tyres.
weekend_deliveryIndicates whether the shipment can be delivered in the weekend or on a specific weekend-day.

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:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
b2b
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
b2c
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
boxable
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
bulky_goods
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
carrier_billing_type
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
cash_on_delivery
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
dangerous_goods
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
delivery_attempts
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
delivery_before
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
delivery_deadline
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
direct_contract_only
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
eco_delivery
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
ers
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
first_mile
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
flex_delivery
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
form_factor
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
fragile_goods
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
fresh_goods
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
harmonized_label
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
id_check
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
incoterm
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
insurance
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
labelless
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
last_mile
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
manually
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
multicollo
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
neighbor_delivery
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
non_conveyable
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
personalized_delivery
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
premium
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
priority
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
registered_delivery
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
returns
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
segment
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
service_area
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
signature
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
size
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
sorted
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
surcharge
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
tracked
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
tyres
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}
​
weekend_delivery
Shipping Functionality Definition Object · object
required
Example:
{
  "name": "age_check",
  "type": "boolean",
  "default_value": false
}