Histórico de entregas

GET

/v1/webhooks/entregas

const url = 'https://sandbox-api.eagleix-corban.com.br/v1/webhooks/entregas?status=PENDENTE&limite=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://sandbox-api.eagleix-corban.com.br/v1/webhooks/entregas?status=PENDENTE&limite=50' \
  --header 'Authorization: Bearer <token>'

As entregas mais recentes do webhook, com a última tentativa de cada uma.

Autorizações

canalOAuth

Parâmetros

Query Parameters

status

string

Allowed values: PENDENTE ENTREGUE FALHOU

limite

integer

default: 50 >= 1 <= 100

Respostas

200

Entregas, da mais recente para a mais antiga.

application/json

object

entregas

required

Array<object>

object

required

string format: uuid

eventoId

required

string format: uuid

tipo

required

string

status

required

string

Allowed values: PENDENTE ENTREGUE FALHOU

tentativas

required

integer

proximaTentativaEm

string format: date-time

ultimoHttpStatus

integer

ultimoErro

string

ultimaLatenciaMs

integer

ultimaTentativaEm

string format: date-time

entregueEm

string format: date-time

criadoEm

required

string format: date-time

Example

{
  "entregas": [
    {
      "status": "PENDENTE"
    }
  ]
}

400

Filtro inválido (status_invalido, limite_invalido).

application/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized"
}

401

Token ausente, inválido ou expirado.

application/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized",
  "message": "token inválido ou expirado",
  "requestId": "8d1f0c2a9b7e4c3d2a1b0f9e"
}

Headers

WWW-Authenticate

string

Example

Bearer error="invalid_token"

404

Nenhum webhook cadastrado (nao_encontrado).

application/json

object

code

required

Código estável, para tratamento programático.

string

message

required

Mensagem legível (pt-BR).

string

requestId

Id da requisição, igual ao header X-Request-Id.

string

Example

{
  "code": "unauthorized"
}