Webhook

All the ‘N/A’fields or optional fields can be sent as blank or can be removed as well from the payload.

URL

Staging Merchants to share

UAT Merchants to share

Endpoint

POST

Attributes

OrderNumber

String - Required

Represents the merchant order number received during order creation

TrackingNumber

String - Required

Unique tracking number generated by the system

CreatedDate

String - Required

Order creation date and time

CurrentStatus

String - Required

Name of the current status

CurrentStatusCode

String - Required

Code of the current status

CurrentStatusTimestamp

String - Required

Timestamp of the current status

LastUpdatedAt

String - Required

Timestamp of the last status updated on the order

StatusRemark

String - Required

Remarks of the current status

DeliveryTrackingURL

String - Required

Tracking URL link for the order

LabelUrl

String - Required

Label URL link for the order

ProofOfDelivery

String

Represent the delivery proof object(will have values once the order is delivered)

DeliverySignatureURL

String

URL which points to the signature captured during delivery of the order

ImageURL

String

URL which points to the image captured during delivery of the order

DeliveryFailureReason

String

Represent the failure reason for the delivery

Order Milestones

Status Name	Status Code	Status Description
Order Confirmed	order_confirmed	Your Order has been confirmed.
Order Shipped	manifest_received	Order is shipped from its origin location.
Shipment Reached At Facility	Shipment_reached_at_Facility	Order is inbounded at the sepex’s facility.
Out for Delivery	out_for_delivery	Order is out for delivery to the end consignee’s location.
Order Delivered Successfully	order_delivered_successfully	Order is delivered successfully to the end consignee
Delivery Failed	order_undelivered	Unable to Deliver the order to the end consignee
Reattempt Job Created	reattempt_job_created	Reattempt Job is created for this order
Returned To Station	return_success	Order is returned to the facility

Request Body application/json

[
    {
        "OrderNumber": "BAG19022024N003",
        "TrackingNumber": "SXPR0000000000008288",
        "CreatedDate": "2024-02-19 13:55:09",
        "CurrentStatus": "Order Confirmed",
        "CurrentStatusCode": "order_confirmed",
        "CurrentStatusTimestamp": "2024-02-19 13:55:12",
        "LastUpdatedAt": "2024-02-19 13:55:09",
        "StatusRemark": "Your Order SXPR0000000000008288 has been confirmed.",
        "DeliveryTrackingURL": "https://trackdev.fareye.co/tracking?viLbvJQwQ5P5H++Y+hpbTebRh/zsDKJ87zD5zfaAneVWHZluWwGwsar0SR1q2I8iLd0HISjeDqmJuFA=#/",
        "LabelUrl": "https://trackdev.fareye.co/tracking?viLbvJQwQ5P5H++Y+hpbTebRh/zsDKJ87zD5zfaAneVWHZluWwGwsar0SR1q2I8iLd0HISjeDqmJuFA=#/",
        "ProofOfDelivery": {
            "DeliverySignatureURL": "",
            "ImageURL": "",
            "DeliveryFailureReason": "Customer Refused"
        }
    }
]

Example JSON Response

{}