Enabling Carrier and Communication Ratings

Our API enables you to transmit carrier and communication ratings to parcelLab.

Request Definition

These requests allow you to transmit your customer's satisfaction ratings for carriers and communication to the parcelLab system.

This is to support the use of our API to retrieve and display order status updates (for example: in your chatbot or a mobile app). In custom implementations of displaying order status updates, parcels with a Delivered status include a vote-courier type Action Box object in the API response.

Using the following APIs enables you to send carrier and communication ratings from your voting implementation to parcelLab. Sending a new vote will overwrite the previous vote. The collected data is displayed in the parcelLab App within the Communication Insights dashboard.

Vote Courier

Details of how the v2/vote-courier/:vote endpoint can be used to send positive or negative ratings for a carrier are described below.

POST Vote Courier

You can send carrier ratings to parcelLab using the ID of an individual parcel with the vote-courier/:vote endpoint.

Note: The unique ID for a parcel can be found in the response body of calls to the Order API within the parcel object.

The details of the Vote Courier API are described in the following section.

API Details

POST https://api.parcellab.com/v2/vote-courier/:vote

Path Parameters

Name	Type	Description
up	String	Upvote for carrier
down	String	Downvote for carrier

Query Parameters

Name	Type	Description
id*	String	Unique identifier for an individual parcel (format: 24 characters, hexadecimal)

Responses

• 200 - accepted

Vote Communication

Details of how the v2/vote-communication/:vote endpoint can be used to send positive or negative ratings for post-purchase communications are described below.

POST Vote Communication

You can send communication ratings to parcelLab using the ID of an individual parcel with the vote-communication/:vote endpoint.

Note: The unique ID for a parcel can be found in the response body of calls to the Order API within the parcel object.

The details of the Vote Communication API are described in the following section.el can be found in the response body of calls to the Order API within the parcel object.

API Details

POST https://api.parcellab.com/v2/vote-communication/:vote

Path Parameters

Name	Type	Description
up	String	Upvote for communication
down	String	Downvote for communication

Query Parameters

Name	Type	Description
id*	String	Unique identifier for an individual parcel (format: 24 characters, hexadecimal)

Responses

• 200 - accepted

Note: A HTML response is rendered for the case where the URL is embedded in an email. In other cases, you only need to check for status code 200 that indicates a successful request.