About the Generic Carrier interface
The Generic Carrier Interface is an XML over SFTP interface that enables carriers to integrate with Paazl. It provides a two-way service enabling Paazl to communicate orders to carriers and enables carriers to notify Paazl with real-time tracking information. Once you (the carrier) have been integrated with Paazl, your carrier will be accessible to all Paazl customers who have a contract with you.
Paazl's Generic Carrier Interface supports the following functionality:
- Pick-up and delivery shipments
- Same-day, next-day, and nominated (preferred date) delivery
- Cash on Delivery shipment options (COD)
- International shipping (customs clearing)
- Carrier name and logo on the label
- Status updates & email notifications
Below is a schematic representation of the Generic Carrier Interface landscape between our customers, Paazl and the carriers.
Step 1. Registration file
Shops connected to Paazl save shipment information at Paazl. During the fulfillment process the shops will request a label at Paazl via API after which Paazl will create an inhouse label and sends a registration file to the carrier. The registration file is pushed to (S)FTP every 10 minutes and will contain all orders for which the shop has requested a label. On the page About the registration file, you can find a full list of information that the file will contain.
Step 2. Tracking file
The tracking file will be placed in the (S)FTP folder to inform the Paazl platform with real-time tracking information per parcel. Paazl will poll for status changes every 30 minutes and picks up all files that are placed in the folder. In the tracking file, you communicate the Paazl carrier status codes, which will be mapped during the integration. Paazl will store tracking updates on the platform to enable shops to feed tracking updates back to their customers. On the page About the tracking file, you can find a full list of information that the file will contain.
Paazl can enable your logo for Paazl’s Checkout Widget, and on Paazl.com’s carrier page. The following requirements apply to logos:
- The logo must be a vector image (either .SVG or .EPS format)
- The logo must be square, being of equal width and height.
Paazl configures contracts and shipping options for the webshops that you service. Paazl will pre-configure your shipping options to enable webshops to display and/or use your shipping options in their check-out.
The registration file that Paazl sends will contain a ‘serviceCode’ which is the unique identifier for your shipping options. It is up to you to determine and supply Paazl with the shipping options names and IDs that we need to configure. For example: if “SFEB” is the shipping option code, then you need to inform Paazl that its descriptive name is “Super fast E-bike”.
Paazl generates shipping labels that webshops can print and affix to parcels. For Generic Carriers, Paazl prints a standard shipping label that contains the following information:
- Sender information
- Consignee name and address
- (Optional) Additional delivery information
- A Code 128 barcode and an order reference number; the barcode will contain the number of your contract with the shop followed by a six-digit number (from 000000 to 999999).
Integrating the Generic Carrier Interface does not require Paazl development resources. Consequently, all integration questions should be sent to Paazl Customer Support. On rare occasions (e.g. during an escalation or an approved feature request), a Paazl product owner will join the support team.