Rate Shipment

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

SecuritybearerAuth
Request
header Parameters
X-PB-LocationId
string

The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed. If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing.

Requirement Rules

  • The X-PB-LocationId header is optional when the shipment origin country code matches the enterprise's default address country code.
  • The X-PB-LocationId header is required when the shipment origin country code differs from the enterprise's default address country code.
  • If the header is required but not provided, the API will return a validation error "invalid origin countryCode".
Request Body schema: application/json
One of:
object (fromAddressV2)

The complete address of the Sender. Read: How to create Defaults. The fromAddress is selected using the following order of precedence:

Request Body → Default ID → Location ID

  • fromAddress provided in the request payload is used if available.
  • If not available in request payload, The Default ID (fromAddress defined in Default API) is used.
  • If provided neither in the request nor in the default, the fromAddress associated with the resolved location is used.
  • If fromAddress cannot be resolved from any source, the request fails with a validation error.

Note: fromAddress is required.

required
object (toAddressV2)

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

required
object (parcelV2)

The details of the Parcel.

object (SpecialService)
parcelType
required
string

Parcel type for a single-parcel request.

rateShopBy
required
string

RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by ShipViaCode.
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.

Enum: "carrier" "rateGroup" "ruleSet"
object

Specifies the carrier and service configuration used for rate retrieval in Rate Shipment V2 This object enables the following use cases:

  1. Rate Shop for a Single Carrier: Provide either carrier or carrierAccountId to retrieve all available rates from the specified carrier.
  2. Single Rate Retrieval by Service ID: Provide both carrier (or carrierAccountId) and service to retrieve a single rate corresponding to the specified service.
  3. Rate Shop Across Carriers: Omit this object to retrieve rates from all carriers available under the current subscription.
object

There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy.
In case if the customer's scheduled deliverBy date falls under Holiday, then useBestNextDate will be used by our system. Then, we will mark the second option and deliver the same.

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": {
    },
  • "specialServices": {
    },
  • "parcelType": "PKG",
  • "rateShopBy": "carrier",
  • "byCarrier": {
    },
  • "deliveryOption": {
    }
}
Response samples
application/json
{
  • "parcel": {
    },
  • "rate": [
    ],
  • "fromAddress": {
    },
  • "toAddress": {
    },
  • "shipmentOptions": { },
  • "references": { }
}