service_points
List service points
<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>List carrier service points by location
post/v2/service_points/list
Request body
Example request
{
"address_query": "177A Bleecker Street New York",
"address": {
"address_line1": "1999 Bishop Grandin Blvd.",
"address_line2": "Unit 408",
"address_line3": "Building #7",
"city_locality": "Winnipeg",
"state_province": "Manitoba",
"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,
"shipment": {
"total_weight": {
"value": 23
},
"packages": [
{
"dimensions": {
"length": 2,
"width": 2,
"height": 1
}
}
]
}
}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"
}
]
},
"type": "pudo"
}
],
"errors": [
{
"message": "Body of request cannot be null.",
"field_name": "inventory_warehouse_id",
"field_value": "invalid-id"
}
]
}