# Lista transferências entre estoques

Retorna lista transferências entre estoques.

Endpoint: GET /api/v3/stock-transfers
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `stock_in_id` (integer)
    Filtra pelo identificador único do estoque de destino.

  - `stock_out_id` (integer)
    Filtra pelo identificador único do estoque de origem.

  - `responsible_name` (string)
    Filtra pelo nome do resposável pela transferência.

  - `carrier_id` (integer)
    Filtra pelo identificador único da transportadora.

  - `start_date` (string)
    Filtra por dados que foram registrados a partir de uma data. (Formato: YYYY-MM-DD).

  - `end_date` (string)
    Filtra por dados que foram registrados até uma data. (Formato: YYYY-MM-DD).

  - `order_by_field` (string)
    Ordena pelo campo.
Exemplo:
  - date Data
  - id Código da transferência
    Enum: "date", "id"

  - `order_by_type` (string)
    Tipo de ordenação.
Exemplo:
  - asc Ascendente
  - desc Descendente
    Enum: "asc", "desc"

  - `stock_transfer_ids` (string)
    Filtra pelos IDs dos movimentos de transferencias. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.transfers` (array)
    Representa uma lista de transferências entre estoques

  - `data.transfers.id` (number)
    Identificar único da transferência.
    Example: 1

  - `data.transfers.stock_out` (object)

  - `data.transfers.stock_out.id` (integer)
    Identificador único do estoque de saída.
    Example: 123

  - `data.transfers.stock_out.stock_name` (string)
    Nome do estoque de saída.
    Example: "Estoque Padrão"

  - `data.transfers.stock_in` (object)

  - `data.transfers.stock_in.id` (integer)
    Identificador único do estoque de destino.
    Example: 123

  - `data.transfers.stock_in.stock_name` (string)
    Nome do estoque de destino.
    Example: "Estoque da loja A"

  - `data.transfers.carrier` (object)

  - `data.transfers.carrier.id` (integer)
    Identificador único da transportadora.
    Example: 123

  - `data.transfers.carrier.stock_name` (string)
    Nome da transpordora.
    Example: "CPlug Log"

  - `data.transfers.responsible_name` (string)
    Nome do responsável pela transferência.
    Example: "Fulano de tal"

  - `data.transfers.notes` (string)
    Observações.
    Example: "Cuidado com o cão"

  - `data.transfers.created_at` (string)
    Data da criação da transferência.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.transfers.updated_at` (string)
    Data da atualização da transferência.
    Example: "2020-01-01T09:00:00-03:00"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields