Subscribe Tracking Details

Subscribe To Shipment Tracking Details

SecuritybearerAuth

Request

path Parameters

trackingNumber

required

string

This indicates the parcel tracking number of created shipment

query Parameters

carrier	string This indicates carrier ID Enum: "USPS" "UPS" "FEDEX" "DHLEXP"
subscribe	string This indicates subscribe to shipment tracking when set to true and unsubscribe to shipment tracking when set to false Enum: "true" "false"

header Parameters

X-PB-Developer-Partner-ID

string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Responses

200

Get Shipment Subscribed Tracking Details

401

The request could not be authorized.

get/api/v1/track/{trackingNumber}/subscribe

Request samples

Response samples

application/json

{"message": "Tracking number subscribed successfully",
"trackingEvents": {"carrier": "FEDEX",
"currentLocation": {"city": "Miami",
"country": "US",
"description": "Delivered",
"postalCode": "33122",
"stateOrProvince": "FL"
},
"currentStatus": {"carrierEventCode": "DL",
"carrierEventDescription": "Delivered",
"eventCode": "AWP- Awaiting Pickup",
"eventDate": "2023-06-28T16:55:00.000Z",
"eventDescription": "Delivered",
"eventLocation": {"city": "Miami",
"country": "US",
"description": "",
"postalCode": "33122",
"stateOrProvince": "FL"
},
"status": "Delivered"
},
"deliveryDate": "2023-06-28T16:55:00.000Z",
"deliveryProofUrl": "",
"estimatedDeliveryDate": "1901-01-01T00:00:00.000Z",
"serviceCode": "",
"serviceName": "FedEx Ground",
"shipDate": "1901-01-01T00:00:00.000Z",
"trackingHistory": [{"carrierEventCode": "DL",
"carrierEventDescription": "Delivered",
"eventCode": "DLD",
"eventDate": "2023-06-28T16:55:00.000Z",
"eventDescription": "Delivered",
"eventLocation": {"city": "Miami",
"country": "US",
"description": "",
"postalCode": "33122",
"stateOrProvince": "FL"
},
"status": "Delivered"
}
]
}
}