Get Load Locations

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/getLoadLocations

Use the Get Load Locations endpoint to retrieve a list of load locations that are nearest to the specified postal code.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

Form Data

apiLogin

string

required

Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency.. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

programId

int32

required

A unique program identifier from SoFi Tech Solutions.
Pattern: Positive integer
Example: 1032

postalCode

string | null

^[a-zA-Z0-9\-\ ]{5,10}$

Postal code for the locations to retrieve. The finder returns load locations in and near this postal code.
Pattern: 12345, 12345-6789 or K1A-1A1
Example: "84121"

resultCount

int32

1 to 99999

Defaults to 5

The maximum number of records to return.
Pattern: Integer 1–9999
Example: 100

latLong

string | null

^([-+]?[0-9]{1,2}[.][0-9]+),([-+]?[0-9]{1,3}[.]\d+)$

The latitude and longitude of the requester's location. The finder returns load locations near this geographical point.
Pattern: Latitude/longitude pair separated by a comma and space; no limit on decimal places
Example: 40.57297941556069, -111.89920138637734

newVersion

int32 | null

enum

Specifies whether to use the new version of the load-location finder:

0 — Do not use the new version
1 — Use the new version

Pattern: 0 or 1
Example: 1

Allowed:

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default