Check Zip Codes

GET 
https://api.goodsdelivery.io/v1/coverage/:zipCodes

Authorization: x-api-key

name: x-api-keytype: apiKeyscopes: brandin: header

Use this endpoint to check if we support a specific zip-code or several zip-codes.

Request

Path Parameters

zipCodes stringrequired

List of zip codes, comma separated

Responses

200

If the request is valid, the response will contain a list with the status of each requested zip code.

application/json

Schema

Schema

success booleanrequired
object objectrequired
name stringrequired
pickUpZipCodes string[]required
dropOffZipCodes string[]required
operatingDays WeekDay[]required
Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]
services object[]required
Array [
serviceType ServiceTyperequired
Possible values: [SAME_DAY, NEXT_DAY, SCHEDULED]
Determine the delivery date, including pick-up and drop-off times.
jobType JobTyperequired
Possible values: [DELIVERY, RETURN]
]
timeZone stringrequired

Example (from schema)

{
  "success": true,
  "object": {
    "name": "string",
    "pickUpZipCodes": [
      "string"
    ],
    "dropOffZipCodes": [
      "string"
    ],
    "operatingDays": [
      "monday"
    ],
    "services": [
      {
        "serviceType": "SAME_DAY",
        "jobType": "DELIVERY"
      }
    ],
    "timeZone": "string"
  }
}

Example

{
  "success": true,
  "object": {
    "name": "New York",
    "pickUpZipCodes": [
      "10005",
      "10006"
    ],
    "dropOffZipCodes": [
      "10005",
      "10007"
    ],
    "services": [
      {
        "serviceType": "SAME_DAY",
        "jobType": "DELIVERY"
      },
      {
        "serviceType": "NEXT_DAY",
        "jobType": "DELIVERY"
      },
      {
        "serviceType": "SAME_DAY",
        "jobType": "RETURN"
      },
      {
        "serviceType": "NEXT_DAY",
        "jobType": "RETURN"
      }
    ],
    "operatingDays": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ]
  }
}

404

No coverage found

application/json

Schema

Schema

message stringrequired

Human readable error message.

code stringrequired

Machine readable error message.

more url

More help on the error here.

Example (from schema)

{
  "message": "string",
  "code": "string",
  "more": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api.goodsdelivery.io/v1/coverage/:zipCodes' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.goodsdelivery.io/v1

Auth

Security Scheme

APIKeyHeaderAuthorizationHeader

APIKeyHeader

Parameters

zipCodes — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!