Cancel Pick Up
Cancel Request Pick Up
This endpoints is used to cancel a previously requested pick up.
URL
PROD https://api.skypostal.com/
TEST https://api-test.skypostal.com/
Endpoint
POST /wcf-services/service-shipment.svc/shipment/cancel-pick-up-request
Request Credentials
Parameters | |
|---|---|
| Object - Required User Info Definition. |
| Integer - Required Is the value returned from the request pick up service. |
| Integer - Required Client identificator provided by Skypostal. |
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": -1,
"user_key": "xxx",
"app_key": "xxxx"
},
"pick_up_code": 13,
"copa_id": 0
}The command will return the following format:
{
"_verify": true,
"additional_info": {
"internal": [],
"server": {
"server_id": ".3",
"server_time": 1.4283206
}
},
"data": {
"pick_up_code": 15,
"pvd_reference_number": "29Z94E916G7",
"total_items": 1,
"total_weight_kg": 0.16,
"pick_up_status":"CANCELLED"
},
"error": {
"error_code": null,
"error_description": null,
"error_location": null,
"system_error": false
}
}