Schedule a meeting

Tracking Search

URL

PROD https://api.skypostal.com

TEST https://api-test.skypostal.com

Endpoint

POST /wcf-services/service-tracking.svc/tracking/search

Request Parameters

Parameters

user_info

Object - Required

User Info Definition.

tracking_number

String - Required

Any number that is linked to the package. It can be: SkyPostal’s number , Client’s number or Label's number/barcode

from_checkpoint

String

Checkpoint from which you want to retrieve the tracking.

language_iso_code

String

Language on which you want the checkpoint's description to be returned (ENG, ESP, POR, etc).

date_format

String

Sets specific date format for entry_date_str and entry_date_db_str fields.

User Info Definition

Parameters

user_code

Integer - Required

This is the user code provided by Skypostal.

user_key

String - Required

This is the app key provided by Skypostal.

app_key

String - Required

This is the app key provided by Skypostal.

Response Error Codes

Response

10001

No Information available.

13001

Access Denied.

12001

Service unavailable, contact system administrator.

Remember

user_code, user_key and app_key are generic credentials, make sure to request your own for TEST and PROD environemnts.

The command should be run as in the following example:

{
  "user_info": {
    "user_code": 0,
    "user_key": "userkey",
    "app_key": "appkey"
  },
  "tracking_number": "SK00216147506BR",
  "from_checkpoint": "",
  "language_iso_code": "ENG",
  "date_format": "",
}

The command will return the following format:

{
    "_verify": true,
    "additional_info": {
        "internal": [],
        "server": {
            "server_id": ".185",
            "server_time": 0.07811739999999999
        }
    },
    "data": [
        {
            "_verify": true,
            "additional_info": {
                "internal": [],
                "server": {
                    "server_id": null,
                    "server_time": 0
                }
            },
            "country_iso_code": "US",
            "delivery_id": "",
            "entry_date": "/Date(1647286291000-0400)/",
            "entry_date_db": "/Date(1647286291000-0400)/",
            "entry_date_db_str": "2022-03-14 15:31:31",
            "entry_date_str": "2022-03-14 15:31:31",
            "error": {
                "error_code": "10001",
                "error_description": "",
                "error_location": "",
                "system_error": false
            },
            "event_locality": "",
            "iata_code": "MIA",
            "image_url_signature": "",
            "order_label": "NX849357086BR",
            "time_zone": "GMT-04:00",
            "track_cdg": "DCO",
            "track_description": "DOCUMENTATION COMPLETE",
            "track_description_op": "DOCUMENTATION COMPLETE",
            "track_obs": "",
            "track_type": "EV",
            "track_type_description": "EVENT",
            "trck_nmr_fol": 21614750
        },
        {
            "_verify": true,
            "additional_info": {
                "internal": [],
                "server": {
                    "server_id": null,
                    "server_time": 0
                }
            },
            "country_iso_code": "US",
            "delivery_id": "",
            "entry_date": "/Date(1647286291000-0400)/",
            "entry_date_db": "/Date(1647286291000-0400)/",
            "entry_date_db_str": "2022-03-14 15:31:31",
            "entry_date_str": "2022-03-14 15:31:31",
            "error": {
                "error_code": "10001",
                "error_description": "",
                "error_location": "",
                "system_error": false
            },
            "event_locality": "",
            "iata_code": "MIA",
            "image_url_signature": "",
            "order_label": "NX849357086BR",
            "time_zone": "GMT-04:00",
            "track_cdg": "HCV",
            "track_description": "HS_CODE VALIDATION",
            "track_description_op": "HS_CODE VALIDATION",
            "track_obs": "",
            "track_type": "EV",
            "track_type_description": "EVENT",
            "trck_nmr_fol": 21614750
        },
        {
            "_verify": true,
            "additional_info": {
                "internal": [],
                "server": {
                    "server_id": null,
                    "server_time": 0
                }
            },
            "country_iso_code": "US",
            "delivery_id": "",
            "entry_date": "/Date(1647286290000-0400)/",
            "entry_date_db": "/Date(1647286290000-0400)/",
            "entry_date_db_str": "2022-03-14 15:31:30",
            "entry_date_str": "2022-03-14 15:31:30",
            "error": {
                "error_code": "10001",
                "error_description": "",
                "error_location": "",
                "system_error": false
            },
            "event_locality": "",
            "iata_code": "MIA",
            "image_url_signature": "",
            "order_label": "NX849357086BR",
            "time_zone": "GMT-04:00",
            "track_cdg": "DRC",
            "track_description": "DATA RECEIVED",
            "track_description_op": "DATA RECEIVED",
            "track_obs": "",
            "track_type": "EV",
            "track_type_description": "EVENT",
            "trck_nmr_fol": 21614750
        }
    ],
    "error": null
}