Get Coverage

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

Authorization: x-api-key

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

Use this endpoint to receive a complete list of supported zip codes in which our delivery services are offered.

This endpoint has many use cases, including:

• Add a filtering facet to category pages that shows products available for same-day delivery from our stores
• Update your application to reflect the list of applicable zip codes

Request

Responses

200

If the request is valid, a successful response will contain a complete list of supported zip codes.

application/json

Schema

Schema

pagesCount numberrequired
page numberrequired
objectsCount numberrequired
objects object[]required
Array [
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)

{
  "pagesCount": 0,
  "page": 0,
  "objectsCount": 0,
  "objects": [
    {
      "name": "string",
      "pickUpZipCodes": [
        "string"
      ],
      "dropOffZipCodes": [
        "string"
      ],
      "operatingDays": [
        "monday"
      ],
      "services": [
        {
          "serviceType": "SAME_DAY",
          "jobType": "DELIVERY"
        }
      ],
      "timeZone": "string"
    }
  ]
}

Example

{
  "success": true,
  "objects": [
    {
      "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",
        "saturday",
        "sunday"
      ]
    },
    {
      "name": "Los Angeles",
      "pickUpZipCodes": [
        "90046",
        "90047",
        "90048"
      ],
      "dropOffZipCodes": [
        "90046",
        "90047",
        "90049"
      ],
      "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' \
-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

ResponseClear

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