List service points
Changed onList carrier service points by location
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
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.
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": [
{
"error_source": "shipengine",
"error_type": "validation",
"error_code": "invalid_field_value",
"message": "Body of request cannot be null.",
"carrier_id": "se-28529731",
"carrier_code": "dhl_express",
"field_name": "shipment.ship_to.phone_number"
}
]
}Changes
- warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status
- warning
- breaking
request property
////was restricted to a list of enum values - breaking
the
//request property's minLength was increased from0to2 - breaking
the
//request property's minLength was increased from0to1 - breaking
the
//request property type changed from no type tostring - breaking
the
//request property type changed from no type tostring - breaking
the
////request property type changed from no type tostring - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
//response's property type changed from no type tostringfor status - breaking
the
//response's property type changed from no type tostringfor status - breaking
the
//response's property type changed from no type tostringfor status - warning
removed from the
//request propertyallOflist - warning
removed from the
//request propertyallOflist - warning
removed from the
////request propertyallOflist - warning
the
//request property's maxLength was set to2 - info
added the new
gramenum value to the request property//// - info
added the new
kilogramenum value to the request property//// - info
added the new
ounceenum value to the request property//// - info
added the new
poundenum value to the request property//// - 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 - info
removed from the
//response propertyallOflist for the response status - info
removed from the
//response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
//response propertyallOflist for the response status - info
the
//response's property pattern^[a-z0-9]+(_[a-z0-9]+)*$was added for the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking