Bag
Remove Items From Closed Bags
This endpoint allows removing shipments from a closed bag.
URL
PROD https://api.skypostal.com/
TEST https://api-test.skypostal.com/
Endpoint
POST wcf-services/service-bags.svc/bags/remove-items-from-closed-bag
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 removed. |
| 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": 0000,
"from_bag_id": 802283,
"items": [
{
"external_tracking": "SP08100000073CO"
}
]
}
}The command will return the following format:
{
"_verify": false,
"additional_info": {
"internal": [],
"server": {
"server_id": ".20",
"server_time": 2.9218778
}
},
"bag_adjustment": [
{
"_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": "",
"system_error": false
},
"provider_bag_info": {
"provider_bag_label_image": null,
"provider_bag_label_zpl": "XlhBflRBMDAwfkpTTl5MV***gA=",
"provider_bag_label_zpl_large": "XlhBDQpeTU1UDQ****DQo=",
"provider_bag_number": "EXBAGLBLTST01"
}
}
],
"bag_adjustment_detail": [
{
"removed_ok": true,
"tracking_number": "SP08100000073CO"
}
],
"error": {
"error_code": "",
"error_description": "",
"error_location": "",
"system_error": true
}
}