Skip to content
/
Obtém uma nota de devoluç...

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

Lista as notas fiscais de devolução por processo

Request

Security
BearerAuth
Query
processoIdinteger(int64)required

Id do processo relacionado às notas fiscais de devolução

pageNumberinteger>= 1

Número da página (inicia em 1).

pageSizeinteger>= 1

Quantidade de itens por página.

curl -i -X GET \
  'https://apidocs.geniusreturns.com.br/_mock/openapi/v3/pvt/fiscal?processoId=0&pageNumber=1&pageSize=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista retornada com sucesso

Bodyapplication/json
PageSizeinteger
TotalPagesinteger
CurrentPageinteger
TotalRecordsinteger
Datestring(date-time)

Data e hora da resposta expressa em UTC

ResultArray of objects(ReturnNoteModel)

Entidade relacionada

Recordsinteger

Registros retornados

HttpStatusstring

Status http da requisição

Errobject(ApiResponseErro)

Conterá detalhes de um eventual erro

Response
application/json
{
  "PageSize": 0,
  "TotalPages": 0,
  "CurrentPage": 0,
  "TotalRecords": 0,
  "Date": "2019-08-24T14:15:22Z",
  "Result": [
    { … }
  ],
  "Records": 0,
  "HttpStatus": "string",
  "Err": {
    "ErroCodigo": "string",
    "ErroDescricao": "string"
  }
}

Obtém uma nota de devolução por ID

Request

Security
BearerAuth
Path
idinteger(int64)required

Id da nota fiscal de devolução

curl -i -X GET \
  'https://apidocs.geniusreturns.com.br/_mock/openapi/v3/pvt/fiscal/{id}' \
  -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
{
  "Date": "2019-08-24T14:15:22Z",
  "Result": {
    "numero": "string",
    "serie": "string",
    "chave": "string",
    "xml": "string",
    "danfeLink": "string",
    "data": "2019-08-24T14:15:22Z",
    "arquivo": "string"
  },
  "Records": 0,
  "HttpStatus": "string",
  "Err": {
    "ErroCodigo": "string",
    "ErroDescricao": "string"
  }
}