Manifest
Create Manifest Via Hub
URL
PROD https://api.skypostal.com
TEST https://api-test.skypostal.com
Endpoint
POST /wcf-services/service-bags.svc/bags/create-manifest-via-hub
Request Parameters
Parameters | |
|---|---|
| Object - Required User Info Definition. |
| Object - Required Bag Pre Manifest Info Definition. |
User Info Definition
Parameters | |
|---|---|
| Integer - Required This is the user code provided by Skypostal. |
| String - Required This is the app key provided by Skypostal. |
| String - Required This is the app key provided by Skypostal. |
Bag Pre Manifest Info Definition
Parameters | |
|---|---|
| Object - Required Bag pre manifest header definition. |
| Object - Required Bag pre manifest detail definition. |
Bag Pre Manifest Header Definition
Parameters | |
|---|---|
| Integer - Required Client identificator provided by Skypostal. |
| Integer - Required Master/Manifest AWB (for example 07443276021). |
| Object - Required Departure Point Definition. |
| Object - Required Entry Point Definition. |
| Object - If null or not sent, default US-MIA hub will be used Entry point definition. |
| Object - Required Options Point Definition. |
| Object - Required Flight Information Definition. |
| Object Postal Information Definition. |
Departure Point Definition
Parameters | |
|---|---|
| String - Required 2 characters iso code. (e.g. BR, MX, US, etc.) |
| String - Required Gateway departure code. |
| Integer - Required Transportation type definition. |
Entry Point Definition
Parameters | |
|---|---|
| String - Required 2 characters iso code. (e.g. BR, MX, US, etc.) |
| String - Required Gateway departure code. |
| Integer - Required Transportation type definition. |
Transportation Type Definition
Value | Description |
|---|---|
1. | Air. |
2. | Land. |
3. | Sea. |
Options Definition
Parameters | Description |
|---|---|
| String - Required Import Service Type Definition. Value matching any of the list. |
| String - Required 2-char clearance value type. Default: NV ("No Value Specified"). For MX Available options: "HV" and "LV". For "High Value" and "Low Value" respectively. |
| String - Required Only For Packet Applies for packet service and has to match one from the table. |
Service Type Definition.
Value | Description |
|---|---|
NX | For shipments created with rate service code 301. |
IX | For shipments created with rate service code 302. |
XP | For shipments created with rate service code 303. |
Import Service Type Definition.
Value | Description |
|---|---|
DDU | Customs Unpaid. |
DDP | Customs Paid. |
Flight Informantion Definition
Parameters | |
|---|---|
| Integer - Required Flight order identifier. |
| String - Required Airline code. |
| String - Required Flight number. |
| Object - Required Origin Definition. |
| Object - Required Destination definition. |
| String - Required Datetime Definition. |
Origin Definition
Parameters | |
|---|---|
| String - Required 2 characters iso code. (e.g. BR, MX, US, etc.) |
| String - Required Gateway departure code. |
| Integer - Required Transportation type definition. |
Destination Definition
Parameters | |
|---|---|
| String - Required 2 characters iso code. (e.g. BR, MX, US, etc.) |
| String - Required Gateway arrival code. |
| Integer - Required Transportation type definition. |
Postal Information Definition
+---------------------------------------------------------------------------------------------------------------------------------------+
| Parameters |
+============================+==========================================================================================================+
| | |
| | String - Required |
| | |
| origin | Name of the origin country. |
| | |
| String - Required Name of the destination country. |
| Object - Required Postal mail category code. Available options: "1", "2". For "Airmail", "Priority mail sent by surface" |
Bag Pre Manifest Detail Definition
Parameters | |
|---|---|
| Integer - Required Bag identificator. |
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)/" |
Remember
user_code, user_key and app_key are generic credentials, make sure to request your own for TEST and PROD environemnts.
Comments
This endpoint creates a new manifest.
The command should be run as in the following example:
{
"user_info":
{
"user_code":1,
"user_key":"ok",
"app_key":"ok"
},
"bag_pre_manifest_info":
{
"bag_pre_manifest_header":
{
"copa_id":616,
"master_awb":"1234567894",
"departure_point":
{
"country_iso_code":"US",
"iata_code":"MIA",
"gateway_type":1
},
"entry_point":
{
"country_iso_code":"MX",
"iata_code":"MEX",
"gateway_type":1
},
"via_hub" :
{
"country_iso_code" : "US",
"iata_code" : "MIA",
"gateway_type" : 1
},
"options":
{
"import_service_type":"DDP",
"clearance_value_type":"NV",
"service_type":"IX"
},
"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"
}
]
},
"bag_pre_manifest_detail":
[
{
"bag_id":123433
},
{
"bag_id":223443
}
]
}
}The command will return the following format:
[
{
"_verify": true,
"error": {
"error_description": "",
"error_location": "",
"system_error": false
},
"manifest_id": 12387469,
"manifest_status": "processing",
"master_airwaybill": "MASTER123456789",
"provider_manifest_info": {
"pvd_manifest_doc_pdf_url": null,
"pvd_manifest_doc_url": null,
"pvd_manifest_id": null,
"pvd_manifest_status": "processing"
}
}
]