وثائق نبوكس ناو API

API تسجيل الدخول

سجل الدخول إلى النظام عن طريق استدعاء نقطة نهاية المصادقة:

يتم إرجاع رمز مميز عند نجاح المصادقة ويجب استخدامه في طلبات API الأخرى.

الطريقة: POST

نقطة النهاية: POST https://{base_url}/login

الطلب

يجب تضمين المعاملات التالية في نص الطلب:

الاستجابة

API المواقع

لإدارة المواقع في نظام انبوكس ناو، يمكنك استخدام نقاط النهاية التالية. كلاهما يقبل نفس نص الطلب الذي يحتوي على مصفوفة من معلومات الموقع.

تأكد من تضمين الرمز المميز ونطاق المتجر في رؤوس الطلب. سيقوم API بالتحقق من صحة هذه لضمان أن الطلب قادم من متجر مخول. يمكن توفير المواقع في معلومة واحدة أو مصفوفة من معلومات الموقع، اعتماداً على المنصة. lat و lng الحقول اختيارية ولكن يمكن تضمينها إذا كانت الإحداثيات الجغرافية للموقع معروفة.

الطريقة: POST

الرؤوس

الطلب

الاستجابة

API التفعيل

الطريقة: POST

نقطة النهاية: POST https://{base_url}/activation

الرؤوس

الطلب

الاستجابة

أسعار API

الطريقة: POST

نقطة النهاية: POST https://{base_url}/rates

الرؤوس

الوصف

يحسب هذا API أسعار الشحن بناءً على تفاصيل المنتج والمنشأ والوجهة. يحسب النظام بذكاء الأبعاد والوزن من المنتجات الفردية لحساب دقيق للأسعار. معاملات الوزن/الحجم القديمة مدعومة للتوافق مع الإصدارات السابقة.

الطلب

موصى به: استخدم المنتجات مصفوفة لحسابات الوزن الأبعاد الدقيقة. سيحسب النظام الوزن والحجم الإجمالي من مواصفات المنتجات الفردية.

هيكل الطلب الرئيسي

Product Object (Recommended)

معلومات المنشأ والوجهة

الاستجابة

نص الاستجابة

سيحتوي نص الاستجابة على مصفوفة من معلومات الأسعار، بالهيكل التالي:

طلب API

الطريقة: POST

نقطة النهاية: POST https://{base_url}/order

الوصف

يتم استدعاء هذا API أثناء عملية الدفع في موقع التجارة الإلكترونية. يدفع تفاصيل الطلب من متجر التجارة الإلكترونية إلى نظام انبوكس ناو للمعالجة. سيتعامل النظام مع مهام مثل حساب تكلفة الشحن وتحديث حالة الطلب وإنشاء إشعارات البريد الإلكتروني لفريق العمليات والمستخدم.

الرؤوس

الطلب

يجب أن يحتوي نص الطلب على تفاصيل الطلب، بما في ذلك الناقل وتفاصيل العميل والوجهة ومعلومات المنتج. فيما يلي هيكل بيانات الطلب:

هيكل المعلومات الرئيسي

معلومات الطلب

subTotal     = Sum of product prices (e.g., 200 QAR)
+ tax        = Tax amount (e.g., 20 QAR)
- discount   = Discount applied (e.g., 10 QAR)
─────────────────────────────────────────────
= orderValue = Product value for customer (210 QAR)

+ shippingFee (from your platform, for reference)
─────────────────────────────────────────────
= total      = Final order total (e.g., 230 QAR)

If collectionAmount is PROVIDED:
  → Uses your specified value (e.g., 150 QAR if partial prepayment)

If collectionAmount is NOT provided:
  → Calculated as: orderValue + customerShippingFee
  → Where customerShippingFee priority:
    1. Your shippingFee (if provided)
    2. NBox displayRate (if markup rule exists)
    3. NBox actualRate (fallback)

معلومات العميل

معلومات المنشأ والوجهة

Product Object

الاستجابة

نص الاستجابة

سيحتوي نص الاستجابة على الحقول التالية:

Example Success Response

{
  "status": "success",
  "message": "order processed",
  "orderId": 11132,
  "orderReference": "NB-11132",
  "shipment_id": "ORD-NB-11132",
  "awb": "ORD-NB-11132",
  "tracking_url": "https://nbox.now/track/ORD-NB-11132",
  "nbox": {
    "shipment_detail_id": "af825ce0-6fd0-4777-8d28-0dfbccc20771",
    "shop_id": "f79e11b7-a9df-4023-8609-ce55a4c64a7c"
  },
  "carrier": "NBOX",
  "carrierName": "NBOX Express Local Delivery",
  "carrierWasAutoSelected": false,
  "actualRate": 16,
  "displayRate": 16,
  "hasDisplayRule": false
}

Important Notes

• 🔑 shipment_id Field: This is the most important identifier returned in the response. Store this value to:
  • Download AWB labels via GET /api/awb/:shipment_id
  • Correlate webhook events with your orders (included in all webhook payloads)
  • Track shipments and reference them in support queries
• awb & tracking_url: Initially set to shipment_id value, but becomenull until the shipment is picked up by the carrier. You'll receive updated values via the shipment.pickup webhook event. See Webhooks and Customer Tracking sections.
• COD Service Fee: For orders with paymentStatus: "postpaid", a COD service fee is calculated as: collectionAmount × 2%
  If collectionAmount is not provided, fee is based on: (subTotal + tax - discount + customerShippingFee) × 2%
• Carrier Auto-selection: If no carrier is specified, NBox automatically selects the cheapest available carrier for the route
• Shipping Fee Recalculation: NBox always recalculates shipping costs server-side, regardless of the shippingFee parameter
• Backward Compatibility: All new fields are optional. Existing integrations continue to work without modifications

API الإنجاز

الطريقة: POST

نقطة النهاية: POST https://{base_url}/fulfilled

الوصف

يتم استدعاء هذا API عندما يتم إنجاز الطلب (شحنه). يدفع حالة إنجاز الطلب من متجر التجارة الإلكترونية إلى نظام انبوكس ناو لمزيد من المعالجة، مثل تحديث حالة الطلب أو إخطار العميل.

الرؤوس

الطلب

يجب تضمين المعاملات التالية في نص الطلب:

الاستجابة

نص الاستجابة

إلغاء API

الطريقة: POST

نقطة النهاية: POST https://{base_url}/order/cancelled

الوصف

يتم استدعاء هذا API عندما يتم إلغاء الطلب. يرسل حالة الإلغاء من متجر التجارة الإلكترونية إلى نظام نبوكس ناو لمزيد من المعالجة، مثل تحديث حالة الطلب وإخطار العميل بالإلغاء.

الرؤوس

الطلب

الاستجابة

Return Shipment

Method: POST

Endpoint: POST https://{base_url}/return-shipment

Description

Creates a return shipment from an existing delivered order or shipment. This API reverses the origin and destination addresses, allowing the package to be returned to the original sender.

The return shipment uses the actual delivery coordinates from the completed delivery task for accurate pickup location.

الرؤوس

Request Body

Example Request (Basic)

POST /api/return-shipment
Content-Type: application/json
x-nbox-api-token: your_api_token
x-nbox-shop-domain: your-shop.myshopify.com

{
  "shipment_id": "ORD-NB-11132",
  "returnReason": "Customer requested return",
  "notes": "Handle with care - fragile items"
}

Example Request (With Contact Overrides)

POST /api/return-shipment
Content-Type: application/json
x-nbox-api-token: your_api_token
x-nbox-shop-domain: your-shop.myshopify.com

{
  "shipment_id": "ORD-NB-11132",
  "returnReason": "Customer requested return",
  "carrier": "nbox_local",
  "pickupContactInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "phone": "55512345",
    "email": "john@example.com"
  },
  "returnContactInfo": {
    "firstName": "Warehouse",
    "lastName": "Manager",
    "phone": "55567890",
    "email": "warehouse@shop.com"
  }
}

Response

The response structure matches the Create Order API for consistency:

Return Shipment Object

Example Success Response

{
  "status": "success",
  "message": "Return shipment created successfully",

  "shipment_id": "RTN-ORD-NB-11132",
  "original_shipment_id": "ORD-NB-11132",
  "awb": "RTN-ORD-NB-11132",
  "tracking_url": "https://nbox.now/track/RTN-ORD-NB-11132",

  "carrier": "nbox_local",
  "carrierName": "NBOX Express Local Delivery",
  "carrierWasAutoSelected": true,

  "actualRate": 16,
  "displayRate": 16,
  "hasDisplayRule": false,

  "nbox": {
    "shipment_detail_id": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
    "return_shipment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },

  "paymentStatus": "unpaid",

  "returnShipment": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "shipmentDetailId": "f9e8d7c6-b5a4-3210-fedc-ba0987654321",
    "unifiedRefId": "RTN-ORD-NB-11132",
    "original_shipment_id": "ORD-NB-11132",
    "status": "new",
    "paymentStatus": "unpaid",
    "rate": {
      "actualRate": 16,
      "displayRate": 16,
      "currency": "QAR"
    },
    "origin": {
      "firstName": "John",
      "lastName": "Customer",
      "phone": "55512345",
      "email": "john@example.com",
      "address": {
        "address": "123 Customer Street, West Bay",
        "city": "Doha",
        "country": "Qatar",
        "countryCode": "QA",
        "lat": 25.3284,
        "lng": 51.5310
      }
    },
    "destination": {
      "firstName": "Shop",
      "lastName": "Owner",
      "phone": "55567890",
      "email": "shop@example.com",
      "address": {
        "address": "456 Warehouse Road, Industrial Area",
        "city": "Doha",
        "country": "Qatar",
        "countryCode": "QA",
        "lat": 25.2654,
        "lng": 51.4875
      }
    },
    "dimensions": {
      "weight": 2.5,
      "length": 30,
      "width": 20,
      "height": 15,
      "volumeWeight": 1.8
    },
    "returnReason": "Customer requested return",
    "createdAt": "2025-11-29T10:30:00.000Z"
  }
}

Error Responses

Example Error Response

{
  "status": "error",
  "code": "NOT_DELIVERED",
  "message": "Shipment must be delivered before creating return. Current status: in_transit"
}

Check Return Eligibility

Before creating a return, you can check if a shipment is eligible for return:

Method: GET

Endpoint: GET https://{base_url}/return-shipment?shipment_id={refId}

Example Request

GET /api/return-shipment?shipment_id=ORD-NB-11132
x-nbox-api-token: your_api_token
x-nbox-shop-domain: your-shop.myshopify.com

Example Response (Eligible)

{
  "status": "success",
  "eligible": true,
  "reason": null,
  "code": null
}

Example Response (Not Eligible)

{
  "status": "success",
  "eligible": false,
  "reason": "Shipment must be delivered before creating return. Current status: in_transit",
  "code": "NOT_DELIVERED"
}

Important Notes

• Eligibility Requirements: Only shipments with status "delivered" can have returns created
• One Return Per Original: Each original shipment can only have one return shipment. Attempting to create a second return will result in a RETURN_EXISTS error
• Rate Calculation: Shipping rates are calculated dynamically using the rate engine based on the original package dimensions and reversed route. No display rules/markup are applied to returns
• Auto Carrier Selection: If no carrier is specified, the cheapest available carrier for the route is automatically selected. The response includes carrierWasAutoSelected: true in this case
• Billing: Return shipments are marked as "unpaid" for prepaid accounts (payment processed later) or "postpaid" for contract accounts (billed monthly)
• GPS Accuracy: The return pickup location uses the actual GPS coordinates captured when the delivery driver completed the original delivery, ensuring accurate pickup
• Reference ID Format: Return shipment reference IDs are prefixed with "RTN-" followed by the original reference (e.g., "RTN-ORD-NB-11132")
• Contact Overrides: Use pickupContactInfo to override the pickup contact (customer) and returnContactInfo to override the delivery contact (warehouse). Both support partial overrides (only specify fields to change)
• After Creation: The return shipment follows the same workflow as regular shipments - payment processing, pickup scheduling, and delivery tracking

Webhooks

Overview

Configure webhook endpoints to receive real-time updates about your shipments. Webhooks are automatically triggered when shipment status changes occur.

Available Events

Webhook Payload Structure

All webhook requests include these headers:

Sample Payloads by Event Type

1. shipment.pickup

Triggered when carrier picks up the shipment:

{
  "event": "shipment.pickup",
  "timestamp": "2025-11-26T08:15:00.000Z",
  "data": {
    "shipment_id": "SHP-2025-001234",
    "shipment_detail_id": "abc123-def456",
    "shop_id": "shop_xyz",
    "order_reference": "ORD-1234",
    "awb": "NB-1234567890",
    "tracking_url": "https://nbox.now/track/NB-1234567890",
    "carrier": "aramex",
    "status": "pickup",
    "pickup_time": "2025-11-26T08:15:00.000Z",
    "destination": {
      "city": "Doha",
      "country": "Qatar"
    }
  }
}

2. shipment.intransit

Triggered when driver starts the delivery (pickup complete, now heading to customer):

{
  "event": "shipment.intransit",
  "timestamp": "2025-11-26T09:00:00.000Z",
  "data": {
    "shipment_id": "SHP-2025-001234",
    "shipment_detail_id": "abc123-def456",
    "shop_id": "shop_xyz",
    "order_reference": "ORD-1234",
    "awb": "NB-1234567890",
    "tracking_url": "https://nbox.now/track/NB-1234567890",
    "carrier": "aramex",
    "status": "in_transit",
    "intransit_time": "2025-11-26T09:00:00.000Z",
    "destination": {
      "city": "Doha",
      "country": "Qatar"
    }
  }
}

4. shipment.completed (Basic)

Triggered when shipment is successfully delivered:

{
  "event": "shipment.completed",
  "timestamp": "2025-11-26T10:30:00.000Z",
  "data": {
    "shipment_id": "SHP-2025-001234",
    "shipment_detail_id": "abc123-def456",
    "shop_id": "shop_xyz",
    "order_reference": "ORD-1234",
    "awb": "NB-1234567890",
    "tracking_url": "https://nbox.now/track/NB-1234567890",
    "carrier": "aramex",
    "status": "delivered",
    "completion_time": "2025-11-26T10:30:00.000Z"
  }
}

5. shipment.failed

Triggered when shipment is returned to sender:

{
  "event": "shipment.failed",
  "timestamp": "2025-11-26T14:45:00.000Z",
  "data": {
    "shipment_id": "SHP-2025-001235",
    "shipment_detail_id": "xyz789-abc321",
    "shop_id": "shop_xyz",
    "order_reference": "ORD-1235",
    "awb": "NB-0987654321",
    "tracking_url": "https://nbox.now/track/NB-0987654321",
    "carrier": "fedex",
    "status": "return_to_sender",
    "failure_time": "2025-11-26T14:45:00.000Z",
    "failure_reason": "Customer refused delivery"
  }
}

6. shipment.completed (With OnFleet Performance Data)

When delivery includes OnFleet tracking, additional performance metrics are included:

{
  "event": "shipment.completed",
  "timestamp": "2025-11-26T16:20:00.000Z",
  "data": {
    "shipment_id": "SHP-2025-001236",
    "shipment_detail_id": "def456-ghi789",
    "shop_id": "shop_xyz",
    "order_reference": "ORD-1236",
    "awb": "NB-1122334455",
    "tracking_url": "https://nbox.now/track/NB-1122334455",
    "carrier": "aramex",
    "status": "delivered",
    "completion_time": "2025-11-26T16:20:00.000Z",
    "onfleet_data": {
      "task_id": "onfleet_task_123",
      "driver_name": "Ahmed Al-Mansouri",
      "driver_phone": "+974XXXXXXXX",
      "completion_details": {
        "success": true,
        "notes": "Left with receptionist"
      },
      "distance_traveled_km": 12.5,
      "time_on_route_minutes": 35
    }
  }
}

Common Payload Fields

Managing Webhooks

Via Dashboard

1. Navigate to Dashboard → Integrations
2. Click "Create Webhook"
3. Enter your HTTPS webhook URL
4. Select events to subscribe to
5. Save and copy your secret key
6. Use "View Delivery History" button to monitor all webhook deliveries

Delivery History

View comprehensive delivery history for all your webhooks by clicking "View Delivery History"in the Integrations dashboard. The delivery history page shows:

• Summary Statistics: Active webhooks count, total deliveries, total failures, and success rate
• All Delivery Attempts: View up to 100 most recent deliveries across all your webhook endpoints
• Delivery Details: Event type, HTTP status, delivery status (delivered/failed/pending), timestamps, and error messages
• Test Webhooks: Test webhook deliveries are also tracked and visible in history for debugging

Via API

Endpoint: POST /api/webhooks

Request Body

Example Request

POST /api/webhooks
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "url": "https://your-domain.com/webhooks/nbox",
  "events": [
    "shipment.pickup",
    "shipment.intransit",
    "shipment.completed",
    "shipment.failed"
  ]
}

Example Response

{
  "status": "success",
  "webhook": {
    "id": "wh_abc123",
    "url": "https://your-domain.com/webhooks/nbox",
    "secret": "whsec_abc123...",
    "events": ["shipment.pickup", "shipment.intransit", "shipment.completed", "shipment.failed"],
    "is_active": true,
    "created_at": "2025-11-26T10:30:00Z"
  }
}

Security - Signature Verification

All webhooks are signed with HMAC-SHA256. You must verify the signature to ensure the webhook came from NBox.

Verification Steps

1. Extract X-NBox-Signature and X-NBox-Timestamp from headers
2. Construct signed payload: timestamp + "." + raw_body
3. Compute HMAC-SHA256 using your webhook secret
4. Compare signatures using timing-safe comparison
5. Verify timestamp is recent (within 5 minutes)

Node.js Example

const crypto = require('crypto');

function verifyWebhookSignature(req, secret) {
  const signature = req.headers['x-nbox-signature'];
  const timestamp = req.headers['x-nbox-timestamp'];
  const rawBody = req.rawBody; // Must be raw string

  // Check timestamp (5 minute window)
  const timestampAge = Date.now() - new Date(timestamp).getTime();
  if (timestampAge > 5 * 60 * 1000) {
    throw new Error('Webhook timestamp too old');
  }

  // Compute signature
  const signedPayload = `${timestamp}.${rawBody}`;
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(signedPayload, 'utf8')
    .digest('hex');

  // Timing-safe comparison
  const isValid = crypto.timingSafeEqual(
    Buffer.from(signature, 'hex'),
    Buffer.from(expectedSignature, 'hex')
  );

  if (!isValid) {
    throw new Error('Invalid webhook signature');
  }

  return true;
}

Retry Logic

Failed webhook deliveries are automatically retried up to 5 times with exponential backoff:

Best Practices

• Return 200 immediately: Respond within 10 seconds to acknowledge receipt
• Process asynchronously: Use job queues for long-running operations
• Implement idempotency: Store delivery IDs to prevent duplicate processing
• Log all webhooks: Keep audit logs for debugging
• Use HTTPS: Webhook URLs must use HTTPS (HTTP is not supported)

Testing

Test your webhook endpoint to ensure it can receive and process notifications correctly. Test webhooks create persistent delivery records that you can review in the delivery history.

Via Dashboard: Click the "Send Test" button on any webhook endpoint

Via API:

POST /api/webhooks/{webhook_id}/test
Authorization: Bearer YOUR_API_TOKEN

Test deliveries appear in your webhook delivery history with event type shipment.test, allowing you to verify signature validation and response handling.

API Reference

AWB Download API

Download AWB Label (PDF)

Download the Air Waybill label as a PDF document for printing and attaching to packages.

Endpoint

GET /api/awb/{shipment_id}

Parameters

Response

• Content-Type: application/pdf
• Status Code: 200 (Success), 404 (Not Found), 500 (Server Error)
• File Name: AWB_{shipment_id}_{date}.pdf

Example Request

GET https://nbox.now/api/awb/ORD-NB-11132

Response:
- HTTP/1.1 200 OK
- Content-Type: application/pdf
- Content-Disposition: attachment; filename="AWB_ORD-NB-11132_2025-11-26.pdf"
- (Binary PDF data)

Notes

• No Authentication Required: This endpoint is publicly accessible
• Use Case: Programmatically download AWB labels for automated printing systems
• Format: Standard A4 PDF format with 10mm margins, optimized for printing
• Availability: AWB labels are generated after the shipment reaches "pickup" status

Error Responses

// 404 - Record Not Found
{
  "status": "failed",
  "message": "Record not found"
}

// 500 - Generation Error
{
  "status": "failed",
  "message": "Failed to generate AWB PDF",
  "error": "Error details (development only)"
}

Integration Example

Option 1: Download immediately after creating order:

// After creating order
const orderResponse = await fetch('https://nbox.now/api/order', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer YOUR_TOKEN' },
  body: JSON.stringify(orderData)
});

const order = await orderResponse.json();
const { shipment_id } = order;

// Download AWB label immediately
const awbUrl = `https://nbox.now/api/awb/${shipment_id}`;
const awbResponse = await fetch(awbUrl);
const pdfBuffer = await awbResponse.buffer();

// Save or print the AWB label
await saveAWBLabel(shipment_id, pdfBuffer);

Option 2: Download after receiving pickup webhook:

// Webhook handler
app.post('/webhooks/nbox', async (req, res) => {
  const webhook = req.body;

  if (webhook.event === 'shipment.pickup') {
    // Extract shipment_id from webhook payload
    const { shipment_id } = webhook.data;

    // Download AWB label
    const awbUrl = `https://nbox.now/api/awb/${shipment_id}`;
    const response = await fetch(awbUrl);
    const pdfBuffer = await response.buffer();

    // Save or print the AWB label
    await saveAWBLabel(shipment_id, pdfBuffer);

    // Respond to webhook
    res.status(200).send('OK');
  }
});

Customer Tracking

Overview

NBox provides public tracking URLs that allow customers to track their shipments in real-time without authentication. These URLs redirect to the carrier's tracking portal and provide comprehensive delivery information.

Tracking URL Format

Format: https://{environment_url}/track/{awb}

Production Example: https://nbox.now/track/NB-1234567890
Staging Example:    https://staging.nbox.now/track/NB-1234567890

Getting the Tracking URL

You'll receive the tracking URL in the shipment.pickup webhook event:

{
  "event": "shipment.pickup",
  "timestamp": "2025-11-26T08:15:00.000Z",
  "data": {
    "shipment_id": "SHP-2025-001234",
    "order_reference": "ORD-1234",
    "awb": "NB-1234567890",
    "tracking_url": "https://nbox.now/track/NB-1234567890",
    "carrier": "aramex",
    "status": "pickup",
    "pickup_time": "2025-11-26T08:15:00.000Z"
  }
}

Use Cases

• Customer Notifications: Include the tracking URL in order confirmation and shipping notification emails
• Order Status Pages: Display the tracking link on your website's order status/history pages
• Customer Support: Share the tracking URL with customers who inquire about their shipment status
• Mobile Apps: Embed the tracking URL in push notifications or in-app order details

Tracking Information Provided

When customers visit the tracking URL, they can see:

• Current shipment status
• Delivery timeline and estimated delivery date
• Carrier information
• Delivery location updates
• Driver information (when available via OnFleet)
• Real-time GPS tracking (for OnFleet-tracked deliveries)
• Delivery photos and signatures (when captured)

Integration Examples

Email Notification

// Send tracking email after receiving pickup webhook
app.post('/webhooks/nbox', async (req, res) => {
  const webhook = req.body;

  if (webhook.event === 'shipment.pickup') {
    const { order_reference, tracking_url, awb } = webhook.data;

    await sendEmail({
      to: customer.email,
      subject: 'Your order has been shipped!',
      html: `
        <h2>Your Order #${order_reference} is on its way!</h2>
        <p>Tracking Number: <strong>${awb}</strong></p>
        <p>
          <a href="${tracking_url}"
             style="background: #007bff; color: white; padding: 10px 20px;
                    text-decoration: none; border-radius: 5px;">
            Track Your Shipment
          </a>
        </p>
        <p>Or copy this link: ${tracking_url}</p>
      `
    });

    res.status(200).send('OK');
  }
});

Order Status Page

<!-- HTML Example -->
<div class="order-status">
  <h3>Order #{{ order.reference }}</h3>
  <div class="tracking-info">
    <p><strong>Status:</strong> Shipped</p>
    <p><strong>Tracking #:</strong> {{ order.awb }}</p>
    <p>
      <a href="{{ order.tracking_url }}"
         target="_blank"
         class="btn btn-primary">
        <i class="icon-location"></i>
        Track Your Package
      </a>
    </p>
  </div>
</div>

SMS Notification

// Send SMS with tracking link
const message = `
Your order #${order_reference} has shipped!
Track it here: ${tracking_url}
- YourStore
`;

await sendSMS(customer.phone, message);

Best Practices

• Immediate Notification: Send tracking information as soon as you receive the pickup webhook
• Multiple Channels: Share tracking via email, SMS, and on your website for maximum visibility
• Clear Instructions: Explain that customers can click the link to see real-time updates
• Proactive Updates: Consider sending additional notifications when delivery status changes (using completed/failed webhooks)
• Mobile-Friendly: Ensure tracking links work well on mobile devices
• Save Tracking Data: Store the tracking URL and AWB in your database for future reference

Notes

• Public Access: Tracking URLs are publicly accessible and don't require authentication
• Shareable: Customers can share the tracking link with others (e.g., gift recipients)
• Persistent: Tracking URLs remain active even after delivery for historical reference
• Redirect Behavior: URLs redirect to the appropriate carrier tracking portal or OnFleet tracking page