The Guide
Everything you need to know from Account Creation to Booking End-to-End.
Shiip API Integration Guide
Welcome to the Shiip API Integration Guide. This document will walk you through the process from account creation to booking shipments and configuring webhooks. Follow these steps to get started with our API:
1. Account Creation
Navigate to the Shiip Business Dashboard.
Create an account by providing the necessary information.
To access your dashboard, you need to authenticate your account. This requires completing the registration process.
2. Fund Your Wallet
Before booking a shipment, you must fund your wallet. Ideally, add an amount over 5000.
Enter the desired amount and proceed with payment via the Flutterwave payment screen that appears.
After a successful transaction, your Shiip wallet will be securely credited.
3. Retrieve Available Couriers
Send a request to retrieve a list of available couriers based on your route type (
interstate,intrastate,international,frozen-international,international_us, orall).Example Endpoint:
https://delivery-staging.apiideraos.com/api/v2/token/shipments/courier-partners/?type=allReplace
{type}with the relevant route type.
4. Retrieve Rates
Use the endpoint to query rates for a specific carrier.
Example Endpoint:
https://delivery-staging.apiideraos.com/api/v2/token/tariffs/getpricesingle/{carrier_name}Replace
{carrier_name}with the name of the carrier obtained from the previous step.
Use of Endpoint
This endpoint provides faster queries as rates are retrieved individually for each carrier, improving the user experience compared to the
allpriceendpoint.
If it suits your system architecture, you can use this endpoint to retrieve all available rates in a single request. While it may be slightly slower than the Get Single Carrier Rate endpoint, the choice between the two depends on your functional requirements and design.
5. Book a Shipment
Use the
book shipmentendpoint to submit your shipping details to the Shiip operations team.After booking, your shipment will be attended to within 1-3 hours, depending on daily operational surges.
6. Assign a Shipment
Use the
assign shipmentendpoint to indicate that you are ready for pickup.This triggers a queue on our end, and the operations team will reach out for any further questions.
7. Cancel a Shipment
To cancel a shipment, use the
cancel shipmentendpoint.Include the shipment reference in the request:
Example Endpoint:
https://delivery-staging.apiideraos.com/api/v2/token/shipment/cancel/{reference}
Replace
{reference}with the shipment reference you received upon booking.Note: Canceling a shipment after it has been assigned can be complex and may incur additional fees.
8. Track a Shipment
Use the
track shipmentendpoint to view the status of your shipment and obtain a detailed status breakdown with timestamps.
9. Configure Webhooks
Webhooks enable automated communication between applications.
Configure a webhook URL in your application settings to receive event notifications.
Log in to our business web app.
Navigate to Settings > API Settings and update your webhook URL.
The endpoint should accept POST requests.
The webhook timeout is 30 seconds. For heavy operations, consider handling them asynchronously.
Test your endpoint to ensure it correctly receives payloads.
In production, webhooks are sent every 30 minutes.
In Sandbox/Staging, webhooks are dispatched every 5 minutes.
By following this guide, you will be able to effectively integrate with the Shiip API, manage your shipments, and configure your webhooks. For additional details or assistance, refer to the specific endpoint documentation or contact our support team.
Last updated