Skip to main content

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

AtributosDescriçãoTipoObrigatórioValidações
amountVolumeNumberSimQuantidade referente a unidade de medida escolhida
producer_idId do produtor vinculado a negociaçãoUUIDSimVerifica se é válido
issuer_idId do emissor da negociaçãoUUIDSimVerifica se é válido
currencyMoeda escolhida para negociaçãoEnumSimBRL, USD, EUR
productProduto negociadoEnumSimSOJA, TRIGO, MILHO
delivery_place_idId da unidade de entregaUUIDSimVerifica se é válido
initial_delivery_dateData inicial da entregaDateSimUtilizar o padrão YYYY-MM-DD
end_delivery_dateData final da entregaDateSimUtilizar o padrão YYYY-MM-DD
haverstSafra do produto negociadoStringSimSeguir o padrão 'ano/ano' ou 'ano - Safrinha'. Ex: 2021/2022
modalityModalidade da negociaçãoEnumSimBALCAO, DISPONIVEL
paydayData do pagamentoDateSimUtilizar o padrão YYYY-MM-DD
payment_typeTipo do pagamentoEnumSimDINHEIRO, TROCA
order_typeTipo da negociaçãoEnumSimCOMPRA, FIXACAO_COMPRA, FIXACAO_DEPOSITO
order_dateData do pedidoDateSimUtilizar o padrão YYYY-MM-DD
pricePreço por cada unidade de medidaNumberSimUtilizar o valor com duas casas decimais. Ex: 130.33
unit_of_measurementUnidade de medidaEnumSimSC, KG, TON
shipping.typeModalidade de freteEnumCondicionalFOB, CIF. Caso a campo order_type seja "COMPRA", este atributo passa a ser obrigatório.
shipping.cityCidade em que o produto será entregueStringCondicionalAté 250 caracteres. Caso seja selecionado FOB, este atributo passa a ser obrigatório
shipping.stateEstado em que o produto será entregueStringCondicionalUF. Ex: SP. Caso seja selecionado FOB, este atributo passa a ser obrigatório
shipping.priceCusto do freteNumberNãoUtilizar o valor com duas casas decimais. Ex: 950.33
internal_idCódigo da negociação no erp do clienteStringNãoAté 100 caracteres
descriptionDescriçãoStringNãoAté 250 caracteres
wallet_idIdentificador da carteira vinculada a negociaçãoUUIDSimVerifica 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

NomeDescriçãoTipoObrigatório
AuthorizationStringSim

Parâmetros do Corpo

NomeDescriçãoTipoObrigató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