Manifest
Get Bag Created
This service returns the complete information of a created bag.
URL
PROD https://api.skypostal.com/
TEST https://api-test.skypostal.com/
Endpoint
POST wcf-services/service-bags.svc/bags/get-bag-created
Request Credentials
Parameters | |
---|---|
| Object - Required User Info Definition. |
| String - Required Reference for the bag. |
| Integer - Required Commercial Partner Number (Provided by Skypostal). |
| String Bag Image format. Available options: "PDF" and "PNG". |
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. |
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
The command should be run as in the following example:
{
"user_info": {
"user_code": ###,
"user_key": "********",
"app_key": "**********"
},
"bag_reference":"CLIENTBAGREFERENCE",
"copa_id":0,
"bag_image_format":""
}
The command will return the following format:
{
"additional_info": {
"internal": [],
"server": {
"server_id": ".185",
"server_time": 0.4843713
}
},
"data": {
"_verify": true,
"bag_detail_info": [
{
"bag_detail_id": 3534504,
"bag_detail_status_code": 4,
"bag_detail_status_description": "PROCESSED",
"content": "(1 items) SUPPORTING BAR",
"date_added_in_bag": "/Date(1706642300000-0500)/",
"dim_01": 4.33,
"dim_02": 6.3,
"dim_03": 0.79,
"dim_unit": "pl",
"fmpr_cdg": "AYB",
"merchandise_value": 13,
"mnit_nmr_bag": 828509,
"order_label": "SP003####3CO",
"scanned_number": "EXTRTRACK001",
"trck_nmr_fol": 260228892,
"usrs_cdg": "root",
"weight_kg": 0.963022,
"weight_lb": 2.1231
},
{
"bag_detail_id": 3534506,
"bag_detail_status_code": 4,
"bag_detail_status_description": "PROCESSED",
"content": "(1 items) CAR WIPERS",
"date_added_in_bag": "/Date(1706642300000-0500)/",
"dim_01": 4.33,
"dim_02": 6.3,
"dim_03": 0.79,
"dim_unit": "pl",
"fmpr_cdg": "OTR",
"merchandise_value": 15,
"mnit_nmr_bag": 828509,
"order_label": "SP003118304CO",
"scanned_number": "EXTRTRACK002",
"trck_nmr_fol": 260367883,
"usrs_cdg": "root",
"weight_kg": 0.422022,
"weight_lb": 0.9304
}
],
"bag_header_info": {
"bag_add_param": "",
"bag_client_reference": "HAIAEJHFA00001",
"bag_header_status_code": 4,
"bag_header_status_description": "MANIFESTED",
"bag_mnfs_id": 12435754,
"bag_scan_source_code": 1,
"bag_sorting": "",
"bag_total_items": 5,
"bag_total_value": 195.56,
"bag_total_weight_kg": 5.806,
"bags_label_image": null,
"bags_number": "HAIAEJHFA00001",
"bags_pre_mnfs_status": 5,
"bags_type": 1,
"bags_zpl": "XlhBflRBMDAwfkpTTl5MVDBeTU5XXk1URF5QT05...",
"bags_zpl_large": "XlhBDQpeTU1UDQpeUFc4MzENCl5MTDE3...",
"clearance_value": "NV",
"copa_id": 00,
"departure_ctry_iso": "US",
"departure_gateway": "MIA",
"destination_ctry_iso": "CO",
"destination_gateway": "BOG",
"import_service_type": "DDP",
"mnit_nmr_bag": 1000,
"pvd_reference": "1000"
},
"error": {
"error_code": "",
"error_description": "",
"error_location": "",
"system_error": false
}
}
}