Rate Shipment

This operation generates rate Shop for a specified shipment without generating the labels.

SecuritybearerAuth
Request
Request Body schema: application/json
required
object

The complete address of the Sender.

required
object

The complete address of the Recipient or Department (in case if the address is not pointed to any individual recipient).

required
object

Parcel details, including dimensions and weight.

parcelType
required
string

Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection.
ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc.
Max length = 30 "

rateShopBy
required
string

RateShop, which is attached to an Enterprise or Location, is done through three approaches: by Carrier, by RateGroup, and by Ruleset.
Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done.
Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours).
Through Ruleset, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest. Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup.

required
object

The shipment is grouped by Carrier and their Service.

labelSize
required
string

Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size.

Enum: "DOC_8X11" "DOC_4X8" "DOC_4X6"
labelType
required
string

Type of label.

labelFormat
required
string

Defines the file/format in which the label is printed.

Enum: "PDF" "ZPL2" "PNG" "GIF"
Responses
200

Rate Shop has been generated successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v2/rates
Request samples
application/json
{
  • "fromAddress": {
    },
  • "toAddress": {
    },
  • "parcel": {
    },
  • "parcelType": "PKG",
  • "rateShopBy": "carrier",
  • "byCarrier": {
    },
  • "labelSize": "DOC_4X6",
  • "labelType": "SHIPPING_LABEL",
  • "labelFormat": "ZPL2"
}
Response samples
application/json
[
  • {
    }
]