Introducing Enhanced Webhook Features With API updates in Shiprex!

Introducing Enhanced Webhook Features With API updates in Shiprex!

January 14, 2025

🚀 Introducing Enhanced Webhooks and Zones in Shiprex! 🌟

We are thrilled to announce a comprehensive suite of powerful new features added to the Shiprex API! These enhancements are designed to make your experience more seamless, efficient, and enriched, expanding the capabilities of our platform for all users. Check out the latest updates:

1. Enhanced Webhook Management

Webhook Logs Endpoint
Monitor webhook events with detailed logs to track performance and troubleshoot effectively.
Analyze payloads and responses for better visibility.
Add New Webhook Endpoint
Register new webhooks effortlessly with support for event types and validation to ensure reliable integration.
Edit Webhooks
Update existing webhook configurations with ease to adapt to evolving needs.
List My Webhooks
View and manage all your registered webhooks in one place for better control and organization.

2. Advanced Zones Management

List Zones Available
Access detailed information about all available zones within the Shiprex network.
List Zone Areas
Discover specific areas within zones using our efficient, paginated endpoints.
List Zones with Alternative Names
Easily find zones using their alternative names, making it simpler to manage location data.
List Zone Prices for the Seller
Get a complete view of zone-specific pricing tailored for your account.

3. Comprehensive Order Insights

List Order Tags
Retrieve all available order tags to enhance order categorization and tracking.
List Order Statuses
Gain clarity on order progress by accessing a detailed list of statuses.
Get Order Timeline
Track the journey of your orders with precise timeline details.
Get Orders by References
Fetch orders efficiently using reference-based queries.

4. Streamlined Pickup Management

List My Pickups (Locations)
Effortlessly view and manage your pickup locations with newly added endpoints.

💡 Why These Features Matter:

Improved Visibility: Track and analyze webhook events and zone data effortlessly.
Better Organization: Manage your webhooks, zones, and orders in one streamlined interface.
Enhanced Efficiency: Utilize paginated endpoints to handle large datasets with ease.

These updates reflect our ongoing commitment to providing cutting-edge features that address your needs. Whether you’re streamlining your operations or enhancing your integrations, the enriched Shiprex API functionalities are here to help you achieve more!

👉 Explore these new enhancements today and elevate your API experience!

Techyi!!

Enhanced Shiprex API with CURL Examples for Every Endpoint 🚀

We are excited to announce a suite of new features added to the Shiprex API, designed to streamline your workflow and elevate your integration capabilities. Here’s the detailed breakdown with CURL examples for each endpoint.

Webhook Management

List My Webhooks
Retrieve all your registered webhooks.
CURL Example:

curl -X GET 'http://your-domain/api/v1/webhooks/listall' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Get Available Webhook Events
Explore all available webhook events and their payloads.
CURL Example:

curl -X GET 'http://your-domain/api/v1/webhooks/get-available-events' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Add a New Webhook
Register a new webhook with specific events.
CURL Example:

curl -X POST 'http://your-domain/api/v1/webhooks/add' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE' \
-H 'Content-Type: application/json' \
-d '{
    "name": "My Webhook",
    "url": "https://my-site.com/webhook",
    "events": ["order.created", "order.status_changed"],
    "active": true
}'

Edit a Webhook
Modify an existing webhook.
CURL Example:

curl -X PUT 'http://your-domain/api/v1/webhooks/edit/WEBHOOK_ID' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Updated Webhook Name",
    "active": false
}'

Get Webhook Logs
View logs for a specific webhook.
CURL Example:

curl -X GET 'http://your-domain/api/v1/webhooks/get-logs/WEBHOOK_ID' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Order Management

Get Orders by Reference
Fetch orders by their reference codes (comma-separated).
CURL Example:

curl -X GET 'http://your-domain/api/v1/orders/get-orders-by-reference?references=REF001,REF002' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Get Order Timeline
Retrieve actions performed on a specific order.
CURL Example:

curl -X GET 'http://your-domain/api/v1/orders/get-order-timeline/ORDER_ID' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Zones and Locations

List All Zones
Fetch a list of all active zones with default pricing.
CURL Example:

curl -X GET 'http://your-domain/api/v1/zones/listall' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

List User-Specific Zone Prices
Retrieve zones with user-specific pricing.
CURL Example:

curl -X GET 'http://your-domain/api/v1/zones/list-user-zones' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

List Zones with Alternative Names
Access zones with their main and alternative names.
CURL Example:

curl -X GET 'http://your-domain/api/v1/zones/list-alternative-names' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Get Zone Areas
Retrieve areas associated with a specific zone.
CURL Example:

curl -X GET 'http://your-domain/api/v1/zones/get-zone-areas/ZONE_ID' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Pickup Management

List All Pickups
View all pickups for the authenticated user.
CURL Example:

curl -X GET 'http://your-domain/api/v1/pickups/listall' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Get User Locations
Fetch all locations associated with the authenticated user.
CURL Example:

curl -X GET 'http://your-domain/api/v1/pickups/get-user-locations' \
-H 'Authorization: Bearer YOUR_TOKEN_HERE'

Why These Features Matter

Efficiency: Simplified workflows with advanced filtering and management capabilities.
Transparency: Comprehensive logs and timelines for better tracking and accountability.
Customization: User-specific pricing and tailored zones for personalized operations.

Explore these new endpoints today to elevate your Shiprex API integration experience! 🎉

Shiprex