Get Parcel Types

The operation fetches Parcel Types based on the provided carrier, origin county, and the destination country. If query parameters are not provided, this will default to USPS as carrier, US as both origin and destination country code.

SecuritybearerAuth

Request

query Parameters

carrier	string The CarrierID, a unique identifier given to an individual carrier. It can be referred from the response of Get Carriers API
originCountryCode	string The Source Country. The two-character ISO country code for the country where the Shipment originates.
destinationCountryCode	string The Destination Country for the Shipment. The two-character ISO country code for the country where the shipment is to be delivered.

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.

Responses

200

A list of Parcel Types has been fetched.

400

Invalid request.

401

The request could not be authorized.

500

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

get/api/v1/parcelTypes

Request samples

Response samples

application/json

{"parcels": [{"brandedName": "Box 1092",
"carrier": "USPS",
"groupName": "Specialty Boxes and Envelopes",
"brandedDimensions": {"girth": 0,
"length": 12.25,
"width": 2.875,
"height": 13.6875,
"unitOfMeasurement": "IN"
},
"parcelId": "B1092",
"isBranded": true,
"parcelType": "LP",
"serviceId": "PM",
"weightRules": [{"maxWeight": 1120,
"minWeight": 0.01,
"required": true,
"unitOfMeasurement": "OZ"
}
]
},
{"brandedName": "My Box",
"dimensionRules": [{"maxLengthPlusGirth": 130,
"maxParcelDimensions": {"length": 120,
"width": 38,
"height": 41,
"unitOfMeasurement": "IN"
},
"minParcelDimensions": {"length": 0.001,
"width": 0.001,
"height": 0.001,
"unitOfMeasurement": "IN"
},
"required": true,
"unitOfMeasurement": "IN"
}
],
"groupName": "My Packaging",
"parcelId": "PKG",
"isBranded": false,
"parcelType": "PKG",
"suggestedTrackableSpecialserviceId": "Sig",
"weightRules": [{"maxWeight": 1120,
"minWeight": 0.01,
"required": true,
"unitOfMeasurement": "OZ"
}
]
}
]
}