Filter UN/LOCODEs.

GET /unlocodes

Sample request:

GET /unlocodes?code=AU&offset=0&limit=10

or

GET /unlocodes?code=FRACO,FRAXV

If you want to search for multiple values for a given parameter, enter :

param=val1,val2

For example, the query shown above would return the UN/LOCODEs that have a code of FRACO or FRAXV.

Query parameters

code string

Search characters.

Default value is empty.
country string

UN/LOCODE country.

Default value is empty.
name string

UN/LOCODE name.

Default value is empty.
subdivision string

UN/LOCODE subdivision.

Default value is empty.
coordinates string

UN/LOCODE coordinates.

Default value is empty.
desc boolean

Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.

Default value is false.
offset integer(int32)

Index of the first returned result.

Default value is 0.
limit integer(int32)

Number of results to be returned. Max value is 10.

Default value is 10.

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- total integer(int32)
  
  Total number of items found by the query
- first integer(int32)
  
  Index of the first returned object
- items array[object] | null
  
  UN/LOCODE information is based on recommendation 16 UN/LOCODE.
  
  UN/LOCODE information is based on recommendation 16 UN/LOCODE.
  
  Hide items attributes Show items attributes object
  
  code string | null
  
  UN/LOCODE have length of 5 - combination of Country code (length of 2) and Location code (length of 3)
  
  Minimum length is 0, maximum length is 5.
  
  country string | null
  
  Two letters code of country
  
  Minimum length is 0, maximum length is 2.
  
  name string | null
  
  Description about location
  
  Minimum length is 0, maximum length is 256.
  
  subdivision string | null
  
  1-3 character alphabetic and/or numeric code for the administrative division of the country concerned(state, province, department, etc.)
  
  Minimum length is 0, maximum length is 3.
  
  coordinates string | null
  
  Geographical coordinates (latitude/longitude)
  
  Format: ddmmN dddmmW, ddmmS dddmmE, etc.,
  
  Where the two last digits refer to minutes and the two or three first digits indicate the degrees.
  
  Minimum length is 0, maximum length is 12.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
400 application/json

Unexpected error
Hide response attributes Show response attributes object
- status string | null
  
  Error status
- timestamp string(date-time)
  
  Error date
- code string | null
  
  Error code
  - R101 : The container size type is unfound.
  - R102 : The country code is unfound.
  - R103 : The document type is unfound.
  - R104 : The location code is unfound.
  - R105 : The location type is unfound.
  - R106 : The packaging code is unfound.
  - R107 : The transport mode is unfound.
  - R108 : The transport mean type is unfound.
  - R109 : The event type is unfound.
  - R110 : The UN/LOCODE is unfound.
  - R111 : The actor is unfound.
  - R112 : The dangerous code is unfound.
- message string | null
  
  Error message
- Additional properties are NOT allowed

GET /unlocodes

curl \
 -X GET https://soget-api-integration.azure-api.net/api-referential-list/v1/unlocodes \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Ocp-Apim-Subscription-Key: $API_KEY"

Response examples (200)

{
  "total": 11,
  "first": 3,
  "items": [
    {
      "code": "UGMUK",
      "country": "UG",
      "name": "Mukono",
      "subdivision": "108",
      "coordinates": "0021N 03245E"
    }
  ]
}

Response examples (400)

{
  "status": "400",
  "timestamp": "2022-10-18T14:53:52.239Z",
  "code": "R001",
  "message": "Information not found."
}