Tracking
이 콘텐츠는 아직 번역되지 않았습니다.
You can use Tracking API to obtain list of events for a tracking number. We assume that the tracking number is generated in your Teapplix account. In addition, you can also have Teapplix send out Tracking Notifications for tracking numbers generated inside Teapplix (you would need to contact Teapplix Support to turn this on)
- GET - you query the tracking event for a single tracking number
- POST - this is an outbound notification that Teapplix sends out, daily, on “active shipments” that is generated in your Teapplix Account
The following is the schema for the /Tracking call. Notice for POST, the input / output is reversed on the outbound “notification”:
GET Request
Query parameters
| Property | Type | Description | Constraints |
|---|---|---|---|
Carrier |
string | Carrier name, possible values 'USPS', 'UPS', 'FEDEX', 'DHLE', 'DHL', 'GOFO', 'YANWEN' | |
TrackingNumber |
string | Shipment tracking # |
GET Response - 200
Track
| Property | Type | Description | Constraints |
|---|---|---|---|
TxnId |
string | Unique id for each entry | Max-Length: 40Pattern: [\s\S] |
PackageNo |
integer | Package Number | |
ShipDate |
string | Shipping date | Format: date |
TrackingNumber |
string | Tracking number of shipment | RequiredMax-Length: 50 |
CarrierName |
string | Carrier name which is assigned with tracking | |
IsDelivered |
boolean | Was package delivered | Required |
Status |
string | Teapplix tracking status: delivered, in_transit, out_for_delivery, picked_up, pre_transit, return_to_sender, failure, unknown | |
EstimatedDeliveryDate |
string | Estimated Delivery Date (if available) | Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$ |
Events |
TrackingEventDetails[] | Tracking events details |
TrackingEventDetails
| Property | Type | Description | Constraints |
|---|---|---|---|
DateTime |
string | Event date and time (UTC) | Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$ |
City |
string | City where event occurred (if available) | |
State |
string | State where event occurred (if available) | |
Country |
string | Country where event occurred (if available) | |
PostalCode |
string | Postal or ZIP code where event occurred (if available) | |
Type |
string | Event type | RequiredOne of: DELIVERY, RETURN, PICKUP, SUBMIT_TO_CARRIER, ADJUST_WEIGHT_RATE, PRESORT, EXCEPTION, OTHER |
Status |
string | Teapplix tracking status: delivered, in_transit, out_for_delivery, picked_up, pre_transit, return_to_sender, failure, unknown | |
Description |
string | Event type description (if available) |
GET Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
GET Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Request
Track Request
| Property | Type | Description | Constraints |
|---|---|---|---|
Shipments |
Track[] |
Track
| Property | Type | Description | Constraints |
|---|---|---|---|
TxnId |
string | Unique id for each entry | Max-Length: 40Pattern: [\s\S] |
PackageNo |
integer | Package Number | |
ShipDate |
string | Shipping date | Format: date |
TrackingNumber |
string | Tracking number of shipment | RequiredMax-Length: 50 |
CarrierName |
string | Carrier name which is assigned with tracking | |
IsDelivered |
boolean | Was package delivered | Required |
Status |
string | Teapplix tracking status: delivered, in_transit, out_for_delivery, picked_up, pre_transit, return_to_sender, failure, unknown | |
EstimatedDeliveryDate |
string | Estimated Delivery Date (if available) | Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$ |
Events |
TrackingEventDetails[] | Tracking events details |
TrackingEventDetails
| Property | Type | Description | Constraints |
|---|---|---|---|
DateTime |
string | Event date and time (UTC) | Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$ |
City |
string | City where event occurred (if available) | |
State |
string | State where event occurred (if available) | |
Country |
string | Country where event occurred (if available) | |
PostalCode |
string | Postal or ZIP code where event occurred (if available) | |
Type |
string | Event type | RequiredOne of: DELIVERY, RETURN, PICKUP, SUBMIT_TO_CARRIER, ADJUST_WEIGHT_RATE, PRESORT, EXCEPTION, OTHER |
Status |
string | Teapplix tracking status: delivered, in_transit, out_for_delivery, picked_up, pre_transit, return_to_sender, failure, unknown | |
Description |
string | Event type description (if available) |
POST Response - 200
TrackNotificationResult
Result of a track-notification submission. Currently the endpoint is a stub (returns 501); when implemented, the success body extends SuccessMessage and carries the resolved shipments under Shipments.
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version. | |
Status |
string | Operation status: 'Recorded' on success. | RequiredOne of: Recorded |
Message |
string | Human-readable result message. | |
Description |
string[] | Detailed description | |
Shipments |
Track[] | Per-shipment tracking detail resolved by the request. |
Track
| Property | Type | Description | Constraints |
|---|---|---|---|
TxnId |
string | Unique id for each entry | Max-Length: 40Pattern: [\s\S] |
PackageNo |
integer | Package Number | |
ShipDate |
string | Shipping date | Format: date |
TrackingNumber |
string | Tracking number of shipment | RequiredMax-Length: 50 |
CarrierName |
string | Carrier name which is assigned with tracking | |
IsDelivered |
boolean | Was package delivered | Required |
Status |
string | Teapplix tracking status: delivered, in_transit, out_for_delivery, picked_up, pre_transit, return_to_sender, failure, unknown | |
EstimatedDeliveryDate |
string | Estimated Delivery Date (if available) | Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$ |
Events |
TrackingEventDetails[] | Tracking events details |
TrackingEventDetails
| Property | Type | Description | Constraints |
|---|---|---|---|
DateTime |
string | Event date and time (UTC) | Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$ |
City |
string | City where event occurred (if available) | |
State |
string | State where event occurred (if available) | |
Country |
string | Country where event occurred (if available) | |
PostalCode |
string | Postal or ZIP code where event occurred (if available) | |
Type |
string | Event type | RequiredOne of: DELIVERY, RETURN, PICKUP, SUBMIT_TO_CARRIER, ADJUST_WEIGHT_RATE, PRESORT, EXCEPTION, OTHER |
Status |
string | Teapplix tracking status: delivered, in_transit, out_for_delivery, picked_up, pre_transit, return_to_sender, failure, unknown | |
Description |
string | Event type description (if available) |
POST Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Response - 501
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |