# Filter the list of handling units linked to a shipment and/or voyage agent.

**GET /handling-units/search**

One of the following parameters must be provided: documentReference, voyageAgentReference or voyageAgentId.
Sample request :

    GET /handling-units/search?documentReference=3714238101


## Servers
- https://soget-api-integration.azure-api.net/api-tracing-code-in-mass/v1: https://soget-api-integration.azure-api.net/api-tracing-code-in-mass/v1 ()


## Authentication methods
- Bearer token & Api key


## Parameters


### Query parameters
- **documentReference** (string)
  Announcement document reference.
- **voyageAgentReference** (string)
  Voyage agent reference to filter.
- **voyageAgentId** (string)
  S)One identifier of the voyage agent to filter.
- **customsFlag** (string)
  Type of flow.
- **freightAgent** (string)
  Agent code of shipping company.
- **desc** (boolean)
  Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.
- **limit** (integer(int32))
  Number of results to be returned. Max value is 10.
- **offset** (integer(int32))
  Index of the first returned result.


## Responses
### 200
Success

#### Body: application/json (object)
- **total** (integer(int32))
  Total amount of objects matching given parameters.
- **returned** (integer(int32))
  Amount of objects returned by the paginated query.
- **first** (integer(int32))
  Index of the first returned object.
- **items** (array[object] | null)
  Items returned by the query.

### 400
Bad Request

#### Body: application/json (object)
- **status** (string | null)
  Http error status.
- **timestamp** (string(date-time))
  Error date.
  <br>ISO 8601 Extended Format
- **code** (string | null)
  Business error code.
  <br>The possible values are :<br>- R001 : No handling unit was found<br>- R002 : The handling unit is null<br>- R003 : The handling unit is not correctly formated
- **message** (string | null)
  Error message.

### 404
Not Found

#### Body: application/json (object)
- **status** (string | null)
  Http error status.
- **timestamp** (string(date-time))
  Error date.
  <br>ISO 8601 Extended Format
- **code** (string | null)
  Business error code.
  <br>The possible values are :<br>- R001 : No handling unit was found<br>- R002 : The handling unit is null<br>- R003 : The handling unit is not correctly formated
- **message** (string | null)
  Error message.


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