Unique shipment reference number generated by Easyship. This reference number will be used to buy the label, request a pickup and track the shipment.
destination_name
Receiver's full name
destination_address_line_1
Receiver's address line 1
destination_address_line_2
Receiver's address line 2
destination_city
Destination city
destination_state
Destination state
destination_postal_code
Destination postal code
destination_phone_number
Receiver's phone number
destination_email_address
Receiver's email address
platform_name
Name of sales platform where the shipment order was made
platform_order_number
Order number on the sales platform. This number can be used to track the associated shipment
total_customs_value
Total declared customs value of the shipment
total_actual_weight
Total actual weight of the shipment (in kg)
total_dimensional_weight
Total dimensional weight of the shipment (in kg)
total_volumetric_weight
Total volumetric weight of the shipment (in kg)
is_insured
Boolean. Shipment is/is not insured
currency
Currency for all amount-related fields (currency of the shipment's origin country)
label_state
State of the shipment label (not_created, pending, failed, generated)
label_url
Link to retrieve the shipment's label and additional shipping documents (will only be available once the label is generated)
tracking_number
Shipment tracking number provided by the courier (will only be available once the label is generated)
tracking_page_url
Link to the tracking page where the receiver can track the status of his/her shipment (will only be available once the label is generated)
origin_country / destination_country
-- name
Name of country
-- alpha2
Country ISO 3166-1 alpha-2 code
items
-- id
Unique ID associated with the shipment item
-- description
Item's description
-- sku
Item's Stock Keeping Unit (SKU) as listed in your catalog
-- width
Item's width (in cm)
-- length
Item's length (in cm)
-- height
Item's height (in cm)
-- actual_weight
Item's actual weight (in kg)
-- dimensional_weight
Item's dimensional weight (in kg)
-- volumetric_weight
Item's volumentric weight (in kg)
-- declared_customs_value
Item's declared customs value
-- declared_currency
Item's declared customs value currency
-- origin_customs_value
Item's origin customs value (converted into the origin country's currency)
-- origin_currency
Shipment's origin country's currency
-- category
Item's category
box
The optimal box calculated for the items
-- name
Box name, if a box from your pre-set list of boxes has been selected. Will be null otherwise
-- length
Box length (cm)
-- width
Box width (cm)
-- height
Box height (cm)
selected_courier
-- id
Unique ID associated with the selected courier
-- name
Name of the selected courier
-- min_delivery_time
Minimum number of business days the delivery is expected to take
-- max_delivery_time
Maximum number of business days the delivery is expected to take
-- shipment_charge
Cost of shipping
-- fuel_surcharge
Fuel surcharge applied by the courier
-- remote_area_surcharge
Remote area surcharge. Applies if the shipment's destination is considered a remote area by the courier.
-- shipment_charge_total
Total cost of shipping (including fuel surcharge and remote area surcharge)
-- warehouse_handling_fee
Pick and pack fee charged by the fulfilment warehouse (for e-fulfilment only)
-- insurance_fee
Insurance fee, if the shipment is insured
-- import_tax_charge
Import tax charge. Varies by country. Applies if the shipment is above threshold and the effective incoterm is DDP.
-- import_duty_charge
Import duty charge. Varies by country and item category. Applies if the shipment is above threshold and the effective incoterm is DDP.
-- ddp_handling_fee
Handling fee charged by the courier, if the shipment's effective incoterm is DDP
-- total_charge
Total cost of the shipment (including shipping and insurance fees, import tax & duty charges and handling fees)
-- is_above_threshold
Boolean. Shipment is/is not above the destination country's threshold value. If above threshold, import taxes and duties will apply.
-- effective_incoterms
Selected incoterm for the shipment DDP: Delivered Duty Paid DDU: Delivered Duty Unpaid
-- estimated_import_tax
Estimated import tax charge. Provided only for reference if the effective incoterm is DDU. Note that the consignee may also be charged additional handling fees by the last mile courier.
-- estimated_import_duty
Estimated import duty charge. Provided only for reference if the effective incoterm is DDU. Note that the consignee may also be charged additional handling fees by the last mile courier.
-- courier_does_pickup
Courier does/does not offer a free pick-up service
-- courier_dropoff_url
Link to drop off information (including location, hours and contact details), if the courier only offers drop off service
-- courier_remarks
Additional remarks about the shipping option, if applicable, regarding potential additional charges, packaging requirements, etc.
-- payment_recipient
Recipient of the payment when the shipment is paid for Easyship: pre-paid label Courier: post-paid label to be paid at the counter
