Schedule a meeting

Shipment

Update Info Release Hold

This endpoint updates a shipment info and tries to solve the provider label rejected hold in order to generate a new valid label.

URL

PROD https://api.skypostal.com/

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

Endpoint

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

Request Credentials

Parameters

user_info

Object - Required

User Info Definition.

update_info

Object - Required

Update Info Definition.

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, copa_id and box_id are generic credentials, make sure to request your own for TEST and PROD environments

Update Info Definition

Parameters

tracking_number

String - Required

tracking_number from the package to which the invoice has to be associated.

copa_id

Integer - Required

Client identificator provided by Skypostal.

consignee_info

Object - Required

Consignee Info Definition.

item_info

Object - Required

Item Info Definition.

Consignee Info Definition

Parameters

first_name

String - Required

First Name.

last_name

String - Required

Last Name.

email

String - Required

Consignee Email.

id_number

String - Required (BR - CL)

Consignee's country Identificator.

address

Object - Required

Address Definition.

phone

List of Objects

List of Phones (Phone Definition).

Address Definition

Parameters

zip_code

String - Required (AU - BR - MX - US)

Send a valid zipcode.

address_01

String - Required

Streets, home number, etc.

Phone Definition

Parameters

phone_type

Integer - Required

Can be 1 = fixed telephony and 2 = cell phone.

phone_number

String - Required

Phone Number.

Item Info Definition

Parameters

hs_code

String - Required for packet and etoe services

Harmonized system code.

The command should be run as in the following example:

{
    "user_info": {
        "user_code": 0,
        "user_key": "user_key",
        "app_key": "app_key"
    },
    "update_info": {
        "tracking_number": "tracking_number_123",
        "copa_id": 616,
        "consignee_info": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "id_number": "12345678901",
            "address": {
                "zip_code": "12345678",
                "address_01": "street number and street name"
            },
            "phone": [
                {
                    "phone_type": 1,
                    "phone_number": "111111111"
                }
            ]
        },
        "item_info": {
            "hs_code": "002233"
        }
    }
}

The command will return the following format:

[
    {
        "_verify": true,
        "additional_info": {
            "internal": [],
            "server": {
                "server_id": ".133",
                "server_time": 0.2343838
            }
        },
        "error": [
            {
                "error_description": "",
                "error_location": "",
                "system_error": false
            }
        ],
        "label_image": null,
        "label_invoice_url": null,
        "label_tracking_number_01": null,
        "label_tracking_number_02": null,
        "label_tracking_number_03": null,
        "label_type": 1,
        "label_url": null,
        "label_url_pdf": null,
        "label_zpl": null,
        "trck_nmr_fol": 0
    }
]