Pick Up

Request Pick Up

This endpoint schedules a pick up from a domestic provider.

URL

PROD https://api.skypostal.com/

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

Endpoint

POST /wcf-services/service-shipment.svc/shipment/request-pick-up

Request Credentials

Parameters
`user_info`	Object - Required User Info Definition.
`pick_up_info`	Object - Required Pick Up Info Definition.

Parameters

user_info

Object - Required

User Info Definition.

pick_up_info

Object - Required

Pick Up 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.

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.

Pick Up Info Definition

Parameters
`copa_id`	Integer - Required Client identificator provided by Skypostal.
`reference_number`	String - Required Reference number of package. Letters, numbers, hyphen "-" and underscore "_" allowed.
`merchant_name`	String - Required Commercial Partner name set by Skypostal.
`contact_name`	String - Required Contact Name.
`address`	Object - Required Address Definition.
`phone`	Object - Required Phone Definition.
`date_time`	Object - Required Date Time Definition.
`options`	Object - Required Options Definition.
`additional_info`	Object - Required Additional Info Definition.
`items`	List of Objects - Required Items Definition, up to 30 items.

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

Address Definition

Parameters
`country_iso_code`	String - Required 2 characters iso code. (e.g. BR, MX, US, etc.)
`country_name`	String Name of the country.
`state_name`	String Name of the state.
`state_abbreviation`	String - Required Abbreviation of the state.
`city_name`	String - Required Name of the city.
`zip_code`	String - Required Send a valid zipcode.
`neighborhood`	String Address neighborhood.
`address_01`	String - Required Streets, home number, etc.

Phone Definition

Parameters
`phone_number`	String - Required Phone Number.
`phone_extension`	String Phone Extension.

Parameters

phone_number

String - Required

Phone Number.

phone_extension

String

Phone Extension.

Date Time Definition

Parameters
`date_to_schedule`	String - Required Date To Schedule. Format yyyy-mm-dd.
`from_time`	String - Required From Time. Format HH:mm.
`to_time`	String - Required To Time. Format HH:mm.

Parameters

date_to_schedule

String - Required

Date To Schedule. Format yyyy-mm-dd.

from_time

String - Required

From Time. Format HH:mm.

to_time

String - Required

To Time. Format HH:mm.

Options Definition

Parameters
`pick_up_service_code`	Integer - Required Pick Up Service Code Definition.

Parameters

pick_up_service_code

Integer - Required

Pick Up Service Code Definition.

Value	Description
1	Standard pick up service (US Only).

Additional Info Definition

Parameters
`special_instructions`	String Special handling instruction from the customer.
`notification_email`	String - Required Notification Email.

Parameters

special_instructions

String

Special handling instruction from the customer.

notification_email

String - Required

Notification Email.

Items Definition

Parameters
`tracking_number`	String - Required Any number that is linked to the package. It can be: SkyPostal’s number , Client’s number or Label's number/barcode

Parameters

tracking_number

String - Required

Any number that is linked to the package. It can be: SkyPostal’s number , Client’s number or Label's number/barcode

The command should be run as in the following example:

{
    "user_info": {
        "user_code": -1,
        "user_key": "xxx",
        "app_key": "xxxx"
    },
    "pick_up_info": {
        "copa_id": 000,
        "reference_number":"20220909PICKUPREF001",
        "merchant_name":"the merchant",
        "contact_name":"John Doe",
        "address":{
            "country_code": 0,
            "country_iso_code": "US",
            "country_name": "United States",
            "state_name": "",
            "state_abbreviation": "FL",
            "city_name": "Doral",
            "zip_code": "33126",
            "neighborhood": null,
            "address_01": "7808 NW 15 Street"
        },
        "phone":{
            "phone_number": "3055991812",
            "phone_extension":""
        },
        "date_time":{
            "date_to_schedule":"2022-01-01",
            "from_time":"05:00",
            "to_time":"14:00"
        },
        "options":{
            "pick_up_service_code":1
        },
        "additional_info": {
            "special_instructions":"Special handling instruction from the customer up to 57chars",
            "notification_email":"notifications@merchant.com"
        },
        "items":[
            {
                "tracking_number":"track_num01"
            },
                        {
                "tracking_number":"ext_track_02"
            },
                        {
                "tracking_number":"order_number_03"
            },
                        {
                "tracking_number":"label_04"
            },
                        {
                "tracking_number":"awb_05"
            }
        ]
    }
}

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":"SCHEDULED"
    },
    "error": {
        "error_code": null,
        "error_description": null,
        "error_location": null,
        "system_error": false
    }
}