Schedule a meeting

Manifest

New manifest

This endpoint creates a new manifest.

URL

PROD https://api.skypostal.com/

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

Endpoint

POST /wcf-services/service-manifest.svc/manifest/new-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.

master_awb

Integer - Required

Master/Manifest AWB (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.

via_oe

Boolean

ETOE Postal Service. True/False value (Default as false).

total_bags

String - Required

Total bags number.

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.

flights_information

Object - Required

Flights Information Definition.

postal_information

Object

Postal Information Definition.

bags_detail

List of Objects - Required

List of Bags Details (Bag Definition).

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

Flights Information Definition

Parameters

flight_order

Integer - Required

Flight order identifier.

airline

String - Required

A valid two digits airline code.

flight_number

String - Required

Flight number.

origin

Object - Required

Origin Definition.

destination

Object - Required

Destination definition.

departure_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.

Postal Information Definition

Parameters

origin

String

Name of the origin country.

destination

String

Name of the destination country.

postal_mail_category_code

String

Postal mail category code. Available options: "1", "2". For "Airmail", "Priority mail sent by surface"

Bags Detail Definition

Parameters

bag_number

String - Required

Bag identifier.

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.

The command should be run as in the following example:

{
    "user_info":
    {
        "user_code":1,
        "user_key":"ok",
        "app_key":"ok"
    },
    "manifest_info":
    {
        "copa_id":616,
        "master_awb":"1234567894",
        "origin":
        {
            "country_iso_code":"US",
            "iata_code":"MIA",
            "gateway_type":1
        },
        "destination":
        {
            "country_iso_code":"MX",
            "iata_code":"MEX",
            "gateway_type":1
        },
        "service_type":"790",
        "via_oe": false,
        "total_weight":7,
        "total_bags":2,
        "clearance_value_type":"NV",
        "flights_information":
        [
            {
                "flight_order":1,
                "airline":"AM",
                "flight_number":"1236",
                "origin":
                {
                    "country_iso_code":"US",
                    "iata_code":"MIA",
                    "gateway_type":1
                },
                "destination":
                {
                    "country_iso_code":"MX",
                    "iata_code":"MEX",
                    "gateway_type":1
                },
                "departure_date":"/Date(1576058400000-0400)/"
            }
        ],
        "postal_information":
        [
            {
                "origin":"1",
                "destination":"1",
                "postal_mail_category_code":"1"
            }
        ],
        "bags_detail":[
            {
                "bag_number":"bag_number_1",
                "items":
                [
                    {
                        "external_tracking":"1234567890-01"
                    },
                    {
                        "external_tracking":"1234567891"
                    }
                ]
            },
            {
                "bag_number":"bag_number_2",
                "items":
                [
                    {
                        "external_tracking":"1234567890"
                    },
                    {
                        "external_tracking":"MX-TST-LOC-020"
                    }
                ]
            }
        ]
    }
}

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": []
    }
]