Registrar Entrega

Descrição: Registra uma entrega. Cada chamada gera um novo registro com ID único (UUID).

Endpoint

POST/api/v1/integration/deliveries

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
contract_id	Identificador do contrato	String	Sim	Não pode ser vazio ou nulo
delivered_volume	Volume entregue	Number	Sim	Deve ser maior que zero
delivered_volume_unit_of_measure	Unidade de medida do volume	String (enum)	Sim	Valores aceitos: kg, sc, ton
delivery_date	Data da entrega	String	Sim	Formato obrigatório: YYYY-MM-DD
car	Código CAR (Cadastro Ambiental Rural)	String	Não	-

Exemplo de Requisição

Exemplo de Requisição

curl -X POST "https://homolog.api.merx.tech/api/v1/integration/deliveries" \
-H "Content-Type: application/json" \
-d '{
    "contract_id": "000122",
    "delivered_volume": 10,
    "delivered_volume_unit_of_measure": "ton",
    "delivery_date": "2026-03-02"
}'

Com CAR:

Exemplo de Requisição com CAR

curl -X POST "https://homolog.api.merx.tech/api/v1/integration/deliveries" \
-H "Content-Type: application/json" \
-d '{
    "contract_id": "000122",
    "delivered_volume": 10,
    "delivered_volume_unit_of_measure": "ton",
    "delivery_date": "2026-03-02",
    "car": "MT-5107602-ABC123456789"
}'

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Content-Type	Deve ser application/json	String	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório
contract_id	Identificador do contrato	String	Sim
delivered_volume	Volume entregue	Number	Sim
delivered_volume_unit_of_measure	Unidade de medida do volume	String (enum)	Sim
delivery_date	Data da entrega (formato YYYY-MM-DD)	String	Sim
car	Código CAR (Cadastro Ambiental Rural)	String	Não

Respostas

• 201 - Created

{
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "contract_id": "000122",
    "delivered_volume": 10,
    "delivered_volume_unit_of_measure": "ton",
    "delivery_date": "2026-03-02",
    "car": "MT-5107602-ABC123456789"
}

Nota: O campo car só aparece no response quando informado no request (campos nulos são omitidos).

• 400 - Bad Request

{
    "messages": [
        "descricao do erro 1",
        "descricao do erro 2"
    ]
}

Cenário	Mensagem de erro
contract_id ausente	contract_id is required
delivered_volume ausente	delivered_volume is required
delivered_volume_unit_of_measure ausente	delivered_volume_unit_of_measure is required
delivery_date ausente	delivery_date is required
Unidade de medida inválida	delivered_volume_unit_of_measure must be one of: kg, sc, ton
Formato de data inválido	delivery_date must follow the format YYYY-MM-DD
Volume negativo ou zero	delivered_volume must be greater than zero
Body vazio ou JSON malformado	message.malformed-request

• 415 - Unsupported Media Type

Content-Type diferente de application/json.