Skip to content

Genius Returns - API reference (1.0.0)

Documentação e referências da api Genius Retuns.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://apidocs.geniusreturns.com.br/_mock/openapi/

Produção

https://integration.geniusreturns.com.br/

QA

https://integration-qa.geniusreturns.com.br/

Segurança

Operações de autenticação e segurança (obtenção do Bearer JWT).

Operations

Processos

Operações para obter, listar, filtrar e criar processos de troca ou devolução.

Operations

Produtos

Ações relativas aos produtos constantes em uma solicitação de troca ou devolução.

Operations

Informar o rating de um ou mais produtos de uma solicitação de troca ou devolução

Request

Security
BearerAuth
Bodyapplication/jsonrequired
processoIdinteger(int64)>= 1required

Identificador do processo (solicitação de troca ou devolução).

executarFluxoReembolsoboolean or null

Se verdadeiro, inicia o fluxo automático de reembolso do cliente.

ratingDataArray of objects(RatingDataModel)non-emptyrequired

Lista de dados de análise (rating) por item.

ratingData[].​itemIdstringrequired

Identificador do item na plataforma Genius Returns.

ratingData[].​itemNomestring or null

Nome do item analisado. Opcional; se não informado, será auto preenchido.

ratingData[].​ratingValornumber(double)[ 1 .. 5 ]required

Nota atribuída pela análise (1 a 5), onde 5 significa "perfeito estado do item".

ratingData[].​comentariostring or null

Comentários livres sobre a análise do item.

ratingData[].​estadoIteminteger[ 1 .. 4 ]required

Estado do item após recebimento: 1=Perfeito, 2=Pequena avaria, 3=Não aproveitável, 4=Não recebido.

ratingData[].​naoEstornarboolean

Se verdadeiro, o item será removido do cálculo de reembolso.

ratingData[].​naoEstornarQtdinteger>= 0

Quantidade a não estornar. Obrigatória (>0) quando 'naoEstornar' for verdadeiro; caso contrário, deve ser 0.

ratingData[].​notificarClienteRatingboolean

Se verdadeiro, envia e-mail ao cliente com o resultado da análise.

ratingData[].​qtdinteger>= 1required

Quantidade do item que foi analisado.

curl -i -X POST \
  https://apidocs.geniusreturns.com.br/_mock/openapi/v3/pvt/Produto/rating \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "processoId": 12345,
    "executarFluxoReembolso": false,
    "ratingData": [
      {
        "itemId": "SKU-001",
        "itemNome": "Camiseta Polo Azul",
        "ratingValor": 5,
        "comentario": "Produto em perfeito estado",
        "estadoItem": 1,
        "naoEstornar": false,
        "naoEstornarQtd": 0,
        "notificarClienteRating": true,
        "qtd": 1
      }
    ]
  }'

Responses

Rating registrado com sucesso

Bodyapplication/json
Datestring(date-time)

Data e hora da resposta expressa em UTC

Resultstring

Entidade relacionada

Recordsinteger(int32)

Registros retornados

HttpStatusstring

Status http da requisição

Errobject(ApiResponseErro)

Conterá detalhes de um eventual erro

Response
application/json
{
  "Date": "2019-08-24T14:15:22Z",
  "Result": "string",
  "Records": 0,
  "HttpStatus": "string",
  "Err": {
    "ErroCodigo": "string",
    "ErroDescricao": "string"
  }
}

Notas de devolução

Operações com notas fiscais de devolução.

Operations