Transit Times and Services

Get Services Transit Times

Gets available services and transit times for certain providers.

URL

PROD https://api.skypostal.com/

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

Endpoint

POST /wcf-services/service-shipment.svc/shipment/get-services-transit-times

Request Credentials

Parameters
`user_info`	Object - Required User Info Definition.
`ship_transit_info`	Object - Required Ship Transit Info.

Parameters

user_info

Object - Required

User Info Definition.

ship_transit_info

Object - Required

Ship Transit Info.

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.

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.

Ship Transit Info

Parameters
`origin_address`	Integer - Required Address Info Definition.
`destination_address`	String - Required Address Info Definition.
`weight_info`	String - Required Weight Info Definition.
`value_info`	String - Required Value Info Definition.
`ship_date_time`	String Unix/Epoch datetime of the pick up/tendered to carrier (cannot be a past date), current datetime will be used if is not sent.

Address Info Definition

Parameters
`country_iso_code`	String - Required 2 characters iso code. (e.g. BR, MX, US, etc.)
`state_abbreviation`	String - Required Abbreviation of the state.
`city_name`	String - Required Name of the city.
`zip_code`	String - Required Send a valid zipcode.

Weight Info Definition

Parameters
`weight`	Double - Required Weight.
`weight_unit`	String - Required Can be kg = kilograms, lb = pounds.

Parameters

weight

Double - Required

Weight.

weight_unit

String - Required

Can be kg = kilograms, lb = pounds.

Value Info Definition

Parameters
`value`	Double - Required Product Value.
`currency`	String - Required Value Currency (USD).

Parameters

value

Double - Required

Product Value.

currency

String - Required

Value Currency (USD).

Datetime definition

Definition
DateTime values are JSON string using the following format: The content of the string is /Date(ticks)/ where ticks represents milliseconds since epoch (UTC). So November 29, 1989, 4:55:30 AM, in UTC is encoded as "/Date(1683749700000)/"

Definition

DateTime values are JSON string using the following format:

The content of the string is /Date(ticks)/ where ticks represents milliseconds since epoch (UTC). So November 29, 1989, 4:55:30 AM, in UTC is encoded as "/Date(1683749700000)/"

Remember

user_code, user_key, app_key and copa_id 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": 123123,
        "user_key": "*****",
        "app_key": "*****"
    },
    "ship_transit_info": {
        "origin_address": {
            "country_iso_code": "US",
            "state_abbreviation": "TX",
            "city_name": "Royse City",
            "zip_code": "75189"
        },
        "destination_address": {
            "country_iso_code": "US",
            "state_abbreviation": "FL",
            "city_name": "Beverly Hills",
            "zip_code": "34465"
        },
        "weight_info": {
            "weight": 1.5,
            "weight_unit": "kg"
        },
        "value_info": {
            "value": 155,
            "currency": "USD"
        },
        "ship_date_time": null
    }
}

The command will return the following format:

{
    "_verify": true,
    "additional_info": {
        "internal": [],
        "server": {
            "server_id": null,
            "server_time": 0
        }
    },
    "data": [
        {
            "business_transit_days": 1,
            "delivery_date_time": "/Date(1706718600000-0500)/",
            "delivery_date_time_str": "2024-01-31 11:30:00",
            "saturday_delivery": false,
            "service_type": "UPS Next Day Air® Early",
            "ship_date_time": "/Date(1706644800000-0500)/",
            "ship_date_time_str": "2024-01-30 15:00:00"
        },
        {
            "business_transit_days": 1,
            "delivery_date_time": "/Date(1706760000000-0500)/",
            "delivery_date_time_str": "2024-01-31 23:00:00",
            "saturday_delivery": false,
            "service_type": "UPS Next Day Air®",
            "ship_date_time": "/Date(1706644800000-0500)/",
            "ship_date_time_str": "2024-01-30 15:00:00"
        },
        {
            "business_transit_days": 2,
            "delivery_date_time": "/Date(1706846400000-0500)/",
            "delivery_date_time_str": "2024-02-01 23:00:00",
            "saturday_delivery": false,
            "service_type": "UPS 2nd Day Air®",
            "ship_date_time": "/Date(1706644800000-0500)/",
            "ship_date_time_str": "2024-01-30 15:00:00"
        },
        {
            "business_transit_days": 2,
            "delivery_date_time": "/Date(1706846400000-0500)/",
            "delivery_date_time_str": "2024-02-01 23:00:00",
            "saturday_delivery": false,
            "service_type": "UPS Ground",
            "ship_date_time": "/Date(1706644800000-0500)/",
            "ship_date_time_str": "2024-01-30 15:00:00"
        }
    ],
    "error": {
        "error_code": null,
        "error_description": null,
        "error_location": null,
        "system_error": false
    }
}