Get Tracking Details via webhook

This API allows your application to automatically receive real-time fulfillment and return shipment status updates from Eshopbox.

Registering a Webhook

To receive real-time status updates, you need to provide Eshopbox with the webhook URL to be configured. This is a manual process. Please raise a support ticket through your Eshopbox workspace to request webhook configuration. Learn how to raise a support ticket: Support guide

NOTE: Auto registering a webhook (Comming soon)

Shipment Journey Events

Once the webhook is registered, Eshopbox will send updates based on the shipment lifecycle.

Forward Shipment Events (Customer Delivery)

Stage
Event Subtype
Description

Shipment Created

created

Shipment has been created in the system.

Order Packed

packed

Order has been packed and is ready for dispatch.

Ready to Ship

ready_to_ship

Shipment is ready to be handed over to the courier partner.

Picked up

picked_up

Courier partner has picked up the shipment.

Out for Pickup

out_for_pickup

Shipment is assigned and out for pickup.

Pickup Failed

pickup_failed

Courier failed to pick up the shipment.

In Transit

intransit

Shipment is moving between courier hubs.

Out for Delivery

out_for_delivery

Courier partner is out to deliver the shipment to the customer.

Delivered

delivered

Shipment has been successfully delivered to the customer.

Failed Delivery

failed_delivery

Delivery attempt failed (e.g., customer not available).

Return to Origin

rto, rto_created

Return to Origin initiated for the shipment.

RTO In Transit

rto_intransit

Shipment is in transit back to the origin warehouse.

RTO Out for Delivery

rto_out_for_delivery

Shipment is out for delivery back to the origin.

RTO Delivered

rto_delivered

Returned shipment successfully delivered back to origin.

RTO Failed

rto_failed

Return to origin attempt failed.

Shipment Delayed

shipment_delayed

Shipment has been delayed due to operational issues.

Shipment Dispatched

dispatched

Shipment has been dispatched from the warehouse.

Shipment Held

shipment_held

Shipment is temporarily on hold due to exceptions.

Unhold

unhold

Shipment has been released from hold.

Return Expected

return_expected

Return from customer is expected (usually post-NDR or return).

Cancelled Order

cancelled_order

Order has been cancelled.

NDR Submitted

ndr_resolution_submitted

Non-Delivery Report submitted for resolution.

Damage

damage

Shipment is reported as damaged.

Lost

lost

Shipment is reported as lost in transit.

RTO Contact Support

rto_contact_customer_care

Courier has contacted customer care regarding RTO.

Pickup Pending

pickup_pending

Pickup is scheduled but still pending.


Return Shipment Events (Customer Returns)

Stage
Event Subtype
Description

Return Created

created

Return request has been created by the customer.

Pickup Pending

pickup_pending

Return pickup is scheduled but still pending.

Out for Pickup

out_for_pickup

Courier partner is out to pick up the return shipment.

Pickup Cancelled

pickup_cancelled

Return pickup has been cancelled by the courier or customer.

Pickup Failed

pickup_failed

Courier failed to pick up the return shipment.

Picked Up

picked_up

Return shipment has been successfully picked up.

In Transit

intransit

Return shipment is moving between courier hubs.

Out for Delivery

out_for_delivery

Courier partner is out to deliver the return shipment to the warehouse.

Delivered

delivered

Return shipment delivered to the destination (customer or interim location).

Delivered to WH

delivered_warehouse

Return shipment has been delivered to the warehouse.

Failed Delivery

failed_delivery

Return delivery attempt failed.

Return Complete

complete

Return process is successfully completed.

Cancelled Return

return_cancelled

Return request has been cancelled.

Return Approved

approved

Return shipment has been approved after quality checks.

Return Lost

lost

Return shipment is reported as lost during transit.


Sample Webhook Payload

Webhook payloads are delivered as a POST request to your registered endpoint in JSON format.

Event Example: dispatched

curl --location --request POST 'shipment_created' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerOrderNumber": "AB123456789",
    "vendorOrderNumber": "ORD998877665544",
    "externalShipmentID": "AB123456789-102-22",
    "externalWarehouseID": "Fashion Hub Warehouse 204",
    "externalChannelID": "Myntra Express - Fashion Hub",
    "integrationType": "4",
    "defaultWarehouseCode": "204",
    "orderDate": "2025-03-15 14:25:10",
    "portal_id": 18,
    "paymentType": "ONLINE",
    "order_id": 2134567,
    "channel_id": 102,
    "warehouse_id": 33,
    "account_id": 302,
    "locationCode": "XMUM"
    "region": "",
    "invoiceNumber": "INV-25/3021467",
    "boxType": "MEDIUM",
    "isPriorityShipment": "0",
    "isGift": "1",
    "invoice_url": "https://cdn.fashionhub.com/invoices/INV-25-3021467.pdf",
    "invoiceDate": "2025-03-16 00:00:00",
    "label_url": "https://cdn.fashionhub.com/labels/LABEL-3021467.pdf",
    "labels": "",
    "shippingInfo": [],
    "boxAdditionalRecommendation": [],
    "dimension_length": "32",
    "dimension_width": "24",
    "dimension_height": "10",
    "weight": "780",
    "trackingID": "FHXTRK1289765432",
    "packageID": "",
    "barcode": "",
    "courierName": "BlueDart",
    "created_at": "2025-03-15 15:05:30",
    "updated_at": "2025-03-16 09:40:22",
    "status": "dispatched",
    "remarks": "",
    "customerName": "Amit Sharma",
    "customerContactNumber": "9876012345",
    "email": "amit.sharma@example.com",
    "channelSlug": "fashionhub",
    "status_updated_at": "2025-03-16 10:00:00",
    "status_log": {
      "dispatched": "2025-03-16 10:00:00",
      "packed": "2025-03-16 09:15:00",
      "created": "2025-03-15 15:05:30"
    },
    "orderExternalCreatedAt": "2025-03-15 14:24:00",
    "shippingAddress": {
      "customerName": "Amit Sharma",
      "addressLine1": "21, Green Park Avenue",
      "addressLine2": "Near City Mall",
      "city": "New Delhi",
      "state": "Delhi",
      "postalCode": "110016",
      "countryCode": "IN",
      "countryName": "India",
      "contactPhone": "9876012345",
      "email": "amit.sharma@example.com"
    },
    "id": 2098843,
    "isCOD": "0",
    "track_payload": [],
    "packed_date": "2025-03-16 09:15:00",
    "items": [
      {
        "lineItemSequenceNumber": 1,
        "orderItemID": "FSHB123456-7891011",
        "itemID": "620fe45d1245dc98745678a9",
        "sku": "FSHWMJKT0021_M",
        "customerOrderItemID": "",
        "asin": "",
        "productName": "Men's Casual Denim Jacket",
        "quantity": 1,
        "customerPrice": 1599,
        "lineItemTotal": 1599,
        "invoiceTotal": 1599,
        "discount": 0,
        "taxRate": 12,
        "taxAmount": 191.88,
        "giftMessage": "Happy Birthday! Enjoy your gift.",
        "giftLabelContent": "From Riya",
        "lineItemOrderStatus": "",
        "orderItemIDs": [
          "AB123456789-897654"
        ],
        "productImageUrl": "https://fashionhub.imgcdn.com/products/FSHWMJKT0021_M_1.jpg",
        "productAdditionalInfo": {
          "size": "M",
          "color": "Dark Blue"
        },
        "expectedDeliveryDate": "2025-03-18",
        "shippingCharges": 0,
        "productUrl": "https://fashionhub.in/product/FSHWMJKT0021"
      },
      {
        "lineItemSequenceNumber": 2,
        "orderItemID": "FSHB123456-7891012",
        "itemID": "620fe45d1245dc98745678b2",
        "sku": "FSHWMTEE0045_L",
        "customerOrderItemID": "",
        "asin": "",
        "productName": "Men's Graphic T-Shirt",
        "quantity": 1,
        "customerPrice": 699,
        "lineItemTotal": 699,
        "invoiceTotal": 699,
        "discount": 50,
        "taxRate": 5,
        "taxAmount": 32.14,
        "giftMessage": "",
        "giftLabelContent": "",
        "lineItemOrderStatus": "",
        "orderItemIDs": [
          "AB123456789-897655"
        ],
        "productImageUrl": "https://fashionhub.imgcdn.com/products/FSHWMTEE0045_L_1.jpg",
        "productAdditionalInfo": {
          "size": "L",
          "color": "Black"
        },
        "expectedDeliveryDate": "2025-03-18",
        "shippingCharges": 0,
        "productUrl": "https://fashionhub.in/product/FSHWMTEE0045"
      }
    ]
}'

Last updated

Was this helpful?