OppiziDeveloper
API ReferenceTargeting

Suggest the best-fit routes

GET
/client/carrier-routes/suggest

Carrier routes around a point, ranked by how well they match the audience you describe rather than purely by distance.

Build targetSelection from the attribute catalog, and give a latitude, longitude and radius to search in.

Use this when you care who receives the mail; use route search when you just want everything nearby.

Authorization

ClientBearer
AuthorizationBearer <token>

Client-scoped key as a Bearer JWT; always pinned to your own client.

In: header

Query Parameters

lat*string

Latitude.

lng*string

Longitude.

radius*string

Search radius around the point.

targetSelection?string

JSON array of demographic attribute groups (from /client/eddm/demographic-attributes). Omit for geo-only suggestions.

first?string

Max routes (cap 500).

after?string

Pagination cursor (pageInfo.endCursor).

Response Body

application/json

curl -X GET "https://example.com/client/carrier-routes/suggest?lat=string&lng=string&radius=string"
{  "success": true,  "data": {    "suggestions": [      {        "zip": "33130",        "croute": "C012",        "fit": 0.87      }    ],    "totalCount": 42,    "pageInfo": {      "hasNextPage": true,      "endCursor": "eyJ..."    }  }}
Empty
Empty
Empty
Empty
Empty