Sign in
Proxy

Fetch shipment rates

The Shipping process begins by fetching rates for your shipment. Use this service to fetch a shipping rates available.

post/v1/proxy/rates

Request body

servicesstring[] nullable

The requested carrier service for the shipment.<br/> Please consult the reference for specific carriers services.<br/> Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier.

optionsobject
<details> <summary>The options available for the shipment.</summary> 
    {
        "currency": "USD",
        "insurance": 100.00,
        "cash_on_delivery": 30.00,
        "dangerous_good": true,
        "declared_value": 150.00,
        "sms_notification": true,
        "email_notification": true,
        "email_notification_to": "shipper@mail.com",
        "hold_at_location": true,
        "paperless_trade": true,
        "preferred_service": "fedex_express_saver",
        "shipment_date": "2020-01-01",  # TODO: deprecate
        "shipping_date": "2020-01-01T00:00",
        "shipment_note": "This is a shipment note",
        "signature_confirmation": true,
        "saturday_delivery": true,
        "is_return": true,
        "doc_files": [
            {
                "doc_type": "commercial_invoice",
                "doc_file": "base64 encoded file",
                "doc_name": "commercial_invoice.pdf",
                "doc_format": "pdf",
            }
        ],
        "doc_references": [
            {
                "doc_id": "123456789",
                "doc_type": "commercial_invoice",
            }
        ],
    }
    </details>
referencestring nullable

The shipment reference

carrier_idsstring[] nullable

The list of configured carriers you wish to get rates from.

Response

Changes

No recorded changes to this endpoint across all 1 revision of this API.