How to Display Rates at Checkout

The Rates at Checkout (RaC) feature allows you to provide end customers with multiple shipping options before the order is placed. This feature can be easily integrated into your shopping website.

📘

This guide covers the Rates at Checkout feature API integration into your custom website.

To learn more about the Rates at Checkout integration workflow for e-commerce platforms with list of supported stores, refer to our Shipping Rates at Checkout Feature Help Centre article.

Endpoint description

The RaC feature is available via the Rates API and requires the Rate authorisation scope.

POST https://api.easyship.com/2023-01/rates

In request body, this API method requires the shipment details below.

1. Origin address is an origin address object. Use Addresses API to get the origin address object.
2. Destination address is an address object from the data provided by the end customer. To make sure the customer’s address is valid and correct, use our Address Validation feature.
3. Parcel details is a parcel object with the following required fields:
   • items — array of item objects describing items to be shipped. Item objects can be filled from scratch or assigned by product IDs in case you have pre-filled Products API
   • box — object with shipment packaging details. Box can be specified explicitly as a custom one or assigned by a slug from predefined options available via the Box API
   • total_actual_weight — total weight of a shipment in kilograms

In response, you will obtain the rates object containing an array of available couriers with their applicable shipment rates and additional data.

Courier rates are scored by Easyship and returned in ascending order by a total shipment charge and in descending order by best value for money. This array allows you to display the cheapest, fastest and best value for money options to your end customer.

International shipping

Depending on the shipment type and conditions, you can display different breakdown of costs at checkout for your end user. For international shipments, you may have the following duties payment options:

1. Delivered Duty Unpaid (DDU) where the buyer is responsible for paying any taxes, duties, or import fees on the shipment.
2. Delivered Duty Paid (DDP) where the seller is responsible for paying any taxes, duties, or import fees on the shipment.
   To learn more about DDP and DDU Incoterms, see our DDU vs. DDP: Understanding the Differences Help Centre article.
   DDP terms are different depending on whether your business uses the IOSS system or not.
3. Import One Stop Shop (IOSS) is an electronic portal in the European Union that businesses can use to pay any Import VAT on commercial goods shipped into the EU, under the value of €150,00 (euros).

To learn more about IOSS system and how it will affect you as an international shipper, see our What is IOSS Help Centre article.

Refer to our How to Calculate Taxes and Duties API guide to obtain an easy-to-understand taxes and duties price breakdown.

Below, you will find the request and response body schemas, as well as complete request and response examples.

Request body parameters

Response body parameters

Examples

Request body

{
    "origin_address": {
        "line_1": "55 Prospect St",
        "line_2": "Unit 401",
        "state": "NY",
        "city": "Sydney",
        "postal_code": "11201",
        "country_alpha2": "US"
    },
    "destination_address": {
        "line_1": "1 quai de Jemmapes",
        "line_2": "Porte A",
        "state": "CA",
        "city": "Paris",
        "postal_code": "75010",
        "country_alpha2": "FR"
        },
        "output_currency": "HKD"
    },
    "parcels": [
            "items": [
                {
                    "description": "Silk dress",
                    "category": "fashion",
                    "sku": "test01",
                    "quantity": 2,
                    "dimensions": {
                        "length": null,
                        "width": null,
                        "height": null
                    },
                    "actual_weight": 10,
                    "declared_currency": "USD",
                    "declared_customs_value": 20
                }
            ]
        }
    ]
}

Response body

{
    "status": "success",
    "rates": [
        {
            "courier_id": "a6d078fd-e662-40ce-9efe-84caaa639bf7",
            "courier_name": "USPS - First Class International",
            "min_delivery_time": 5,
            "max_delivery_time": 9,
            "value_for_money_rank": 1.0,
            "delivery_time_rank": 5.0,
            "currency": "HKD",
            "shipment_charge": 200.86,
            "fuel_surcharge": 0.0,
            "remote_area_surcharge": 0.0,
            "remote_area_surcharges": {},
            "other_surcharges": {},
            "oversized_surcharge": 0.0,
            "additional_services_surcharge": 0.0,
            "residential_full_fee": 0.0,
            "residential_discounted_fee": 0.0,
            "shipment_charge_total": 200.86,
            "warehouse_handling_fee": 0.0,
            "insurance_fee": 0.0,
            "sales_tax": 0.0,
            "provincial_sales_tax": 0.0,
            "ddp_handling_fee": 0.0,
            "import_tax_charge": 0.0,
            "import_tax_non_chargeable": 0.0,
            "import_duty_charge": 0.0,
            "total_charge": 200.86,
            "is_above_threshold": true,
            "incoterms": "DDU",
            "estimated_import_tax": 102.94,
            "estimated_import_duty": 0.0,
            "minimum_pickup_fee": 0.0,
            "available_handover_options": "dropoff,free_pickup",
            "tracking_rating": 1,
            "easyship_rating": 3.5,
            "courier_remarks": null,
            "payment_recipient": "Easyship",
            "discount": {
                "amount": 0,
                "code": null,
                "percentage": null,
                "expires_at": null,
                "origin_amount": 0
            },
            "description": "Estimated  102.94 tax & duty due on delivery (Tax handling fees may apply)",
            "full_description": "USPS - First Class International (5-9 working days) Estimated  102.94 tax & duty due on delivery (Tax handling fees may apply)"
        }

To learn more about the calculation process, refer to our How Shipping Rates Are Calculated at Checkout Help Center article.