GET
/
api
/
v1
/
core
/
coverage
curl --request GET \
  --url https://api-stage.orchestro.ai/e1/api/v1/core/coverage \
  --header 'Authorization: <api-key>'
{
  "coverage": [
    {
      "serviceType": "DGRD",
      "zip": [
        "99403"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountNumber
string
required

This is the account number associated with the user or business requesting the coverage details. It is a required parameter in the query.

Example:

"AC0088"

​
serviceType
string
required

Specifies the type of service for which coverage information is requested, such as RETURN, GRD, or DGRD.

Example:

"RETURN"

​
zip
string
required

A comma-separated list of ZIP codes for which the user wants to check coverage. The ZIP codes must be URL-encoded.

Example:

"99260%2c99403"

Response

200 - application/json
Filter API request successful for GRD/DGRD/RETURN
​
coverage
object[]
Example:
[
  {
    "serviceType": "RETURN",
    "zip": ["99260", "99403"]
  }
]