These docs are for v1.0. Click to read the latest docs for v2024.09.
FieldsDescription
courier_idUnique ID associated with the courier
courier_nameName of 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
value_for_money_rankRank of the shipping option in terms of value for money compared to other shipping options
delivery_time_rankRank of the shipping option in terms of delivery time compared to other shipping options
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)
currencyCurrency for all cost-related fields above (currency of the origin country)
is_above_thresholdBoolean. Shipment is/is not above the destination country's threshold value. If above threshold, import taxes and duties will apply.
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
tracking_ratingRating of the courier service's tracking visibility
0: No Tracking
1: Limited
2: Average
3: Excellent
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
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)