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

Shipment Created

created

Order Packed

packed

Ready to Ship

ready_to_ship

Picked up

picked_up

Out for Pickup

out_for_pickup

Pickup Failed

pickup_failed

In Transit

intransit

Out for Delivery

out_for_delivery

Delivered

delivered

Failed Delivery

failed_delivery

Return to Origin

rto, rto_created

RTO In Transit

rto_intransit

RTO Out for Delivery

rto_out_for_delivery

RTO Delivered

rto_delivered

RTO Failed

rto_failed

Shipment Delayed

shipment_delayed

Shipment Dispatched

dispatched

Shipment Held

shipment_held

Unhold

unhold

Return Expected

return_expected

Cancelled Order

cancelled_order

NDR Submitted

ndr_resolution_submitted

Damage

damage

Lost

lost

RTO Contact Support

rto_contact_customer_care

Pickup Pending

pickup_pending


Return Shipment Events (Customer Returns)

Stage
Event Subtype

Return Created

created

Pickup Pending

pickup_pending

Out for Pickup

out_for_pickup

Pickup Cancelled

pickup_cancelled

Pickup Failed

pickup_failed

Picked Up

picked_up

In Transit

intransit

Out for Delivery

out_for_delivery

Delivered

delivered

Delivered to WH

delivered_warehouse

Failed Delivery

failed_delivery

Return Complete

complete

Cancelled Return

return_cancelled

Return Approved

approved

Return Lost

lost


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,
    "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?