GetRelayPoints

This method gets carrier relay points based on search criteria.

Request
query Parameters
transactionId
string <uuid>

The transaction ID uniquely represents this request.

Request Body schema: application/json

An object containing search criteria for relay points.

service_code
required
string or null

The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine.

city_locality
string or null

The city locality to use when searching for available relay points.

postal_code
required
string or null

The postal code to use when searching for available relay points.

country_code
required
string or null

The two character country code to use when searching for available relay points. The codes are specified by ISO 3166-1 alpha-2.

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 relay points request.

post/GetRelayPoints
Request samples
application/json
{
  • "service_code": "string",
  • "city_locality": "string",
  • "postal_code": "string",
  • "country_code": "string",
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    }
}
Response samples
application/json
{
  • "relay_points": [
    ]
}