Schedule a meeting

Shipment

Update Shipment Weight and Dims

This endpoint updates weight and dims.

URL

PROD https://api.skypostal.com/

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

Endpoint

POST /wcf-services/service-shipment.svc/shipment/update-shipment-weight-dims

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.

weight_info

Object - Optional, Send this if you want to update the weight

Weight Definition.

dims_info

Object - Optional, Send this if you want to update the dims

Dims Definition.

Weight Info Definition

Parameters

weight

Double - Required

New weight of the package.

weight_unit

String - Required

Can be kg = kilograms, lb = pounds

Dims Info Definition

Parameters

dim_01

Double - Required

New dim 1 (height) of the package.

dim_02

Double - Required

New dim 1 (length) of the package.

dim_03

Double - Required

New dim 1 (width) of the package.

dim_unit

String - Required

Can be cm = centimeters, pl = inches, in = inches

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": "external-tracking-number",
  "order_label": "order-label-number",
  "copa_id": 616,
  "weight_info": {
    "weight": 13.45,
    "weight_unit": "lb"
  },
  "dims_info": {
    "dim_01": 10.96,
    "dim_02": 16.75,
    "dim_03": 21.102,
    "dim_unit": "cm"
  }
}

The command will return the following format:

{
  "additional_info": {
    "internal": [],
    "server": {
      "server_id": null,
      "server_time": 3.20
    }
  },
  "data": [
    {
      "_verify": true,
      "additional_info": null,
      "error": {
        "error_description": "",
        "error_location": "",
        "system_error": false
      },
      "updated_rows": 1
    }
  ],
  "error": null
}