Get Service Points

This method gets carrier service points based on search criteria.

Request
header Parameters
ShipStation-TransactionID
string <uuid>

The transaction ID uniquely represents this request.

Request Body schema: application/json

An object containing search criteria for service points.

service_code
string or null

The service code uniquely identifies a shipping service

object (ServicePointAddress)
object (SearchRadius)
max_results
integer or null <int32>

The maximum number of service points to return

transaction_id
required
string <uuid>

The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.

object (Authorization)
object or null
Responses
200

This object model represents the response from a successful get service points response.

post/GetServicePoints
Request samples
application/json
{
  • "service_code": "string",
  • "address": {
    },
  • "search_radius": {
    },
  • "max_results": 0,
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    }
}
Response samples
application/json
{
  • "service_points": [
    ],
  • "metadata": {
    }
}