Get Special Services

Request

The operation fetches Special Services for a given carrier, service, origin country, and the destination country. If query parameters are not provided, it will default to USPS as carrier, US as both origin, and destination country and will show for all service and parcel types

Security

bearerAuth

Query

servicestring

The serviceId. It can be referred from response of Get Services API

parcelstring

The parcel Id, a unique identifier named to individual package. It can be referred from response of Get Parcel Types API

carrierstring

The CarrierID, a unique identifier given to an individual carrier. It can be referred from 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.

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/specialServices?service=string&parcel=string&carrier=string&originCountryCode=string&destinationCountryCode=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-Id: string'

Responses

The Special Service has been fetched successfully.

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

servicesArray of objects

Response

{
  "services": [
    {
      "serviceId": "LIB",
      "brandedName": "Library Mail®",
      "parcelTypeRules": [ … ]
    }
  ]
}