equest Type: 

GET 

API Endpoint:

<url>/api/shipping

Mandatory Parameters:

• Tretailer_id: Your account ID (provided separately).
• method (type: string) – The calculation method (value: 1 for weight / 3 for cube)
  1. 1 – weight (type: number) – the total weight of the order in pounds.
  2. 3 – cubes (type: number) – the total cube of the order in cb. ft.
• zip (type: string) – The delivery zip-code, 5 digits.
• pickup_region (type: string) – The zip-code (or state) where the order is originated, or FOB.
  1. FOB – freight is provided by the shipper, Deliveright handle last-mile only.
  2. Zip-code: Any 5 digit zip-code
• service_level (type: string) – The requested service level code for this delivery

Optional Parameters:

• floor (type: number) – The delivery floor number (default: 1)
• elevator (type: number) – whether the recipient residence has an elevator (default: 1)
  • 0 – Elevator doesn’t not exist
  • 1 – Elevator exists
• carrier (default: 0) – if value == 1, will return the designated carrier and contact information for this route.
• item_weight (type: array) – Array of item’s weights
• Insurance (default:0) – If value is == 1, the insurance cost would be added as part of the accessorial charges.
  • A ‘covered_value’ should be passed along for the same request

Shipping Calculation Methods:

• 1 – Weight
• 3 – Cube

Sample Request

Using zip-code as pickup region, no optional values:

<url>/api/shipping?retailer_identifier=[IDENTIFIER]&method=1&zip=07002&weight=400&service_level=wg&pickup_region=30021

Using State code as pickup region with optional values:

<url>?retailer_identifier=[IDENTIFIER]&method=1&zip=07002&weight=400&service_level=wg&pickup_region=30021&floor=6&elevator=1&item_weight=120&item_weight=240&item_weight=334&item_weight=400&carrier=1

Cube quote:

<url>?retailer_identifier=[IDENTIFIER]&method=3&zip=07002&cubes=400&service_level=wg&pickup_region=27295

Using Insurance coverage as optional values:

<url>?retailer_identifier=[IDENTIFIER]&method=1&zip=07002&weight=400&service_level=wg&pickup_region=30021&floor=6&elevator=1&insurance=1&covered_value=4500

Response

{

    "status": "ok",

    "data": {

        "cost": 360.00,

        "message": "",

        "errorCode": 0,

        "last_mile_terminal": {

            "name": "Deliveright - NJ",

            "address": {

                "address1": "1000 Jefferson Avenue",

                "address2": "",

                "city": "Elizabeth",

                "state": "NJ",

                "zip": "07201",

                "timezone": null,

                "latitude": 40.6851354,

                "longitude": -74.20126119999999

            }

        },

        "accessorial_fees": {

            "third_man_cost": 160,

            "fuel_surcharge": {

                "cost": 48.74,

                "success": true,

                "rate": 13.38

            },

            "insurance_cost": {

                "success": true,

                "cost": 56.30,

                "requested_coverage": 1500,

                "built_in_coverage": 249.75,

                "approved_coverage": 249.75

            }

        },

        "fsc": true,

        "qid": "5CD6A5E",

        "carrier": {

            "name": "Deliveright - SoCal [Genesis BWS]",

            "dispatch": [

                {

                    "name": "Andres Aristizabal",

                    "email": "andres@genesisbws.com",

                    "phone": "9094810646"

                },

                {

                    "name": "Jonathan Portillo",

                    "email": "dispatch@genesisbws.com",

                    "phone": "9094810646"

                },

                {

                    "name": "Pickup @ Deliveright",

                    "email": "pickup@deliveright.com",

                    "phone": null

                }

            ]

        }

    }

}

Response Codes: 

• 200 – success
• 400 – Missing field value (error message: “Zip-code was not provided” or “Service level is not provided”) or invalid value provided
• 503 – service unavailable.