API Documentation

Developer documentation for ParcelFlow API integration.

API Documentation

Integrate ParcelFlow's delivery services into your application with our RESTful API.

Getting Started

To use the ParcelFlow API, you'll need:

  • A ParcelFlow account
  • API credentials (available in your account settings)
  • Basic knowledge of REST APIs and HTTP requests

Authentication

All API requests require authentication using JWT tokens:

Authorization: Bearer YOUR_ACCESS_TOKEN

Base URL

https://api.parcelflow.com/v1

Key Endpoints

Create Delivery Item

POST /api/shop/item
{
  "name": "Package Title",
  "destinationAddress": "Delivery Address",
  "buyerName": "Recipient Name",
  "buyerPhone": "Phone Number",
  "codAmount": 1000,
  "deliveryCharge": 100,
  "priority": "NORMAL",
  "deliveryType": "DIRECT",
  "areaTag": "Kathmandu"
}

Track Delivery

GET /api/track/{trackingId}

List Deliveries

GET /api/shop/item/list?status=PENDING&search=keyword

Webhooks

Configure webhooks to receive real-time updates about delivery status changes:

  • Item Created
  • Status Updated
  • Delivered
  • Failed

Rate Limits

API requests are limited to 1000 requests per hour per account.

Support

For API support, contact developers@parcelflow.com

Full API documentation coming soon with detailed endpoint specifications and code examples.