API Key*

An API key is always required. You can find yours in your integration settings page. Please paste it below.

Basic Example

These are the only required parameters, passed to country and language parameters respectively when displaying service points.

Available options: de-de, en-gb, en-us, es-es, fr-fr, it-it, nl-nl

Advanced Example

You may pass additional parameters to the Service Point Picker, like the postal code and previously selected service point identifier.

Heads up! If a service point ID is provided, the postal code parameter will be ignored and the service point location displayed instead.
You can open the Service Point Picker with a Service Point ID and its location will be shown immediately to the user.
Open the Service Point Picker with a Post number and its value will be immediately shown to the user.

Limiting carriers available to the user

Heads up! filtering carriers is limited to the carriers selected in your integration settings on the Sendcloud platform

By default, service points from all selected carriers in your integration settings will be available. You can filter the results further by passing a carriers parameter when opening the service point picker.

Example values: bpost, chronopost, colissimo, correos, dhl, mondial_relay, poste_italiane, postnl, ups

For a full list of supported carrier codes, please check the carrier list endpoint documentation of the Service Points API











Quickstart

Begin by adding our script to your HTML page: <script type="text/javascript" src="https://embed.sendcloud.sc/spp/1.0.0/api.min.js"></script>

You need to provide sendcloud.servicePoints.open a config object, a success callback function and an error callback function.

This example works with the following code:

You now need to send the retrieved data to Sendcloud's Parcel API (described in https://docs.sendcloud.sc/api/v2/index.html#parcel). When creating a new Parcel you'll need to forward the delivery address as stated in the result below among with the service point ID in the "to_service_point" field. Be aware that the service point IDs have limited lifetime and change constantly. They weren't designed for persistance.
When creating shipments with service points always send the to_post_number field with the value returned by the service point selection.

Post number:
Service point data: