The article you are trying to view is only accessible if your primary email address has been verified. Click here to verify your email address.

Setting up a Service Point Picker through an API integration

Version History

Version Date URL
1.0.0 2017-01-11 https://embed.sendcloud.sc/spp/1.0.0/api.min.js

Related Links

SendCloud API Documentation https://docs.sendcloud.sc/api/v2/index.html
Service Point Picker integration example https://sendcloud.github.io/spp-integration-example/
Service Point Picker integration example repository https://github.com/SendCloud/spp-integration-example/

What is the Service Point Picker?

Some shipping carriers offer Service Points for your users to send their parcels to so they can pick the parcel up themselves as they wish from a nearby location. SendCloud offers the Service Point Picker which can be easily integrated into any system in order to provide an excellent interface to chose from available service points.

How does this work?

This article focuses on setting up the Service Point Picker in a custom built shop. These shops must be integrated directly to SendCloud's API without a plugin provided by us.

Getting an API key

  1. Once logged in our panel, click on "Integrations" in the left side menu
  2. On the "SendCloud API" row, select "Add". If you don't know how to integrate your system to our API please also check the "Manual" section.
  3. Give your integration a name and hit "Submit"
  4. Check "Service Points"
  5. Enable the carriers you with to activate service points through
  6. Hit "Submit" once again

Setting up a Service Point Picker integration

In order to setup a Service Point Picker integration you need to first have a fully usable custom integration to our API. You can see a guide on how to set it up here.

Once you got your API integration working, please follow up into setting up the Service Point Picker as follows:

  1. Make sure you've enabled Service Points in your Integration settings
  2. Copy the Embed JavaScript code provided in the Integration settings page
  3. Paste the JavaScript code into your checkout page.
  4. At this point, you can check our Service Point Picker example.

A quick step by step guide on how to integrate the JavaScript code to your backend code:

  1. You need to call sendcloud.servicePoints.open and provide with a config object, a success callback and a failure callback (example)
  2. Once a Service Point is picked our library will call your callback function with a Service Point Object. The main pieces of information you're looking for is the Service Point ID and all of the address properties within. You need to keep track of that ID somehow once it'll be used to create a new parcel shipment in our API
  3. When the parcel shipment is being created in our API you need to make sure to pass all of the correct address information in the address fields and mainly fill the to_service_point parameter with the Service Point ID.

Once you've followed all of the above steps your integration should be properly working. Stay frosty!