Skip to main content

Listar Negociações com filtros (paginado)

Descrição: Retorna uma lista paginada de negociações (order commitments) vinculadas à cooperativa, em formato resumido, com suporte a filtros.

Endpoint​

POST/api/v1/integration/order-commitments/paginated:summary

Regras​

AtributosDescriçãoTipoObrigatórioValidações
filter_by_tokenSe true, restringe o resultado ao usuário associado ao tokenBooleanNão-
search_paramBusca genérica por texto livreStringNão-
producer_idsFiltro por lista de identificadores de produtoresList\<UUID>Não-
unselected_producer_idsLista de produtores a serem excluídos do resultadoList\<UUID>Não-
filter_all_producersQuando true, considera todos os produtores da cooperativaBooleanNão-
order_typesFiltro por tipo de negociaçãoList\<Enum>NãoCOMPRA, VENDA, FIXACAO_COMPRA, FIXACAO_VENDA, FIXACAO_DEPOSITO, ANTECIPACAO, A_FIXAR
product_idsFiltro por lista de identificadores de produtosList\<UUID>Não-
order_created_atIntervalo de criação do pedidoObjectNãoCampos: start_date, end_date (ISO 8601)
price_commitmentIntervalo de preço da negociaçãoObjectNãoCampos: initial_price, end_price (Number)
currency_idsFiltro por lista de identificadores de moedaList\<UUID>Não-
price_unit_of_measurement_idsFiltro por lista de identificadores de unidade de medida de preçoList\<UUID>Não-
unit_of_measurement_idsFiltro por lista de identificadores de unidade de medidaList\<UUID>Não-
fixed_amountIntervalo de volume fixadoObjectNãoCampos: initial_amount, end_amount (Number)
wallet_idsFiltro por lista de identificadores de carteirasList\<UUID>Não-
delivery_dateIntervalo de data de entregaObjectNãoCampos: start_date, end_date (Date)
compliance_statusFiltro por status do workflow de ComplianceList\<Enum>NãoNEW, PENDING, PENDING_REVIEW, APPROVED, REJECTED
commercial_statusFiltro por status do workflow ComercialList\<Enum>NãoNEW, PENDING, PENDING_REVIEW, APPROVED, REJECTED
contracts_statusFiltro por status do workflow de ContratosList\<Enum>NãoNEW, PENDING, PENDING_REVIEW, APPROVED, REJECTED
administrative_statusFiltro por status do workflow AdministrativoList\<Enum>NãoNEW, PENDING, PENDING_REVIEW, APPROVED, REJECTED
billing_statusFiltro por status do workflow de FaturamentoList\<Enum>NãoNEW, PENDING, PENDING_REVIEW, APPROVED, REJECTED
order_commitment_statusFiltro por situação da negociaçãoList\<Enum>NãoOPEN, CANCELED
producer_esg_statusFiltro por status ESG do produtorList\<Enum>NãoNONE, PARCIAL, CONFORME, NAO_CONFORME, NAO_ENCONTRADO, PROCESSANDO
esg_statusFiltro por status ESG da negociaçãoList\<Enum>NãoNONE, PARCIAL, CONFORME, NAO_CONFORME, NAO_ENCONTRADO, PROCESSANDO
logistics_box_idsFiltro por lista de identificadores de caixas logísticasList\<UUID>Não-
ignore_wallet_filterQuando true, ignora o filtro padrão de carteiras do usuárioBooleanNão-
order_paydayIntervalo de data de pagamentoObjectNãoCampos: start_date, end_date (Date, padrão yyyy-MM-dd)
file_nameNome do arquivo (usado em exportações)StringNão-
harvest_idsFiltro por lista de identificadores de safrasList\<UUID>Não-
payment_typesFiltro por tipo de pagamentoList\<Enum>NãoDINHEIRO, TROCA
cooperative_idsFiltro por lista de identificadores de cooperativasList\<UUID>Não-
layers_esg_with_issuesFiltro por camadas ESG com apontamentosList\<String>Não-
layers_esg_without_issuesFiltro por camadas ESG sem apontamentosList\<String>Não-
only_this_esg_issuesQuando true, retorna apenas negociações com os apontamentos informadosBooleanNão-
modality_idsFiltro por lista de identificadores de modalidadesList\<UUID>Não-
shipping_idsFiltro por lista de identificadores de freteList\<UUID>Não-

Exemplo de Requisição​

Exemplo de Requisição
curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "cooperative-id: [[cooperativeId]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json;charset=UTF-8"\
-d '{
    "search_param": "SOJA",
    "order_types": ["COMPRA", "VENDA"],
    "order_commitment_status": ["OPEN"],
    "order_created_at": {
        "start_date": "2024-01-01T00:00:00Z",
        "end_date": "2024-12-31T23:59:59Z"
    }
}'\
"https://homolog.api.merx.tech/api/v1/integration/order-commitments/paginated:summary?page=0&size=30&sort=order_commitment_created_at,desc"

Parâmetros​

Parâmetros de Cabeçalho​

NomeDescriçãoTipoObrigatório
AuthorizationStringSim
cooperative-idIdentificador UUID da cooperativaUUIDSim

Parâmetros de Consulta (Query)​

NomeDescriçãoTipoObrigatórioPadrão
pageNúmero da página (0-indexado)IntegerNão0
sizeQuantidade de registros por páginaIntegerNão30
sortCampo e direção de ordenação (ex: friendly_id,asc)StringNãoorder_commitment_created_at,desc

Parâmetros do Corpo​

NomeDescriçãoTipoObrigatório
... (todos os atributos listados nas regras)

Respostas​

  • 200 - Ok
{
    "content": [
        {
            "commitment_id": "7ee50d8f-9ec9-4668-a03f-e424993eb886",
            "price": "100.00",
            "producer_trading_name": "Fazenda Santa Clara",
            "type": "COMPRA",
            "product_code": "SOJA",
            "currency_code": "BRL",
            "unit_of_measurement_code": "Sc",
            "initial_delivery_date": 1734048000000,
            "end_delivery_date": 1734048000000,
            "wallet": {
                "id": "fc0a1c0f-6d12-46c7-9249-6f6f855c9ef2",
                "name": "Carteira Automação",
                "description": "string",
                "owner_id": "string",
                "company_id": "string",
                "created_at": "2024-02-28T10:30:00Z",
                "updated_at": "2024-02-28T10:30:00Z",
                "enabled": true,
                "removed": false
            },
            "farm": {
                "farm_name": "Fazenda Santa Clara",
                "farm_status": "APPROVED",
                "farm_id": "string (uuid)",
                "car": "string",
                "city": "string",
                "state": "string",
                "area": "string",
                "report_request_id": "string",
                "report_request_ids": ["string"],
                "producer_esg_status": "CONFORME",
                "esg_status": "CONFORME",
                "volume": 125.00,
                "producer_id": "string (uuid)",
                "producer_name": "string",
                "producer_social_id": "string",
                "farms": 1,
                "producers": 1,
                "traceabilities": 1
            },
            "order_created_at": "2024-02-28T10:30:00Z",
            "order_commitment_created_at": "2024-02-28T10:30:00Z",
            "status": "FULFILLED",
            "compliance_status": "APPROVED",
            "commercial_status": "APPROVED",
            "contracts_status": "PENDING",
            "administrative_status": "NEW",
            "billing_status": "NEW",
            "commitment_amount": 125.00,
            "erp_commitment_id": "string",
            "friendly_id": "240228COMTVNP8",
            "commitment_friendly_id": "240228D0DW3OOV",
            "payday": "2025-02-15",
            "producer_id": "string (uuid)",
            "committed_company_name": "string",
            "producer_name": "string",
            "total_contractual_pending": 0,
            "price_unit_of_measurement_code": "Sc",
            "commitment_status": "OPEN",
            "cooperative_id": "8c2db7cc-1020-4423-98cc-02e829299e40",
            "harvest": {
                "id": "7279dcf4-9b1c-49f5-bd16-660fc7711060",
                "name": "2022/2023",
                "created_at": "2022-01-01T00:00:00Z",
                "updated_at": "2022-01-01T00:00:00Z"
            },
            "cooperative_name": "string",
            "shipping_id": "string (uuid)"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": true,
            "unsorted": false,
            "empty": false
        },
        "page_number": 0,
        "page_size": 30,
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "total_pages": 1,
    "total_elements": 1,
    "last": true,
    "first": true,
    "sort": {
        "sorted": true,
        "unsorted": false,
        "empty": false
    },
    "number_of_elements": 1,
    "size": 30,
    "number": 0,
    "empty": false
}
  • 400 - Bad Request
{
    "timestamp": "string (date-time)",
    "status": "integer (int32)",
    "error": "string"
}

  • 401 - Unauthorized

  • 404 - NotFound