Skip to content

Listar processos

Request

Retorna uma lista paginada de processos conforme filtros informados. Observação: os filtros também podem ser enviados no corpo (JSON), conforme exemplo de curl, caso seu cliente HTTP suporte body em requisições GET.

Security
BearerAuth
Query
pageNumberinteger, >= 1

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

pageSizeinteger, >= 1

Quantidade de itens por página.

destring, (date)

Data inicial (YYYY-MM-DD).

atestring, (date)

Data final (YYYY-MM-DD).

statusinteger

Status do processo (Todos = -1, Pendente = 1, Concluido = 2, Cancelado = 3).

textoBuscastring

Número do pedido, nome/email do cliente ou nº de autorização.

lojaVirtualIdinteger, (int64)

Id da loja virtual (sub account).

orderNumberstring

Número do pedido original na loja virtual.

estagioLogisticointeger

Estágio logístico do processo (EProcessLogisticStage).

estagioFinanceirointeger

Estágio financeiro do processo (EProcessFinancialStage).

estagioRatinginteger

Estágio rating do processo (EProcessRatingStage).

Bodyapplication/json
destring, (date)

Data inicial (YYYY-MM-DD).

atestring, (date)

Data final (YYYY-MM-DD).

statusinteger

Status do processo (Todos = -1, Pendente = 1, Concluido = 2, Cancelado = 3).

textoBuscastring

Número do pedido (e-commerce), nome/email do cliente ou nº de autorização.

lojaVirtualIdinteger, (int64)

Id da loja virtual (sub account).

orderNumberstring

Número do pedido original na loja virtual.

estagioLogisticointeger, (int32)(EProcessLogisticStage)

Estágio logístico do processo.

Enum:"Nenhum""Pendente""Erro"[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loja física"},"children":[]}]}]}]"Autorizado""Postado ou coletado""Entregue""Parcialmente Entregue"
estagioFinanceirointeger, (int32)(EProcessFinancialStage)

Estágio financeiro do processo.

Enum:"Nenhum""Pendente""Reembolso parcial""Reembolso efetuado""Erro"
estagioRatinginteger, (int32)(EProcessRatingStage)

Estágio de rating do processo.

Enum:"Pendente""Parcial""Completo"
curl --location --request GET 'https://integration.geniusreturns.com.br/v3/pvt/processo/listar?pageNumber=1&pageSize=10' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/json' \
--data '{
    "de": "2025-05-01",
    "ate": "2025-05-28",
    "textoBusca": "12372-52025",
    "estagioLogistico": 3
}'

Responses

Lista de processos retornada com sucesso.

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

Data e hora da resposta expressa em UTC

ResultArray of objects(ProcessModel)required

Entidade relacionada

Recordsinteger

Registros retornados

HttpStatusstring

Status http da requisição

Errobject or null(ApiResponseErro)

Conterá detalhes de um eventual erro

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