How to Check if an Address i Serviceable Using the API
If you want to find out whether an address is serviceable, the recommended approach is to check the associated Object via the API.
Check Object Serviceability
The easiest way to see if an object is serviceable is to use the GetAvailability endpoint:
curl -X 'GET' \
'https://*.na.partnerapi.net/v1/Object/GetAvailability/47384367-d16f-465e-b1bc-b04b01200f48' \
-H 'accept: application/json' \
-H 'BusinessEngine: *' \
-H 'Authorization: *'
The response will include:
{
"orderable": true,
"signupAvailable": true,
"surveyAvailable": true,
"externalSurveyAvailable": true,
"externalLink": "string"
}
-
orderable indicates whether you can place an order on the object.
-
signupAvailable indicates whether you can create a prospect on the object.
If you try to create a prospect on a non-deliverable object where surveyAvailable/signupAvailable is false, you will receive an error like: Signup is not allowed.
List Available Services for an Object
You can also retrieve a list of all available services for an object using GetAvailableServices:
curl -X 'GET' \
'https://*.na.partnerapi.net/v1/Service/GetAvailableServices?ObjectId=47384367-d16f-465e-b1bc-b04b01200f48' \
-H 'accept: application/json' \
-H 'BusinessEngine: *' \
-H 'Authorization: *'Recommendations for Handling Objects
-
There is currently no way to filter objects by address via the API.
-
The best approach is to pull all objects your API user has access to and cache them locally.
-
Use the UpdatedSince parameter to partially update your cache regularly.
-
The operator can add or remove objects at any time, so regularly updating your object list ensures your information is current.
-
If you attempt to place an order on a removed object, the API will return an error.