Bag
Move Items Between Closed Bags
This endpoint allows moving shipments between closed bags.
URL
PROD https://api.skypostal.com/
TEST https://api-test.skypostal.com/
Endpoint
POST wcf-services/service-bags.svc/bags/move-items-between-closed-bags
Request Credentials
Parameters | |
---|---|
| Object - Required User Info Definition. |
| Object - Required Adjustment 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. |
Adjustment Info Definition
Parameters | |
---|---|
| Integer - Required Commercial Partner Number (Provided by Skypostal). |
| Integer - Required Bag id from which the shipments should be moved. |
| Integer - Required Bag id to which the shipments should be moved. |
| List of Objects - Required List of items (Item Definition). |
Item Definition
Parameters | |
---|---|
| String - Required Identifier of the shipment to manifest, can send label, awb, extr_tracking. |
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": {
"app_key": "xxxxxxxxxxxxxxxxxxxx",
"user_code": 000,
"user_key": "xxxxxxxxxxxxxxxxxxx"
},
"adjustment_info": {
"copa_id": 000,
"from_bag_id": 802283,
"to_bag_id": 802284,
"items": [
{
"external_tracking": "SP08100000073CO"
}
]
}
}
The command will return the following format:
{
"_verify": true,
"additional_info": {
"internal": [],
"server": {
"server_id": ".3",
"server_time": 4.375
}
},
"bag_adjustment": [
{
"_verify": true,
"bag_id": 802284,
"bag_sorting_code": "",
"bag_status": "CLOSED",
"bag_total_items": 2,
"bag_total_weight_kg": 2,
"client_bag_reference": "EXBAGLBLTST02",
"error": {
"error_code": "",
"error_description": "",
"error_location": ""
},
"provider_bag_info": {
"provider_bag_label_image": null,
"provider_bag_label_zpl": "XlhBflRBMDAwfkpTTlU5XXk1URF5QT05e***WgA=",
"provider_bag_label_zpl_large": "XlhBDQpeTU1U4MzENCl5MTDE3NT***LDAsMSxZXlhaDQo=",
"provider_bag_number": "EXBAGLBLTST02"
}
},
{
"_verify": true,
"bag_id": 802283,
"bag_sorting_code": "",
"bag_status": "CLOSED",
"bag_total_items": 2,
"bag_total_weight_kg": 2,
"client_bag_reference": "EXBAGLBLTST01",
"error": {
"error_code": "",
"error_description": "",
"error_location": ""
},
"provider_bag_info": {
"provider_bag_label_image": null,
"provider_bag_label_zpl": "XlhBflRBMDAwfkpTTl5MVDBeTRF5QT05eUE****lBRMSwwLDEsWV5YWgA=",
"provider_bag_label_zpl_large": "XU1UDQpeUFc4MzENCl5MTDE3NTg****UiwsWSxODQxSTg0KDQpeUFMSxZXlhaDQo=",
"provider_bag_number": "EXBAGLBLTST01"
}
}
],
"bag_adjustment_detail": [
{
"added_ok": true,
"moved_ok": true,
"removed_ok": true,
"tracking_number": "TEST-CO-api-304-t10"
}
],
"error": null
}