List closest agents relative to a postal code and city.

curl --request GET \
  --url 'https://app.smartsend.io/api/v1/website/{team}/agents/closest/carrier/{carrier}/country/{country}/postalcode/{postalCode}/city/{city}?api_token=' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
      "agent_no": "2134",
      "carrier": "postnord",
      "company": "Kiosk 88",
      "address_line1": "Nordre Frihavnsgade",
      "postal_code": "2100",
      "city": "Copenhagen",
      "country": "DK",
      "type": "agent",
      "distance": 1.22,
      "name_line1": "John",
      "name_line2": "Doe",
      "address_line2": "88",
      "coordinates": {
        "latitude": 55.702632904052734,
        "longitude": 12.58386516571045
      },
      "opening_hours": [
        {
          "day": "monday",
          "opens": "07:30:00",
          "closes": "17:30:00"
        }
      ]
    }
  ],
  "meta": {
    "current_page": "1",
    "from": "1",
    "path": "https://example.com/api/example",
    "per_page": "15",
    "to": "15",
    "last_page": "10",
    "total": "140"
  }
}

GET

website

{team}

agents

closest

carrier

{carrier}

country

{country}

postalcode

{postalCode}

city

{city}

List closest agents relative to a postal code and city.

curl --request GET \
  --url 'https://app.smartsend.io/api/v1/website/{team}/agents/closest/carrier/{carrier}/country/{country}/postalcode/{postalCode}/city/{city}?api_token=' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
      "agent_no": "2134",
      "carrier": "postnord",
      "company": "Kiosk 88",
      "address_line1": "Nordre Frihavnsgade",
      "postal_code": "2100",
      "city": "Copenhagen",
      "country": "DK",
      "type": "agent",
      "distance": 1.22,
      "name_line1": "John",
      "name_line2": "Doe",
      "address_line2": "88",
      "coordinates": {
        "latitude": 55.702632904052734,
        "longitude": 12.58386516571045
      },
      "opening_hours": [
        {
          "day": "monday",
          "opens": "07:30:00",
          "closes": "17:30:00"
        }
      ]
    }
  ],
  "meta": {
    "current_page": "1",
    "from": "1",
    "path": "https://example.com/api/example",
    "per_page": "15",
    "to": "15",
    "last_page": "10",
    "total": "140"
  }
}

Authorizations

Authorization

string

header

required

Provide API Token as Bearer authentication

api_token

string

query

required

Query API Token

Path Parameters

team

string

required

The domain of the website making the agent lookup request

carrier

enum<string>

required

The carrier code

Available options:

postnord,

gls,

dao,

bifrost,

bring

country

string

required

ISO3166 Alpha2 country code

Required string length: 2

postalCode

string

required

The postal code

city

string

required

The city code

Response

Successful operation

data

object[]

Data container

Show child attributes

data.id

string<uuid>

required

Unique ID

Example:

"c5540f2b-3eea-45c4-957a-9d7b53f899e7"

data.agent_no

string

required

The carriers own number for the agent

Example:

"2134"

data.carrier

string

required

The carrier code

Example:

"postnord"

data.company

string

required

The company name

Example:

"Kiosk 88"

data.address_line1

string

required

The first address line

Example:

"Nordre Frihavnsgade"

data.postal_code

string

required

The postal code

Example:

"2100"

data.city

string

required

The city

Example:

"Copenhagen"

data.country

string

required

ISO3166 Alpha2 country code

Example:

"DK"

data.type

enum<string>

The resource type

Available options:

agent

Example:

"agent"

data.distance

number

The calculated distance to the agent in kilometers

Required range: x >= 0

Example:

1.22

data.name_line1

string

The first name line

Example:

"John"

data.name_line2

string

The second name line

Example:

"Doe"

data.address_line2

string

The second address line

Example:

"88"

data.coordinates

object

Coordinates resource

Show child attributes

data.coordinates.latitude

number

required

The GPS latitude

Example:

55.702632904052734

data.coordinates.longitude

number

required

The GPS latitude

Example:

12.58386516571045

data.opening_hours

object[]

Opening hours

Show child attributes

data.opening_hours.day

enum<string>

required

The weekday

Available options:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

data.opening_hours.opens

string

required

The time in the format HH:MM:SS also known as partial-time accoridng to RFC 3339, section 5.6.

Example:

"07:30:00"

data.opening_hours.closes

string

required

The time in the format HH:MM:SS also known as partial-time accoridng to RFC 3339, section 5.6.

Example:

"17:30:00"

API Reference

Endpoints

List closest agents relative to a postal code and city.

Authorizations

Path Parameters

Response