getAccessPoints - Amazon SP API

Returns a list of access points in proximity of input postal code.

Usage Plan:

Rate (requests per second)	Burst
80	100

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Query Params

accessPointTypes

array[string]

required

Allowed values:

HELIXCAMPUS_LOCKEROMNI_LOCKERODIN_LOCKERDOBBY_LOCKERCORE_LOCKER3PCAMPUS_ROOM

Example:

HELIX

countryCode

string

required

Example:

postalCode

string

required

Example:

EX332JL

Header Params

x-amzn-shipping-business-id

enum<string>

optional

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Allowed values:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the GetAccessPoints operation.

payload

object (GetAccessPointsResult)

optional

The payload for the GetAccessPoints API.

accessPointsMap

object (AccessPointsMap)

required

Map of type of access point to list of access points

Example

{
    "HELIX": {
        "accessPointId": "00046c4b-bb0a-4c03-831e-5633e142f16a",
        "name": "Amazon Hub Counter - Co-op Braunton",
        "timezone": "Europe/London",
        "type": "HELIX",
        "accessibilityAttributes": {
            "distance": "21.200000762939453",
            "driveTime": "0.0"
        },
        "address": {
            "addressObject": {
                "addressLine1": "Exeter Road",
                "city": "Braunton",
                "countryCode": "GB",
                "zipOrPostalCode": "EX33 2JL"
            },
            "geocode": {
                "latitude": "51.1076671",
                "longitude": "-4.1607301"
            }
        },
        "exceptionOperatingHours": [
            {
                "dateRange": {
                    "endDate": "1.6932672E9",
                    "startDate": "1.6931808E9"
                },
                "operatingHours": {
                    "closingTime": {
                        "hourOfDay": 0,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                    },
                    "midDayClosures": [],
                    "openingTime": {
                        "hourOfDay": 0,
                        "minuteOfHour": 0,
                        "secondOfMinute": 0
                    }
                }
            }
        ],
        "assistanceType": "STAFF_ASSISTED",
        "score": "0.6688068509101868",
        "standardOperatingHours": {
            "WEDNESDAY": {
                "closingTime": {
                    "hourOfDay": 22,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                },
                "midDayClosures": [],
                "openingTime": {
                    "hourOfDay": 7,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                }
            },
            "MONDAY": {
                "closingTime": {
                    "hourOfDay": 22,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                },
                "midDayClosures": [],
                "openingTime": {
                    "hourOfDay": 7,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                }
            },
            "THURSDAY": {
                "closingTime": {
                    "hourOfDay": 22,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                },
                "midDayClosures": [],
                "openingTime": {
                    "hourOfDay": 7,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                }
            },
            "SUNDAY": {
                "closingTime": {
                    "hourOfDay": 22,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                },
                "midDayClosures": [],
                "openingTime": {
                    "hourOfDay": 7,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                }
            },
            "TUESDAY": {
                "closingTime": {
                    "hourOfDay": 22,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                },
                "midDayClosures": [],
                "openingTime": {
                    "hourOfDay": 7,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                }
            },
            "FRIDAY": {
                "closingTime": {
                    "hourOfDay": 22,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                },
                "midDayClosures": [],
                "openingTime": {
                    "hourOfDay": 7,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                }
            },
            "SATURDAY": {
                "closingTime": {
                    "hourOfDay": 22,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                },
                "midDayClosures": [],
                "openingTime": {
                    "hourOfDay": 7,
                    "minuteOfHour": 0,
                    "secondOfMinute": 0
                }
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable