Purpose: This is a guide on how you can enable Service points for API Integrations. This article focuses on setting up the Service Point picker in a custom-built shop, in which Sendcloud is connected via an API integration and not via a plugin.
Sendcloud APIs provide the necessary features and tools to help you build your shipping automation around the Sendcloud platform, enabling you to streamline your shipping process and automate your logistics flow.
You can integrate key Sendcloud features with your custom-built e-commerce system. We provide extensive documentation on integrating with Sendcloud API's in our Developer's Portal.
Visit the Sendcloud Developer Portal
The Service Point API
The Service Point API provides you with the information you need to drop off or ship parcels to a service point (also known as drop-off locations). The API provides four endpoints which allow you to retrieve service point locations, verify their availability and store them in the Sendcloud platform for use during the checkout process.
Visit our Service Point API Reference
Integrating the service point picker
Sendcloud provides a service point picker which can be easily integrated with your system. This will display a map on your checkout page, from which your customers can choose a convenient service point to have their parcel delivered to. You can find out more about the service point picker here.
Please note that the service point will be displayed in the language that is set in your account, and not by the language of the web browser.
Before you begin, make sure you have:
- Obtained your API keys
- Enabled Service Points for selected carriers in your Integration settings
To integrate the service point picker with your custom-built shop:
- Play around with the live example. When selecting a service point, you’ll receive a service point object and a post number, if entered, as a result. You’ll need that data later when creating a new parcel through our parcels API (see Create a parcel in our shipping API reference).
- Make sure to fill in the
to_post_numberparameters when sending the data over.
- You can copy the code from the bottom of this page, under the Usage section
To integrate with your back-end code:
- You need to call sendcloud.servicePoints.open and provide with a config object, a success callback and a failure callback (example)
- Once a Service Point is selected, our library will call your callback function with a Service Point Object. This contains the service point address properties and the unique
- When you Create a parcel via the API, you will need to structure your request so that it includes the service point address information. In the
to_service_pointparameter, pass the service point ID.
- You can find a guide on creating parcels to ship to service points with the Sendcloud API here.
- Sendcloud API Documentation
- Service Point Picker integration example
- Service Point Picker integration example repository