# 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`.


## Servers
- https://soget-api-integration.azure-api.net/api-referential-list/v1: https://soget-api-integration.azure-api.net/api-referential-list/v1 ()



## Parameters


### Query parameters
- **code** (string)
  Search characters.
- **country** (string)
  UN/LOCODE country.
- **name** (string)
  UN/LOCODE name.
- **subdivision** (string)
  UN/LOCODE subdivision.
- **coordinates** (string)
  UN/LOCODE coordinates.
- **desc** (boolean)
  Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.
- **offset** (integer(int32))
  Index of the first returned result.
- **limit** (integer(int32))
  Number of results to be returned. Max value is 10.


## Responses
### 200
Successful operation

#### Body: application/json (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 
  <a href="https://www.unece.org/fileadmin/DAM/cefact/locode/UNLOCODE_Manual.pdf">recommendation 16 UN/LOCODE</a>.
- **Additional properties are NOT allowed** ()


### 400
Unexpected error

#### Body: application/json (object)
- **status** (string | null)
  Error status
- **timestamp** (string(date-time))
  Error date
- **code** (string | null)
  Error code
  <br>- R101 : The container size type is unfound.<br>- R102 : The country code is unfound.<br>- R103 : The document type is unfound.<br>- R104 : The location code is unfound.<br>- R105 : The location type is unfound.<br>- R106 : The packaging code is unfound.<br>- R107 : The transport mode is unfound.<br>- R108 : The transport mean type is unfound.<br>- R109 : The event type is unfound.<br>- R110 : The UN/LOCODE is unfound.<br>- R111 : The actor is unfound.<br>- R112 : The dangerous code is unfound.
- **message** (string | null)
  Error message
- **Additional properties are NOT allowed** ()



[Powered by Bump.sh](https://bump.sh)