GET
https://www.allpost.com.br/api/v1/transportadora/regrasfrete

Lista as regras de frete da loja com filtros de período, situação de vigência, status, tipo/ação de valor e prazo (paginado)

Módulo: Transportadora

Descrição

Lista as regras de frete da loja autenticada, com filtros opcionais de período, situação de vigência, status do cadastro, tipo/ação de valor e prazo. Retorna um resultado paginado, isolado pela loja do token.

Exemplos:
- https://www.allpost.com.br/api/v1/transportadora/regrasfrete
- https://www.allpost.com.br/api/v1/transportadora/regrasfrete?situacao=vigente&status=a&pagina=1&limite=50
- https://www.allpost.com.br/api/v1/transportadora/regrasfrete?dataTipo=cadastro&dataInicio=2026-01-01&dataFim=2026-08-31

Todos os parâmetros de filtro são opcionais. Sem informar período, retorna as regras cadastradas nos últimos 365 dias (por data de cadastro).

Diferença entre status e situação:
- status: estado do cadastro da regra — ativo (a), inativo (i) ou pendente (p).
- situacao: vigência calculada pela data atual em relação ao período de validade da regra — vigente (em vigor hoje), programada (início no futuro) ou vencida (fim no passado).

Ordenado pela ordem de aplicação da regra (ordena) e, em seguida, pelo código mais recente.

Códigos de retorno:
- 200: sucesso (lista paginada).
- 400: parâmetro inválido (ex.: status, situacao, dataTipo ou datas fora do formato YYYY-MM-DD).
- 401: token ausente, expirado ou inválido.

Parâmetros de Path

Parâmetro Tipo Obrigatório Descrição
codigo inteiro Não Filtra por id da regra de frete.
titulo string Não Busca parcial (ilike) pelo título da regra (até 40 caracteres).
status string Não Estado do cadastro: a (ativo), i (inativo) ou p (pendente).
situacao string Não Vigência calculada: vigente, programada ou vencida.
valorTipo string Não Tipo do valor da ação (ex.: percentual, fixo, bloqueio).
valorAcao string Não Ação sobre o valor (ex.: soma, substitui, desconto).
prazoAcao string Não Ação sobre o prazo (ex.: soma, substitui).
idCampo inteiro Não Filtra regras que utilizam um campo/critério específico (id do campo da regra).
dataTipo string Não Campo de data usado pelo período: cadastro (default), inicio ou fim.
dataInicio string (YYYY-MM-DD) Não Início do período. Default: -365 dias.
dataFim string (YYYY-MM-DD) Não Fim do período. Default: hoje.
pagina inteiro Não Página atual (default: 1).
limite inteiro Não Registros por página (1–200, default: 50).

Parâmetros de Retorno

Campo Tipo Descrição
pagina inteiro Página retornada.
limite inteiro Limite por página usado.
total inteiro Total de regras que atendem ao filtro.
regras[] array Lista de regras de frete.
regras[].codigo inteiro Identificador da regra.
regras[].titulo string Título da regra.
regras[].status string Estado do cadastro: "ativo", "inativo" ou "pendente".
regras[].situacao string Vigência calculada: "vigente", "programada" ou "vencida".
regras[].valorTipo string Tipo do valor da ação.
regras[].valorAcao string Ação sobre o valor.
regras[].valor número Valor aplicado pela ação.
regras[].prazoAcao string Ação sobre o prazo.
regras[].prazo inteiro Prazo (em dias) aplicado pela ação.
regras[].dataInicio string ISO 8601 Início da vigência da regra.
regras[].dataFim string ISO 8601 Fim da vigência da regra.
regras[].dataCadastro string ISO 8601 Data de cadastro da regra.
regras[].ordem inteiro Ordem de aplicação da regra.
regras[].idUsuario inteiro Id do usuário que cadastrou.
regras[].usuario string Nome do usuário que cadastrou.
regras[].usuarioEmail string E-mail do usuário que cadastrou.
regras[].campos array de string Nomes dos campos/critérios usados pela regra.

Response

{
  "pagina": 1,
  "limite": 50,
  "total": 3,
  "regras": [
    {
      "codigo": 1287,
      "titulo": "Frete grátis acima de R$ 199 - Sudeste",
      "status": "ativo",
      "situacao": "vigente",
      "valorTipo": "percentual",
      "valorAcao": "desconto",
      "valor": 100,
      "prazoAcao": "soma",
      "prazo": 0,
      "dataInicio": "2026-01-01T00:00:00",
      "dataFim": "2026-12-31T23:59:59",
      "dataCadastro": "2025-12-20T14:32:10",
      "ordem": 3,
      "idUsuario": 812,
      "usuario": "Maria Souza",
      "usuarioEmail": "maria@lojaexemplo.com.br",
      "campos": ["Faixa de CEP", "Faixa de Valor do Pedido"]
    },
    {
      "codigo": 1301,
      "titulo": "Bloqueio de PAC para SKUs frágeis",
      "status": "ativo",
      "situacao": "programada",
      "valorTipo": "bloqueio",
      "valorAcao": "substitui",
      "valor": 999999,
      "prazoAcao": "soma",
      "prazo": 0,
      "dataInicio": "2026-10-01T00:00:00",
      "dataFim": "2026-11-30T23:59:59",
      "dataCadastro": "2026-08-15T09:10:00",
      "ordem": 8,
      "idUsuario": 812,
      "usuario": "Maria Souza",
      "usuarioEmail": "maria@lojaexemplo.com.br",
      "campos": ["SKU", "Transportadora", "Método de Envio"]
    }
  ]
}