Multipiece Rates

The operation is used for rateshop and to get specific rate based on serviceId for Multipiece.

SecuritybearerAuth

Request

query Parameters

includeDeliveryCommitment

string

Default: true

When set to true (default), the response includes delivery commitment information. Set to false to exclude delivery commitment details from the response.

header Parameters

X-PB-Developer-Partner-Id

string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

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 Details of the sender's address.
	Array of objects Details of each parcel within the multi-piece shipment.
carrierAccounts	Array of strings A list of identifiers for the carrier accounts used for shipping.
	object Details of the recipient's address.

Responses

200

The Multipiece Rates created 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/v1/multipiece/rates

Request samples

application/json

{"fromAddress": {"addressLine1": "27 Waterview Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Shelton",
"stateProvince": "CT",
"postalCode": "06484-4301",
"countryCode": "US",
"company": "ABC Company",
"name": "Sasha Sekrotov",
"phone": "323 555-1212",
"email": "rs.canid@gmail.com",
"residential": true
},
"multiPieceParcels": [{"parcelType": "PACK",
"parcel": {"weightUnit": "OZ",
"weight": 16,
"dimUnit": "IN",
"length": 10,
"width": 10,
"height": 0.5
}
}
],
"carrierAccounts": ["fsduygqy6"
],
"toAddress": {"company": "Pitney Bowes Inc.",
"name": "sender_fname",
"phone": "2032032033",
"email": "sender@email.com",
"residential": true,
"addressLine1": "27 Waterview Drive",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Shelton",
"stateProvince": "CT",
"postalCode": "06484-4301",
"countryCode": "US"
}
}

Response samples

application/json

{"fromAddress": {"addressLine1": "27 Waterview Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Shelton",
"stateProvince": "CT",
"postalCode": "06484-4301",
"countryCode": "US",
"company": "ABC Company",
"name": "Sasha Sekrotov",
"phone": "323 555-1212",
"email": "rs.canid@gmail.com",
"residential": true
},
"toAddress": {"company": "Pitney Bowes Inc.",
"name": "user_name",
"phone": 2032032033,
"email": "sender@email.com",
"residential": true,
"addressLine1": "27 Waterview Drive",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Shelton",
"stateProvince": "CT",
"postalCode": "06484-4301",
"countryCode": "US"
},
"serviceId": "NDA",
"rates": [{"totalCarrierCharge": 172.68,
"carrier": "UPS",
"currencyCode": "USD",
"deliveryCommitment": {"additionalDetails": "By end of Day",
"estimatedDeliveryDateTime": "2024-12-18 18:00:00.000",
"guarantee": "NONE",
"maxEstimatedNumberOfDays": "3",
"minEstimatedNumberOfDays": "3"
},
"rateTypeId": "COMMERCIAL",
"serviceId": "NDA",
"multiPieceParcels": [{"parcelType": "PKG",
"parcel": {"length": 10,
"height": 10,
"width": 10,
"dimUnit": "IN",
"weightUnit": "OZ",
"weight": 16
},
"parcelRate": {"baseCharge": 145.36,
"surcharges": [{"fee": null,
"name": null
}
]
}
}
],
"surcharges": [{"fee": 5.65,
"name": "RESIDENTIAL"
}
],
"publishedTotalCarrierCharge": 73.12
}
],
"errors": [{"code": "validation_error",
"message": "error while getting rates for carrier with carrierAccount eRMnRx4mzPP : "
}
]
}