Shipi Shipping Rates API Documentation

Endpoint

POST https://app.myshipi.com/rates_api/shipi_rates.php

Request

Headers

• Content-Type: application/json

Body (JSON)

{
    "platform": "<platform>",
    "products": [
        {
            "product_name": "MacBook",
            "product_quantity": "1",
            "price": "500.00",
            "width": 0,
            "height": 0,
            "depth": 0,
            "weight": 0,
            "product_id": "43"
        }
    ],
    "receiver_address": {
        "r_address_1": "test",
        "r_address_2": "",
        "r_city": "los nagels",
        "r_state": "CA",
        "r_zip": "90001",
        "r_country": "US"
    },
    "shop_id": "<get from Shipi>", 
    "sitekey": "<get from Shipi>", 
    "settings": {
        "currency": "USD"
    }
}

Response

Success Response (200 OK)

{
    "fedex": [
        [
            {
                "price": 349.99,
                "name": "FedEx International First®",
                "code": "INTERNATIONAL_FIRST",
                "currency": "USD",
                "edd": ""
            },
            {
                "price": 303.79,
                "name": "FedEx International Priority® Express",
                "code": "FEDEX_INTERNATIONAL_PRIORITY_EXPRESS",
                "currency": "USD",
                "edd": ""
            }
        ]
    ],
    "ups": [
        [
            {
                "price": 320.00,
                "name": "UPS Worldwide Express",
                "code": "UPS_WORLDWIDE_EXPRESS",
                "currency": "USD",
                "edd": ""
            },
            {
                "price": 275.00,
                "name": "UPS Worldwide Saver",
                "code": "UPS_WORLDWIDE_SAVER",
                "currency": "USD",
                "edd": "2 days"
            }
        ]
    ],
    "dhl": [
        [
            {
                "price": 310.50,
                "name": "DHL Express Worldwide",
                "code": "DHL_EXPRESS_WORLDWIDE",
                "currency": "USD",
                "edd": ""
            },
            {
                "price": 290.00,
                "name": "DHL Express 12:00",
                "code": "DHL_EXPRESS_1200",
                "currency": "USD",
                "edd": ""
            }
        ]
    ]
}

Error Response (400 Bad Request)

{
    "success": false,
    "error": "Invalid sitekey or shop_id."
}

Description

Shipi's shipping rates API fetches real-time shipping rates from multiple carriers based on the configured accounts in the Shipi system. The request includes product details, recipient address, and merchant credentials to retrieve the best available rates.

Notes

• Ensure that shop_id and sitekey are obtained from the Shipi dashboard.
• The weight and dimensions (width, height, depth, weight) should be provided in appropriate units for accurate rate calculations.
• The currency setting allows defining the currency for returned shipping rates.

Support

For any issues, please contact Shipi support at support@myshipi.com.