Return

user_info

Object - Required

User Info Definition.

shipment_return

Object - Required

Shipment Return Definition.

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.

copa_id

Integer - Required

Client identificator provided by Skypostal.

sra_copa_id

Integer

Save return as another client identificator, provided by Skypostal.

box_id

Integer

Box identificator by country provided by Skypostal.

merchant

Object

Merchant Definition.

sender

Object - Required

Sender Definition.

options

Object - Required

Options Definition.

data

Object - Required

Data Definition.

name

String - Required

Entity Name.

email

String

Entity Email.

address

String

Entity Address.

return_address

String

Entity Return Address.

phone

String

Entity Phones.

first_name

String - Required

First Name.

last_name

String - Required

Last Name.

email

String - Required

Consignee Email.

id_number

String

Sender's country Identificator.

address

Object - Required

Address Definition.

phone

List of Objects - Required

List of Phones (Phone Definition).

phone_type

Integer - Required

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

phone_number

String - Required

Phone Number.

include_label_zpl

Boolean - Required

Include label zpl.

zpl_label_dpi

Integer - Required

ZPL Label DPI Definition. Default value 203. You can choose 203 or 300.

zpl_encode_base64

Boolean - Required

Default value true. When true, the ZPL string will be encoded to a Base64 String.

include_label_image

Boolean - Required

Include label image.

include_label_image_format

String - Required if include label image = True

Include image format. Default value PNG. You can choose PNG or PDF.

external_tracking

String - Required

Identifier of the shipment to manifest, can send label, awb, extr_tracking.

reference_number_01

String

Reference number 01 of package.

reference_number_02

String

Reference number 02 of package.

reference_number_03

String

Reference number 03 of package.

dimension_01

Double - Required

Dimension 01 of package.

dimension_02

Double - Required

Dimension 02 of package.

dimension_03

Double - Required

Dimension 03 of package.

dimension_unit

String - Required

Can be IN = inches, CM = centimeters and M = Meters.

weight

Double - Required

Weight of package.

weight_unit

String - Required

Can be LB = pounds and KG = kilograms.

service_type

Object - Required

Service Type Definition.

items

List of Objects - Required

List of Items (Item Definition).

return_service_type

Integer - Required

Can be 1 = Drop Off, 2 = Pick Up.

return_service_data

Object - Required if return_service_type = 2

Return Service Data Definition.

address

Object - Required

Address Definition.

date_ranges

Object - Required

Data Ranges Definition.

country_code

Integer

Code of the country.

country_iso_code

String - Required

2 characters iso code. (e.g. BR, MX, US, etc.)

country_name

String

Name of the country.

state_code

Integer

Code of state.

state_name

String

Name of the state.

county_code

Integer

Code of the county.

county_name

String

Name of the county.

city_name

String - Required

Name of the city.

zip_code

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

Send a valid zipcode.

neighborhood

String

Address neighborhood.

address_01

String - Required

Streets, home number, etc.

address_02

String

Streets, home number, etc.

address_03

String

Streets, home number, etc.

start_date

String - Required

Datetime Definition.

end_date

String - Required

Datetime Definition.

hs_code

String - Required for packet and etoe services

Harmonized system code.

skucode

String

Skucode product.

image_url

String

URL of the image.

family_product

String

Family product.

serial_number

String

Product's serial number.

imei_number

String

Imei number (in case of cellphone).

description

String - Required

Description of package.

quantity

Integer - Required

Items quantity of package.

tax

Double

Tax of item.

value

Double - Required

Value of item.

currency_code

String - Required

Currency ISO code.

product_brand

String

Item Brand.

product_name

String

Item name.

product_model

String

Item model.

DateTime values are JSON string using the following format:

The content of the string is /Date(ticks)/ where ticks represents milliseconds since epoch (UTC). So November 29, 1989, 4:55:30 AM, in UTC is encoded as "/Date(1683749700000)/"