Get Special Services

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

SecuritybearerAuth

Request

query Parameters

service	string The serviceId. It can be referred from response of `Get Services` API
parcel	string The parcel Id, a unique identifier named to individual package. It can be referred from response of `Get Parcel Types` API
carrier	string The CarrierID, a unique identifier given to an individual carrier. It can be referred from 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

The Special Service has been fetched successfully.

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/specialServices

Request samples

Response samples

application/json

{"services": [{"serviceId": "LIB",
"brandedName": "Library Mail®",
"parcelTypeRules": [{"brandedName": "Package",
"parcelType": "PKG",
"trackable": "REQUIRES_TRACKABLE_SPECIAL_SERVICE",
"suggestedTrackableSpecialService": "DelCon",
"specialServiceRules": [{"brandedName": "Collect on Delivery",
"categoryId": "COD",
"categoryName": "Collect on Delivery",
"incompatibleSpecialServices": ["CODRD",
"Ins",
"InsRD",
"SigRD"
],
"inputParameterRules": [{"brandedName": "COD Amount",
"maxValue": 1000,
"minValue": 1,
"name": "INPUT_VALUE",
"required": true
}
],
"specialserviceId": "COD",
"trackable": true
},
{"brandedName": "COD Restricted Delivery",
"categoryId": "COD",
"categoryName": "Collect on Delivery",
"incompatibleSpecialServices": ["COD",
"Ins",
"InsRD",
"SigRD"
],
"inputParameterRules": [{"brandedName": "COD Amount",
"maxValue": 1000,
"minValue": 1,
"name": "INPUT_VALUE",
"required": true
}
],
"specialserviceId": "CODRD",
"trackable": true
},
{"brandedName": "USPS Tracking™",
"specialserviceId": "DelCon",
"trackable": true
},
{"brandedName": "Return Receipt Electronic",
"categoryId": "RR",
"categoryName": "Return Receipt",
"incompatibleSpecialServices": ["InsRD",
"Sig",
"SigRD"
],
"prerequisiteRules": [{"specialserviceId": "COD"
},
{"specialserviceId": "CODRD"
}
],
"specialserviceId": "ERR"
},
{"brandedName": "Insurance",
"categoryId": "IM",
"categoryName": "Insurance",
"incompatibleSpecialServices": ["COD",
"CODRD",
"InsRD",
"SigRD"
],
"inputParameterRules": [{"brandedName": "Insurance",
"maxValue": 5000,
"minValue": 1,
"name": "INPUT_VALUE",
"required": true
}
],
"specialserviceId": "Ins",
"trackable": true
},
{"brandedName": "Insurance Restricted Delivery",
"categoryId": "IM",
"categoryName": "Insurance",
"incompatibleSpecialServices": ["COD",
"CODRD",
"ERR",
"Ins",
"Sig",
"SigRD"
],
"inputParameterRules": [{"brandedName": "Insurance",
"maxValue": 5000,
"minValue": 500.01,
"name": "INPUT_VALUE",
"required": true
}
],
"specialserviceId": "InsRD",
"trackable": true
},
{"brandedName": "Return Receipt",
"categoryId": "RR",
"categoryName": "Return Receipt",
"incompatibleSpecialServices": ["Sig",
"SigRD"
],
"inputParameterRules": [{"brandedName": "Return Receipt Number",
"description": "Return Receipt Tracking Number",
"format": "^[0-9]{22,22}$",
"name": "RETURN_RECEIPT_NUMBER",
"required": true
}
],
"prerequisiteRules": [{"specialserviceId": "COD"
},
{"specialserviceId": "CODRD"
},
{"minInputValue": 501,
"specialserviceId": "Ins"
},
{"minInputValue": 501,
"specialserviceId": "InsRD"
}
],
"specialserviceId": "RR"
},
{"brandedName": "Signature Confirmation™",
"categoryId": "SIG",
"categoryName": "Signature",
"incompatibleSpecialServices": ["ERR",
"InsRD",
"RR",
"SigRD"
],
"specialserviceId": "Sig",
"trackable": true
},
{"brandedName": "Signature Confirmation Restricted Delivery",
"categoryId": "SIG",
"categoryName": "Signature",
"incompatibleSpecialServices": ["COD",
"CODRD",
"ERR",
"Ins",
"InsRD",
"RR",
"Sig"
],
"specialserviceId": "SigRD",
"trackable": true
}
]
}
]
}
]
}