service_points

List Service Points

Changed on Oct 8, 2024

List carrier service points by location

post/v1/service_points/list

Request

Base URL
https://api.shipengine.com
URL
https://api.shipengine.com/v1/service_points/list
Auth
API key in header API-Key

Request body

address_querystring

Unstructured text to search for service points by.

latnumber double

The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html

longnumber double

The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html

radiusinteger

Search radius in kilometers

max_resultsinteger

The maximum number of service points to return

Example request

{
  "address_query": "177A Bleecker Street New York",
  "address": {
    "address_line1": "1999 Bishop Grandin Blvd.",
    "postal_code": "78756-3717",
    "country_code": "CA"
  },
  "providers": [
    {
      "carrier_id": "se-123456",
      "service_code": [
        "chronoclassic"
      ]
    }
  ],
  "lat": 48.874518928233094,
  "long": 2.3591775711639404,
  "radius": 500,
  "max_results": 25
}

Response

The request was a success.

latnumber double

The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html

longnumber double

The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html

Example response

{
  "lat": 48.842608,
  "long": 0.032875,
  "service_points": [
    {
      "carrier_code": "dhl_express",
      "service_codes": [
        "chronoclassic"
      ],
      "service_point_id": "614940",
      "company_name": "My fancy company name",
      "address_line1": "PLACE DU CANADA",
      "city_locality": "TRUN",
      "state_province": "TRUN",
      "postal_code": "78756-3717",
      "country_code": "CA",
      "phone_number": "555-555-5555",
      "lat": 48.842608,
      "long": 0.032875,
      "distance_in_meters": 728.9959308847579,
      "hours_of_operation": {
        "monday": [
          {
            "open": "09:15",
            "close": "12:00"
          }
        ],
        "tuesday": [
          {
            "open": "09:15",
            "close": "12:00"
          }
        ],
        "wednesday": [
          {
            "open": "09:15",
            "close": "12:00"
          }
        ],
        "thursday": [
          {
            "open": "09:15",
            "close": "12:00"
          }
        ],
        "friday": [
          {
            "open": "09:15",
            "close": "12:00"
          }
        ],
        "saturday": [
          {
            "open": "09:15",
            "close": "12:00"
          }
        ],
        "sunday": [
          {
            "open": "09:15",
            "close": "12:00"
          }
        ]
      }
    }
  ],
  "errors": [
    {
      "message": "Body of request cannot be null.",
      "carrier_id": "se-28529731",
      "carrier_code": "dhl_express",
      "field_name": "shipment.ship_to.phone_number"
    }
  ]
}

Changes

Oct 8, 2024e4ae9b442f54 Revision changes
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
Sep 13, 20245a15ef11fd60 Revision changes
- warning
  added the new file_not_found enum value to the //// response property for the response status
- warning
  added the new file_not_found enum value to the //// response property for the response status
- warning
  added the new file_not_found enum value to the //// response property for the response status
- warning
  added the new file_not_found enum value to the //// response property for the response status
- warning
  added the new funding_source_error enum value to the //// response property for the response status
- warning
  added the new funding_source_error enum value to the //// response property for the response status
- warning
  added the new funding_source_error enum value to the //// response property for the response status
- warning
  added the new funding_source_error enum value to the //// response property for the response status
- warning
  added the new funding_source_missing_configuration enum value to the //// response property for the response status
- warning
  added the new funding_source_missing_configuration enum value to the //// response property for the response status
- warning
  added the new funding_source_missing_configuration enum value to the //// response property for the response status
- warning
  added the new funding_source_missing_configuration enum value to the //// response property for the response status
- warning
  added the new funding_source_registration_in_progress enum value to the //// response property for the response status
- warning
  added the new funding_source_registration_in_progress enum value to the //// response property for the response status
- warning
  added the new funding_source_registration_in_progress enum value to the //// response property for the response status
- warning
  added the new funding_source_registration_in_progress enum value to the //// response property for the response status
- warning
  added the new insurance_failure enum value to the //// response property for the response status
- warning
  added the new insurance_failure enum value to the //// response property for the response status
- warning
  added the new insurance_failure enum value to the //// response property for the response status
- warning
  added the new insurance_failure enum value to the //// response property for the response status
- warning
  added the new service_not_determined enum value to the //// response property for the response status
- warning
  added the new service_not_determined enum value to the //// response property for the response status
- warning
  added the new service_not_determined enum value to the //// response property for the response status
- warning
  added the new service_not_determined enum value to the //// response property for the response status
- warning
  added the new shipping_rule_not_found enum value to the //// response property for the response status
- warning
  added the new shipping_rule_not_found enum value to the //// response property for the response status
- warning
  added the new shipping_rule_not_found enum value to the //// response property for the response status
- warning
  added the new shipping_rule_not_found enum value to the //// response property for the response status

Operation history (9 revisions)