Get Rates

This method is used to check pricing for parcel orders from all allowed providers. The method also automatically creates an order that isn't visible from the dashboard

The request accepts an optional carrier query param if preferred, it can be used like: https://system.deftship.com/api/parcel-orders/get-rates?carrier=ups. Selecting a specific carrier can significantly reduce the response time for rates.

Please note that this end-point has rate-limiting, therefore, it will only allow 60 requests per minute.

Available carriers are [Carriers are only available to registered users]

• Endpoint
• Request
• Request Example
• Response
• Response Example
• Parcel Box Types

Endpoint

Request

Request Example

{
    "from_address": {
        "name": "Example Corp",
        "attention": "John Doe",
        "city": "Los Angeles",
        "street_1": "123 S Main St",
        "zip": "90012",
        "state": "CA",
        "country": "US",
        "telephone": "9999999999"
    },
    "to_address": {
        "name": "Example Corp",
        "attention": "John Doe",
        "city": "Flushing",
        "street_1": "123 Main St",
        "zip": "11354",
        "state": "NY",
        "country": "US",
        "telephone": "9999999999"
    },
    "package_list": [
        {
            "length": 5,
            "width": 4,
            "count": 3,
            "weight": 2,
            "height": 1,
            "insurance": false,
            "signature": "no_signature",
            "items": [
                {
                    "quantity": 1,
                    "price": 12.5,
                    "sku": "SKU",
                    "hs_code": "620342",
                    "description": "Fryer",
                    "content_type": "Merchandise"
                }
            ]
        }
    ],
    "extra_services": {
        "saturday_delivery": false,
        "certified_mail": false,
        "return_receipt": false,
        "return_receipt_electronic": false,
        "restricted_delivery": false
    }
}

Response

Response Examples

Successful

{
    "success": true,
    "data": [
        {
            "id": 12345678,
            "carrier": "fedex",
            "service": "Fedex Ground",
            "service_code": "FEDEX-1",
            "final_price": "45.72",
            "fuel_price": "2.59",
            "restrictions": [],
            "miscellaneous_charges": [],
            "has_enough_credits": true,
            "eta": "3"
        },
        {
            "id": 12345678,
            "carrier": "ups",
            "service": "UPS 3 Day Select",
            "service_code": "UPS-8",
            "final_price": "80.33",
            "fuel_price": "4.55",
            "restrictions": [],
            "miscellaneous_charges": [],
            "has_enough_credits": true,
            "eta": null
        }
    ]
}

Failed

{
    "success": false,
    "message": "The given data was invalid.",
    "data": {
        "to_address.city": [
            "The to address.city field is required."
        ]
    }
}

Parcel Box Types