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

Notas de devolução

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

Operations

Adiciona uma nota fiscal de devolução

Request

Adiciona uma nota fiscal de devolução ao processo informado. Retorna BadRequest caso o processo não seja encontrado ou já exista uma nota com o mesmo número.

Security
BearerAuth
Path
processoIdinteger(int64)required

Id do processo relacionado à nota fiscal de devolução

Bodyapplication/jsonrequired

Dados da nota fiscal de devolução

numerostring

Número da nota fiscal

seriestring

Série da nota fiscal

chavestring

Chave de acesso da nota fiscal

xmlstring

XML da nota fiscal

danfeLinkstring

Link do DANFE

datastring or null(date-time)

Data da nota fiscal

arquivostring

Arquivo da nota fiscal

curl -i -X POST \
  'https://apidocs.geniusreturns.com.br/_mock/openapi/v3/pvt/Fiscal/{processoId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "numero": "string",
    "serie": "string",
    "chave": "string",
    "xml": "string",
    "danfeLink": "string",
    "data": "2019-08-24T14:15:22Z",
    "arquivo": "string"
  }'

Responses

Sucesso

Bodyapplication/json
Datestring(date-time)

Data e hora da resposta expressa em UTC

Resultobject(SavedReturnNoteModel)

Representa uma nota de devolução salva.

Recordsinteger

Registros retornados

HttpStatusstring

Status http da requisição

Errobject(ApiResponseErro)

Conterá detalhes de um eventual erro

Response
application/json
{
  "dataHoraResposta": "2025-08-16T01:00:00Z",
  "entidade": {
    "numero": "12345",
    "serie": "1",
    "chave": "35250213513325004530550010005043041184240508",
    "xml": "<xml>...</xml>",
    "danfeLink": "",
    "data": "2025-08-15T12:00:00Z",
    "arquivo": "NFe_12345.xml",
    "id": 1000,
    "processoId": 12493
  },
  "registros": 1,
  "httpStatus": "200",
  "erroCodigo": null,
  "erroDescricao": null,
  "erroDetalhado": null,
  "erroTipo": null
}

Atualiza uma nota fiscal de devolução

Request

Atualiza uma nota fiscal de devolução. Retorna BadRequest caso não sejam encontrados o processo ou a nota, ou já exista outra nota com o mesmo número. A nota atualizada será automaticamente ativada, caso esteja inativa.

Security
BearerAuth
Path
processoIdinteger(int64)required

Id do processo relacionado à nota fiscal de devolução

notaFiscalIdinteger(int64)required

Id da nota de devolução que será atualizada

Bodyapplication/jsonrequired

Dados atualizados da nota fiscal de devolução

numerostring

Número da nota fiscal

seriestring

Série da nota fiscal

chavestring

Chave de acesso da nota fiscal

xmlstring

XML da nota fiscal

danfeLinkstring

Link do DANFE

datastring or null(date-time)

Data da nota fiscal

arquivostring

Arquivo da nota fiscal

curl -i -X PUT \
  'https://apidocs.geniusreturns.com.br/_mock/openapi/v3/pvt/Fiscal/{processoId}/{notaFiscalId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "numero": "string",
    "serie": "string",
    "chave": "string",
    "xml": "string",
    "danfeLink": "string",
    "data": "2019-08-24T14:15:22Z",
    "arquivo": "string"
  }'

Responses

Sucesso

Bodyapplication/json
Datestring(date-time)

Data e hora da resposta expressa em UTC

Resultobject(ReturnNoteModel)

Representa uma nota de devolução

Recordsinteger

Registros retornados

HttpStatusstring

Status http da requisição

Errobject(ApiResponseErro)

Conterá detalhes de um eventual erro

Response
application/json
{
  "dataHoraResposta": "2025-08-16T02:00:00Z",
  "entidade": {
    "numero": "12345",
    "serie": "1",
    "chave": "35250213513325004530550010005043041184240508",
    "xml": "<xml>...</xml>",
    "danfeLink": "",
    "data": "2025-08-15T12:00:00Z",
    "arquivo": "NFe_12345.xml",
    "id": 1000,
    "processoId": 12493
  },
  "registros": 1,
  "httpStatus": "200",
  "erroCodigo": null,
  "erroDescricao": null,
  "erroDetalhado": null,
  "erroTipo": null
}

Inativa uma nota fiscal de devolução

Request

Inativa uma nota fiscal de devolução. Retorna BadRequest caso o processo ou a nota não sejam encontrados pelos identificadores informados.

Security
BearerAuth
Path
processoIdinteger(int64)required

Id do processo relacionado à nota fiscal de devolução

notaFiscalIdinteger(int64)required

Id da nota de devolução que será atualizada

curl -i -X PATCH \
  'https://apidocs.geniusreturns.com.br/_mock/openapi/v3/pvt/Fiscal/{processoId}/{notaFiscalId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso

Bodyapplication/json
Datestring(date-time)

Data e hora da resposta expressa em UTC

Resultobject(ReturnNoteModel)

Representa uma nota de devolução

Recordsinteger

Registros retornados

HttpStatusstring

Status http da requisição

Errobject(ApiResponseErro)

Conterá detalhes de um eventual erro

Response
application/json
{
  "dataHoraResposta": "2025-08-16T01:10:00Z",
  "entidade": {
    "numero": "12345",
    "serie": "1",
    "chave": "35250213513325004530550010005043041184240508",
    "xml": "<xml>...</xml>",
    "danfeLink": "",
    "data": "2025-08-15T12:00:00Z",
    "arquivo": "NFe_12345.xml",
    "id": 1000,
    "processoId": 12493
  },
  "registros": 1,
  "httpStatus": "200",
  "erroCodigo": null,
  "erroDescricao": null,
  "erroDetalhado": null,
  "erroTipo": null
}