Sendcloud service point picker: API integration demo

Options

apiKey
You can find your API key on the integration settings page. It is needed to test the examples below.
country
Examples: de, es, fr, gb, it, nl
language
Available options: de-de, en-gb, en-us, es-es, fr-fr, it-it, nl-nl
postalCode
Note: if a service point ID is provided, the postal code parameter will be ignored and the service point location will be displayed instead.
city
Note: if a service point ID is provided, the city parameter will be ignored and the service point location will be displayed instead.
servicePointId
You can open the service point picker with a service point ID and its location will be shown instead of the country’s default location.
postNumber
Pre-fill the service point picker’s post number field.
shopType
You can use any value for the shopType option, not just the ones listed here. Available options: packStation, parcelShop, postOffice, punto_poste, service_point, SHOP (yes, our shop types are wildly inconsistent)
Carriers carriers
Heads up: filtering carriers is limited to the carriers selected in your integration settings in 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.

Usage

Begin by adding our script to your HTML page: 

<script 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.

The example on this page uses the following code:

Selected service point

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: