Criar Nova Negociação
Descrição: Cria uma nova negociação para um usuário específico.
Endpoint
POST/api/v1/integration/order-commitments
Regras
Atributos | Descrição | Tipo | Obrigatório | Validações |
---|---|---|---|---|
amount | Volume | Number | Sim | Quantidade referente a unidade de medida escolhida |
producer_id | Id do produtor vinculado a negociação | UUID | Sim | Verifica se é válido |
issuer_id | Id do emissor da negociação | UUID | Sim | Verifica se é válido |
currency | Moeda escolhida para negociação | Enum | Sim | BRL, USD, EUR |
product | Produto negociado | Enum | Sim | SOJA, TRIGO, MILHO |
delivery_place_id | Id da unidade de entrega | UUID | Sim | Verifica se é válido |
initial_delivery_date | Data inicial da entrega | Date | Sim | Utilizar o padrão YYYY-MM-DD |
end_delivery_date | Data final da entrega | Date | Sim | Utilizar o padrão YYYY-MM-DD |
haverst | Safra do produto negociado | String | Sim | Seguir o padrão 'ano/ano' ou 'ano - Safrinha'. Ex: 2021/2022 |
modality | Modalidade da negociação | Enum | Sim | BALCAO, DISPONIVEL |
payday | Data do pagamento | Date | Sim | Utilizar o padrão YYYY-MM-DD |
payment_type | Tipo do pagamento | Enum | Sim | DINHEIRO, TROCA |
order_type | Tipo da negociação | Enum | Sim | COMPRA, FIXACAO_COMPRA, FIXACAO_DEPOSITO |
order_date | Data do pedido | Date | Sim | Utilizar o padrão YYYY-MM-DD |
price | Preço por cada unidade de medida | Number | Sim | Utilizar o valor com duas casas decimais. Ex: 130.33 |
unit_of_measurement | Unidade de medida | Enum | Sim | SC, KG, TON |
shipping.type | Modalidade de frete | Enum | Condicional | FOB, CIF. Caso a campo order_type seja "COMPRA", este atributo passa a ser obrigatório. |
shipping.city | Cidade em que o produto será entregue | String | Condicional | Até 250 caracteres. Caso seja selecionado FOB, este atributo passa a ser obrigatório |
shipping.state | Estado em que o produto será entregue | String | Condicional | UF. Ex: SP. Caso seja selecionado FOB, este atributo passa a ser obrigatório |
shipping.price | Custo do frete | Number | Não | Utilizar o valor com duas casas decimais. Ex: 950.33 |
internal_id | Código da negociação no erp do cliente | String | Não | Até 100 caracteres |
description | Descrição | String | Não | Até 250 caracteres |
wallet_id | Identificador da carteira vinculada a negociação | UUID | Sim | Verifica se é válido |
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"
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 |
---|---|---|---|
... (todos os atributos listados nas regras) |
Respostas
- 200 - OK
{
"id": "string"
}
- 400 - Bad Request
{
"timestamp": "string (date-time)",
"status": "integer (int32)",
"error": "string"
}
- 401 - Unauthorized