Carrybee: connect with API access from Carrybee
Connect Carrybee. Carrybee has no public API documentation, so you must ask Carrybee for API access first. What to ask for, the fields, the webhook and common errors.
Read this first: Carrybee does not publish its API. Jukto's Carrybee connection follows the way third-party plugins use Carrybee, and Carrybee itself has not confirmed it. Use it only after Carrybee confirmed API access for your account.
What it is#
Carrybee is a courier that delivers parcels and collects cash on delivery. With the connection on, you book a parcel from an order by picking the Carrybee city, zone and area, and you follow the status on the order. It suits shops that already work with Carrybee and have API access.
What you need#
- A Carrybee merchant account that has API access. Ask Carrybee before you rely on this connection.
- Fields in Jukto:
| Field in Jukto | What it is |
|---|---|
| Client ID | Given by Carrybee when it enables API access |
| Client secret | Given by Carrybee (a secret) |
| Client context | Optional. A third value Carrybee may give you (a secret) |
| Carrybee store ID | Optional. Only if Carrybee gave you one |
| API address | Optional. Only if Carrybee gave you a different address; empty uses the address of the chosen mode |
| Webhook secret | Optional. The secret you gave Carrybee for the webhook (a secret) |
Where to find your keys#
- 1
Ask Carrybee for API access
Contact Carrybee, through your merchant account or the contact details on carrybee.com, and ask for API access for your account.
- 2
Copy the values Carrybee gives you
Carrybee gives you a Client ID, a Client secret and possibly a Client context. Copy each into the field with the same name.
- 3
Add a store ID or address only if given
If Carrybee gave you a store ID or a different API address, enter them in Carrybee store ID and API address. Otherwise leave these empty.
- 4
Optional: webhook
If you gave Carrybee a webhook secret, enter the same text in Webhook secret and give Carrybee the webhook address shown on the Carrybee provider page.
- 5
Match the mode
Choose Sandbox (testing) or Live as Carrybee told you.
What Jukto does#
- Keys. Saved encrypted for this website only.
- Booking. The Courier card offers the Carrybee City, Zone and Area. Jukto then creates the Carrybee order with the buyer's name, phone, address, weight and the cash to collect (0 for a paid order), and saves the consignment on the order.
- No price. Jukto has no price quote for Carrybee. The charge appears after booking, if Carrybee reports it.
- Status. Jukto reads open parcels every 15 minutes, or at once with Check status now. With the webhook set, Carrybee tells Jukto about changes, and Jukto confirms them with Carrybee first.
- Webhook. Ask Carrybee to set the Webhook address from the provider page as your webhook, and give them the Webhook secret you saved. Make a new address replaces the address and the old one stops working at once.
- Cancel. Cancel booking on the order also cancels the parcel at Carrybee.
Test and turn on#
- 1
Open the provider
Go to Dashboard > Tools > Integrations, open the Couriers group and choose Carrybee.
- 2
Choose the mode and fill the fields
Pick Sandbox (testing) or Live, fill the fields Carrybee gave you and press Save.
- 3
Press Test connection
Jukto asks Carrybee for its list of cities. You see "Carrybee answered" with the number of cities, followed by the reminder to confirm with Carrybee.
- 4
Press Turn on
Book one parcel from an order: pick City, Zone and Area, then Book with this courier.
- 5
Check it with Carrybee
Ask Carrybee, or look in your Carrybee panel, to confirm that the parcel arrived there.
Common errors#
| What you see | What it means | What to do |
|---|---|---|
| Fill in: Client ID, Client secret | A required field is empty | Fill both and save |
| Carrybee: the courier did not accept the saved keys (401) | The values are wrong, or the mode does not match | Re-check the values with Carrybee |
| the courier did not answer in time; try again in a moment | Carrybee was slow | Try again in a minute |
| pick the Carrybee city and zone (and area) before booking | The delivery area is missing | Choose City, Zone and Area |
| Carrybee answered without a consignment id | Carrybee did not create the order | Check the details with Carrybee |
| the buyer phone must be a Bangladesh mobile number (01XXXXXXXXX) for this courier | The order phone has a wrong format | Fix the phone on the order |
Next#
- Couriers overview
- Steadfast or Pathao Courier: couriers with public documentation.
- Book a courier
Comments (0)
Anyone can comment. Please do not post phone numbers, passwords or customer details.