FieldsDescription
created_atDate and time the shipment was created
updated_atDate and time the shipment was last updated
easyship_shipment_idUnique shipment reference number generated by Easyship. This reference number will be used to buy the label, request a pickup and track the shipment.
destination_nameReceiver's full name
destination_address_line_1Receiver's address line 1
destination_address_line_2Receiver's address line 2
destination_cityDestination city
destination_stateDestination state
destination_postal_codeDestination postal code
destination_phone_numberReceiver's phone number
destination_email_addressReceiver's email address
platform_nameName of sales platform where the shipment order was made
platform_order_numberOrder number on the sales platform. This number can be used to track the associated shipment
total_customs_valueTotal declared customs value of the shipment
total_actual_weightTotal actual weight of the shipment (in kg)
total_dimensional_weightTotal dimensional weight of the shipment (in kg)
total_volumetric_weightTotal volumetric weight of the shipment (in kg)
is_insuredBoolean. Shipment is/is not insured
currencyCurrency for all amount-related fields (currency of the shipment's origin country)
label_stateState of the shipment label (not_created, pending, failed, generated)
label_urlLink to retrieve the shipment's label and additional shipping documents (will only be available once the label is generated)
tracking_numberShipment tracking number provided by the courier (will only be available once the label is generated)
tracking_page_urlLink 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
-- nameName of country
-- alpha2Country ISO 3166-1 alpha-2 code
items
-- idUnique ID associated with the shipment item
-- descriptionItem's description
-- skuItem's Stock Keeping Unit (SKU) as listed in your catalog
-- widthItem's width (in cm)
-- lengthItem's length (in cm)
-- heightItem's height (in cm)
-- actual_weightItem's actual weight (in kg)
-- dimensional_weightItem's dimensional weight (in kg)
-- volumetric_weightItem's volumentric weight (in kg)
-- declared_customs_valueItem's declared customs value
-- declared_currencyItem's declared customs value currency
-- origin_customs_valueItem's origin customs value (converted into the origin country's currency)
-- origin_currencyShipment's origin country's currency
-- categoryItem's category
boxThe optimal box calculated for the items
-- nameBox name, if a box from your pre-set list of boxes has been selected. Will be null otherwise
-- lengthBox length (cm)
-- widthBox width (cm)
-- heightBox height (cm)
selected_courier
-- idUnique ID associated with the selected courier
-- nameName of the selected courier
-- min_delivery_timeMinimum number of business days the delivery is expected to take
-- max_delivery_timeMaximum number of business days the delivery is expected to take
-- shipment_chargeCost of shipping
-- fuel_surchargeFuel surcharge applied by the courier
-- remote_area_surchargeRemote area surcharge. Applies if the shipment's destination is considered a remote area by the courier.
-- shipment_charge_totalTotal cost of shipping (including fuel surcharge and remote area surcharge)
-- warehouse_handling_feePick and pack fee charged by the fulfilment warehouse (for e-fulfilment only)
-- insurance_feeInsurance fee, if the shipment is insured
-- import_tax_chargeImport tax charge. Varies by country. Applies if the shipment is above threshold and the effective incoterm is DDP.
-- import_duty_chargeImport duty charge. Varies by country and item category. Applies if the shipment is above threshold and the effective incoterm is DDP.
-- ddp_handling_feeHandling fee charged by the courier, if the shipment's effective incoterm is DDP
-- total_chargeTotal cost of the shipment (including shipping and insurance fees, import tax & duty charges and handling fees)
-- is_above_thresholdBoolean. Shipment is/is not above the destination country's threshold value. If above threshold, import taxes and duties will apply.
-- effective_incotermsSelected incoterm for the shipment
DDP: Delivered Duty Paid
DDU: Delivered Duty Unpaid
-- estimated_import_taxEstimated 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_dutyEstimated 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_pickupCourier does/does not offer a free pick-up service
-- courier_dropoff_urlLink to drop off information (including location, hours and contact details), if the courier only offers drop off service
-- courier_remarksAdditional remarks about the shipping option, if applicable, regarding potential additional charges, packaging requirements, etc.
-- payment_recipientRecipient of the payment when the shipment is paid for
Easyship: pre-paid label
Courier: post-paid label to be paid at the counter
rates
all fields:Please check the Rate response