Schedule a meeting

Shipment

Update shipment Info

This endpoint updates a shipment info.

URL

PROD https://api.skypostal.com/

TEST https://api-test.skypostal.com/

Endpoint

POST /wcf-services/service-shipment.svc/shipment/update-shipment-info

Request Credentials

Parameters

user_info

Object - Required

User Info Definition.

external_tracking

String - Required if order label is not sent

Client's package number sent when creating the package.

order_label

String - Required if external tracking is not sent

Label's printed number/barcode.

copa_id

Integer - Required

Client identificator provided by Skypostal.

consignee_id

String - Required

Consignee's country identificator number.

User Info Definition

Parameters

user_code

Integer - Required

This is the user code provided by Skypostal.

user_key

String - Required

This is the app key provided by Skypostal.

app_key

String - Required

This is the app key provided by Skypostal.

Remember

user_code, user_key, app_key and copa_id are generic credentials, make sure to request your own for TEST and PROD environemnts

The command should be run as in the following example:

{
  "user_info": {
    "user_code": 123123,
    "user_key": "ok",
    "app_key": "ok"
  },
  "external_tracking": "testbr-222",
  "order_label": "784919594274",
  "copa_id": 616,
  "consignee_id": "95942"
}

The command will return the following format:

{
  "data": [
    {
      "_verify": true,
      "updated_rows": 5,
      "additional_info": null,
      "error": null
    }
  ],
  "additional_info": null,
  "error": null
}