> ## Documentation Index > Fetch the complete documentation index at: https://sendcloud.dev/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a list of shipping functionalities > Lists all available shipping functionalities across the Sendcloud system. **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](/docs/getting-started/api-version-guide), or check out the [migration guide for API v3](/docs/getting-started/migration-guidelines-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. | 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 the 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 environmentally friendly. | | `ers` | Indicates whether the 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 the shipment can contain fragile goods (glass, electronics, etcetera). | | `fresh_goods` | Indicates whether the shipment can contain fresh goods (e.g. food with an expiration date). | | `harmonized_label` | Indicates whether the shipment label contains the customs information on it 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 the 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 shipment's 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 the shipment can be delivered in the weekend or on a specific weekend-day. | ## OpenAPI ````yaml /.openapi/v2/shipping-products/openapi.yaml get /shipping-functionalities openapi: 3.1.0 info: title: Shipping products version: 2.0.0 description: >- The **Shipping products API** allows you to retrieve shipping products and their associated shipping methods, filtered by specific criteria and shipping functionalities. contact: name: Sendcloud API Support url: https://www.sendcloud.dev email: contact@sendcloud.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://panel.sendcloud.sc/api/v2 description: Sendcloud Production security: [] tags: - name: Shipping products paths: /shipping-functionalities: parameters: [] get: tags: - Shipping products summary: Retrieve a list of shipping functionalities description: >- Lists all available shipping functionalities across the Sendcloud system. operationId: sc-public-v2-scp-get-retrieve_all_shipping_functionalities parameters: [] responses: '200': description: >- The definitions of available shipping functionalities in the Sendcloud platform. content: application/json: schema: $ref: '#/components/schemas/shipping-functionality-definitions' examples: shipping_functionality_definitions: summary: Shipping functionalities 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 security: - HTTPBasicAuth: [] - OAuth2ClientCreds: [] components: schemas: shipping-functionality-definitions: title: Shipping Functionality Definitions Object type: object description: >- The shipping functionality definitions as they’re known in the Sendcloud platform. properties: age_check: $ref: '#/components/schemas/shipping-functionality-definition' b2b: $ref: '#/components/schemas/shipping-functionality-definition' b2c: $ref: '#/components/schemas/shipping-functionality-definition' boxable: $ref: '#/components/schemas/shipping-functionality-definition' bulky_goods: $ref: '#/components/schemas/shipping-functionality-definition' carrier_billing_type: $ref: '#/components/schemas/shipping-functionality-definition' cash_on_delivery: $ref: '#/components/schemas/shipping-functionality-definition' dangerous_goods: $ref: '#/components/schemas/shipping-functionality-definition' delivery_attempts: $ref: '#/components/schemas/shipping-functionality-definition' delivery_before: $ref: '#/components/schemas/shipping-functionality-definition' delivery_deadline: $ref: '#/components/schemas/shipping-functionality-definition' direct_contract_only: $ref: '#/components/schemas/shipping-functionality-definition' eco_delivery: $ref: '#/components/schemas/shipping-functionality-definition' ers: $ref: '#/components/schemas/shipping-functionality-definition' first_mile: $ref: '#/components/schemas/shipping-functionality-definition' flex_delivery: $ref: '#/components/schemas/shipping-functionality-definition' form_factor: $ref: '#/components/schemas/shipping-functionality-definition' fragile_goods: $ref: '#/components/schemas/shipping-functionality-definition' fresh_goods: $ref: '#/components/schemas/shipping-functionality-definition' harmonized_label: $ref: '#/components/schemas/shipping-functionality-definition' id_check: $ref: '#/components/schemas/shipping-functionality-definition' incoterm: $ref: '#/components/schemas/shipping-functionality-definition' insurance: $ref: '#/components/schemas/shipping-functionality-definition' labelless: $ref: '#/components/schemas/shipping-functionality-definition' last_mile: $ref: '#/components/schemas/shipping-functionality-definition' manually: $ref: '#/components/schemas/shipping-functionality-definition' multicollo: $ref: '#/components/schemas/shipping-functionality-definition' neighbor_delivery: $ref: '#/components/schemas/shipping-functionality-definition' non_conveyable: $ref: '#/components/schemas/shipping-functionality-definition' personalized_delivery: $ref: '#/components/schemas/shipping-functionality-definition' premium: $ref: '#/components/schemas/shipping-functionality-definition' priority: $ref: '#/components/schemas/shipping-functionality-definition' registered_delivery: $ref: '#/components/schemas/shipping-functionality-definition' returns: $ref: '#/components/schemas/shipping-functionality-definition' segment: $ref: '#/components/schemas/shipping-functionality-definition' service_area: $ref: '#/components/schemas/shipping-functionality-definition' signature: $ref: '#/components/schemas/shipping-functionality-definition' size: $ref: '#/components/schemas/shipping-functionality-definition' sorted: $ref: '#/components/schemas/shipping-functionality-definition' surcharge: $ref: '#/components/schemas/shipping-functionality-definition' tracked: $ref: '#/components/schemas/shipping-functionality-definition' tyres: $ref: '#/components/schemas/shipping-functionality-definition' weekend_delivery: $ref: '#/components/schemas/shipping-functionality-definition' required: - age_check - b2b - b2c - boxable - bulky_goods - carrier_billing_type - cash_on_delivery - dangerous_goods - delivery_attempts - delivery_before - delivery_deadline - direct_contract_only - eco_delivery - ers - first_mile - flex_delivery - form_factor - fragile_goods - fresh_goods - harmonized_label - id_check - incoterm - insurance - labelless - last_mile - manually - multicollo - neighbor_delivery - non_conveyable - personalized_delivery - premium - priority - registered_delivery - returns - segment - service_area - signature - size - sorted - surcharge - tracked - tyres - weekend_delivery example: 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 shipping-functionality-definition: title: Shipping Functionality Definition Object type: object example: name: age_check type: boolean default_value: false properties: name: type: string example: age_check type: type: string nullable: true enum: - boolean - integer - string example: boolean default_value: description: The default value of each functionality. anyOf: - type: string nullable: true - type: integer nullable: true - type: boolean nullable: true values: type: object description: >- An object whose properties are the only possible values of a functionality. additionalProperties: type: object properties: name: type: string required: - name pattern: type: string description: >- A regular expression restricting the allowed values of a string type functionality. example: ^(0[0-9]|1[0-9]|2[0-3])[0-5][0-9]$ required: - name - type securitySchemes: HTTPBasicAuth: type: http description: >- Basic Authentication using API key and secrets is currently the main authentication mechanism. scheme: basic OAuth2ClientCreds: type: oauth2 description: >- OAuth2 is a standardized protocol for authorization that allows users to share their private resources stored on one site with another site without having to provide their credentials. OAuth2 Client Credentials Grant workflow. This workflow is typically used for server-to-server interactions that require authorization to access specific resources. flows: clientCredentials: tokenUrl: https://account.sendcloud.com/oauth2/token/ scopes: api: Default OAuth scope required to access Sendcloud API. ````