Schedule a meeting

Hub Pre Alert

New pre alert

This endpoint creates a pre alert manifest to a destination HUB.

URL

PROD https://api.skypostal.com/

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

Endpoint

POST /wcf-services/service-manifest.svc/manifest/new-hub-manifest

Request Credentials

Parameters

user_info

Object - Required

User Info Definition.

manifest_info

Object - Required

Manifest Info Definition.

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.

Manifest Info Definition

Parameters

copa_id

Integer - Required

Client identificator provided by Skypostal.

manifest_tracking

Integer - Required

Master /Manifest AWB / Main Tracking number (for example 07443276021)

origin

Object - Required

Origin Definition.

destination

Object - Required

Destination Definition.

service_type

Integer - Required

Add parcel courier: 790 if is DDP or 795 DDU.

total_weight

Double - Required

Total manifest weight in Kilo.

total_receptacles

String - Required

Total bags or Receptacles quantity.

clearance_value_type

String - Required

2-char clearance value type. Available options: "HV", "LV" and "NV". For "High Value", "Low Value" and "No Value Specified" respectively.

Remember

user_code, user_key, app_key, copa_id and box_id are generic credentials, make sure to request your own for TEST and PROD environments

Carrier Routes/Flights Information Definition

Parameters

route_order

Integer - Required

Route/Flight order sequence.

carrier_name

String - Required

Carrier Name.

carrier_route_code

String - Required

Carrier-specific Route code / Flight number.

origin

Object - Required

Origin Definition.

destination

Object - Required

Destination definition.

departure_date

String - Required

Departure date. Unix/Epoch datetime in miliseconds.

estimated_arrival_date

String - Required

Departure date. Unix/Epoch datetime in miliseconds.

Origin Definition

Parameters

country_iso_code

String - Required

2 characters iso code. (e.g. BR, MX, US, etc.)

iata_code

String - Required

Gateway departure code get IATA_CODE from get_commercial_partner_gateway.

gateway_type

Integer - Required

Transportation type definition.

Destination Definition

Parameters

country_iso_code

String - Required

2 characters iso code. (e.g. BR, MX, US, etc.)

iata_code

String - Required

Gateway arrival code get IATA_CODE from get_commercial_partner_gateway.

gateway_type

Integer - Required

Transportation type definition.

Transportation Type Definition

Value

Description

1.

Air.

2.

Land.

3.

Sea.

Receptacle / Bags Detail Definition

Parameters

receptacle_tracking

String - Required

Receptacle / Bag Unique Identifier.

receptacle_weight

Double

Receptacle specific weight in KG.

receptacle_pieces

Integer

To specify the quantity of physical pieces, If a single receptacle tracking ID is divided in multiple containers.

items

List of Objects - Required

Items Definition.

Items Definition

Parameters

external_tracking

String - Required

Identifier of the shipment to manifest, can send label, awb, extr_tracking.

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)/"

The command should be run as in the following example:

{
    "user_info": {
        "user_code": 123123,
        "user_key": "key",
        "app_key": "akey"
    },
    "manifest_info": {
        "copa_id": 616,
        "manifest_tracking": "116HJ9WTD",
        "origin": {
            "country_iso_code": "US",
            "iata_code": "CA",
            "gateway_type": 1
        },
        "destination": {
            "country_iso_code": "US",
            "iata_code": "MIA",
            "gateway_type": 1
        },
        "service_type": 790,
        "total_weight": 1.0,
        "total_receptacles": 3,
        "clearance_value_type": "NV",        
        "routes_information": [
            {
                "route_order": 1,
                "carrier_name":"R2 Services",
                "carrier_route_code":"UFG-555",                
                "origin": {
                    "country_iso_code": "US",
                    "iata_code": "CA",
                    "gateway_type": 1
                },
                "destination": {
                    "country_iso_code": "US",
                    "iata_code": "MIA",
                    "gateway_type": 1
                },
                "departure_date": "\/Date(1699522557000-0600)\/",
                "estimated_arrival_date": "\/Date(1679522557000-0600)\/"                
            }
        ],
        "receptacles_detail": [
            {
                "receptacle_tracking": "RECEPTACLE01",
                "receptacle_weight":15,
                "receptacle_pieces":3,
                "items": [
                    {
                        "external_tracking": "6001015314823-FA04"
                    }
                ]
            },
            {
                "receptacle_tracking": "RECEPTACLE02",
                "receptacle_weight":11,
                "receptacle_pieces":null,
                "items": [
                    {
                        "external_tracking": "6001015314823-FA05"
                    }
                ]
            }
        ]
    }
}

The command will return the following format:

[
  {
    "_verify": true,
    "additional_info": {
      "internal": [],
      "server": {
        "server_id": null,
        "server_time": 2.6719094
      }
    },
    "data": [
      {
        "_verify": true,
        "additional_info": {
          "internal": [],
          "server": {
            "server_id": null,
            "server_time": 0
          }
        },
        "error": [],
        "import_manifest_code": 96687,
        "response": "In Process!"
      }
    ],
    "error": []
  }
]