Skip to content

Get Parcel Types

Request

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.

Security
bearerAuth
Query
carrierstring

The CarrierID, a unique identifier given to an individual carrier. It can be referred from the response of Get Carriers API

originCountryCodestring

The Source Country. The two-character ISO country code for the country where the Shipment originates.

destinationCountryCodestring

The Destination Country for the Shipment. The two-character ISO country code for the country where the shipment is to be delivered.

Headers
X-PB-Developer-Partner-Idstring

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

curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/parcelTypes?carrier=string&originCountryCode=string&destinationCountryCode=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-Id: string'

Responses

A list of Parcel Types has been fetched.

Headers
X-PB-TransactionIdstring

A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.

Bodyapplication/json
parcelsArray of objects
Response
{ "parcels": [ { "brandedName": "Box 1092", "carrier": "USPS", "groupName": "Specialty Boxes and Envelopes", "brandedDimensions": {}, "parcelId": "B1092", "isBranded": true, "parcelType": "LP", "serviceId": "PM", "weightRules": [] }, { "brandedName": "My Box", "dimensionRules": [], "groupName": "My Packaging", "parcelId": "PKG", "isBranded": false, "parcelType": "PKG", "suggestedTrackableSpecialserviceId": "Sig", "weightRules": [] } ] }