Custom shipping provider
With the Custom shipping provider, you connect any carrier that has an API to Picqer yourself. You build a webservice that gets the label from the carrier, or generates it, and returns it to Picqer. This requires programming.
On this page
Before you start
You build a webservice that's reachable over the internet, with:
- a URL where Picqer creates the shipment. Picqer sends the shipment and picklist details as JSON and expects a tracking code and the label in return. The label is always a PDF, optionally with a ZPL version for printers that support ZPL.
- if you want, a URL that returns the options for the shipping profile. See Set up a shipping profile.
The request and response formats are in the Custom shipping method API documentation.
Connect the shipping provider
Give the shipping provider a name.
Enter your webservice details.
- Configuration URL: the URL that returns the options for the shipping profile. Leave it empty if you don't need options per shipping profile.
- Shipment creation URL: the URL where Picqer creates the shipment. This field is required.
- Username (optional) and Password or API key: Picqer sends these as HTTP Basic Authentication. Give each Picqer account its own credentials and one webservice can serve several accounts.
Click 'Save'.
Set up a shipping profile
Your webservice decides what goes on the label. Without a 'Configuration URL', the shipping profile has no options of its own.
If you want to choose something per shipping profile, such as the carrier's product or an extra service, enter a 'Configuration URL'. Picqer fetches the options from there and shows them when you create a shipping profile. With every shipment, Picqer sends the options chosen in the shipping profile to your webservice.
If your webservice also states in its configuration that it supports multiple boxes per shipment, you can send multiple boxes per shipment in Picqer.
Make it available to all Picqer users
A Custom shipping provider works the same way as the shipping providers built into Picqer. If you later want to make your connection available to all Picqer users, your webservice doesn't need to change. Read more about integrating a shipping provider with Picqer.
Existing JSON Push connections
You used to connect your own carrier with the 'JSON Push' shipping provider. 'Custom' has replaced it. If you already have a JSON Push connection, it keeps working. If you need to set it up again, see the article on the JSON Push shipping provider. If you're building a new connection, use 'Custom'.
