Skip to content
/Facilities

Facilities

Find payable facilities and retrieve the charges held for a shipment.

A facility served by an integration returns an integration block describing how to fetch its charges. A facility without that block is paid directly, with no lookup. See Paying a Facility for the full decision flow.

Operations

Get All Facilities

Request

Search the facility catalog. Supply at least one filter. Results are paginated.

Security
bearerAuth and appId
Query
namestring

Facility name, or part of it.

Example:name=Worldwide Flight Services
firmsCodestring

Facilities Information and Resources Management System (FIRMS) code.

Example:firmsCode=E528
airportCodestring

Three letter IATA airport code.

Example:airportCode=LAX
airlinePrefixstring

Three digit airline prefix.

Example:airlinePrefix=020
pageinteger

Zero indexed page number.

Default:0
Example:page=0
sizeinteger

Number of results per page.

Default:10
Example:size=10
curl -i -X GET \
  'https://developer.cargosprint.com/_mock/sprintpay/openapi/facilities?name=Worldwide%20Flight%20Services&firmsCode=E528&airportCode=LAX&airlinePrefix=020&page=0&size=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-APP-ID: YOUR_API_KEY_HERE'

Responses

Matching facilities.

Bodyapplication/json
contentArray of objects(Facility)

Facilities on this page.

totalElementsinteger

Total number of matching facilities.

Example:42
totalPagesinteger

Total number of pages available.

Example:5
Response
{
  "content": [
    { … }
  ],
  "totalElements": 42,
  "totalPages": 5
}