Atualização Volumes Entregues

Descrição: Atualiza o volume entregue de uma negociação.

Endpoint

POST/api/v1/integration/order-commitments/{commitment_id}:deliveredVolume

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
commitment_id	Identificador da negociação na plataforma Merx.	UUID	Sim

Exemplo de Requisição

Exemplo de Requisição

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json;charset=UTF-8"\
"https://homolog.api.merx.tech/api/v1/integration/order-commitments/5845e12f-1656-4118-9890-e7c808fd9185:deliveredVolume"
--data '{
  "total_delivered": 0.06,
  "unit_of_measurement": 'SC',
     }'

Exemplo de Requisição de Entrega Parcial

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json;charset=UTF-8"\
"https://homolog.api.merx.tech/api/v1/integration/order-commitments/5845e12f-1656-4118-9890-e7c808fd9185:deliveredVolume"
--data '{
  "total_delivered": 50,
  "unit_of_measurement": 'SC',
  "delivery_mode": "PARTIAL"
  }'

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization		String	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório	Validações
total_delivered	Volume alocado desejado,valor decimal (tamanho total 11 com 2 casas) decimais	Number	Sim
unit_of_measurement	Unidade de medida	Enum	Sim	SC,KG,TON
delivery_mode	Modo de Entrega	Enum	Não	Verifica se a atualização é referente à uma entrega total (FULL) ou parcial (PARTIAL). A atualização total (FULL) substitui o volume entregue até o momento, já a atualização parcial (PARTIAL) incrementa o volume entregue até o momento. Exemplo: Há uma negociação com um volume entregue de 10 toneladas. Se for feita uma requisição com delivery_mode = FULL e um total_delivered = 15, o volume entregue após a atualização será 15 toneladas. Se o delivery_mode fosse igual a PARTIAL, o volume entregue após a atualização seria 25. Caso nenhum valor seja informado, o sistema utilizará por padrão o modo de entreg FULL

Respostas

• 204 - No content

• 400 - Bad Request

{
    "timestamp": "string (date-time)",
    "status": "integer (int32)",
    "error": "string"
}

• 401 - Unauthorized