Exemplo de Requisição
Abaixo está um exemplo de request em formato cURL:
curl --location 'https://apiv3.ideris.com.br/order' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"document": {
"type": "cpf",
"value": "00000000000"
},
"actions": [
{
"action": "exampleAction",
"value": "exampleValue"
}
],
"payments": [
{
"approved": "2023-04-26",
"totalPaidAmount": 90,
"couponAmount": 0.00
}
],
"items": [
{
"item": {
"unitPrice": 90,
"quantity": 1
},
"itemProductAttributes": []
}
]
}'
Regras de Ajuste
Formato de actions como Coleção
O elemento actions espera uma coleção (array). Por isso, deve ser envolvido por colchetes [ ], mesmo que tenha apenas um elemento.
-
Errado:
"actions": {
"action": "exampleAction",
"value": "exampleValue"
}
-
Correto:
"actions": [
{
"action": "exampleAction",
"value": "exampleValue"
}
]
- Outros Elementos que Exigem Coleção
Além de actions, os seguintes campos também esperam coleções:
- payments
- items
- itemProductAttributes
- Certifique-se de que esses campos sejam sempre envoltos em colchetes [ ], mesmo se houver apenas um elemento.
- Campos Decimais no Objeto payments
No objeto payments, alguns campos devem conter valores decimais (≥ 0), como:
- couponAmount
- overpaidAmount
- transactionAmount
-
Exemplo Correto:
"payments": [
{
"couponAmount": 0.00,
"overpaidAmount": 0.00,
"transactionAmount": 10.50
}
]
-
Itens e seus Atributos
Para o campo items, o mesmo deve incluir o subcampo itemProductAttributes, mesmo que vazio:
"items": [
{
"item": {
"unitPrice": 90,
"quantity": 1
},
"itemProductAttributes": []
}
]
Exemplo acima:
Atenção
Chaves { } delimitam a estrutura de um objeto ou seja quais propriedades/características ele vai ter. Colchetes [ ] indique que existe mais de um elemento, é a mesma notação array.
Referência
Para mais detalhes, consulte a documentação oficial no Swagger da API V3:
Documentação API V3
Se precisar de mais ajuda com este processo, nossa equipe de suporte está pronta para atender você. É só clicar no ícone do whatsapp no canto inferior direito de qualquer página do seu painel Ideris ou abrir um ticket.
Conte sempre conosco. Até a próxima!
Comentários
0 comentário
Por favor, entre para comentar.