Pular para o conteúdo
platform
PT EN

Referência da API · Regra de Preço

Listar Regras de Preço

Método
GET
Rota
/v1/priceRule
URL base
https://ws.autorei.net
Parâmetros de consulta do exemplo
name=Desconto Atacado limit=5
Token
Exige token Bearer
Testar no Postman

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

Lista as regras de preço ativas da sua loja. Regra desativada não aparece aqui.

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
name string Não Filtra pelo nome da regra. Veja O filtro por nome é exato.
limit integer Não Regras por página. Padrão 5, teto 25, valor acima disso é reduzido para 25, sem erro.
offset integer Não Registro inicial da página. Padrão 0.

Regras de negócio

O filtro por nome é exato

name compara o nome inteiro, não um trecho: ?name=Desconto não encontra a regra Desconto Atacado. Envie o nome completo, com os mesmos espaços e acentos do cadastro.

Resposta · 200

Array com uma regra por item, e [] quando nada casa com o filtro.

Campo Tipo Descrição
id integer Id da regra. É o que você usa para desativá-la.
name string Nome da regra.
priority integer Prioridade de aplicação.
type string PERCENT ou REAL.
value number Valor aplicado.
cumulative boolean Se a regra pode somar com outras.
stateRegistration boolean Corresponde ao customerHasStateRegistration que você enviou, o campo troca de nome na resposta.
quantity integer Quantidade mínima do item. null quando não usada.
warehouseState · customerState string UFs configuradas na regra. null quando não usadas.
customerTagId · customerTypeId · customerCnae · customerPaysIcms - Critérios de cliente configurados.
customerTypeName string Nome do tipo de cliente. Vem "" quando a regra não usa customerTypeId.
skuStockId · skuPartnerTagId · skuNcm - Critérios de produto configurados.
isDiscountBlockedByAttendant boolean Se a regra bloqueia desconto do atendente no carrinho.
createdBy string E-mail do usuário que criou a regra, resolvido do seu token.

Erros

Código Quando
400 limit ou offset não numérico: {"error":"invalid limit"}.
401 Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request GET 'https://ws.autorei.net/v1/priceRule?name=Desconto Atacado&limit=5' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: filtrando pelo nome exato

[
  {
    "id": 4210001,
    "name": "Desconto Atacado",
    "priority": 10,
    "type": "PERCENT",
    "value": -5,
    "cumulative": false,
    "stateRegistration": false,
    "isDiscountBlockedByAttendant": false,
    "quantity": 100,
    "warehouseState": null,
    "customerState": null,
    "customerTagId": null,
    "customerCnae": null,
    "customerTypeId": null,
    "customerTypeName": "",
    "customerPaysIcms": false,
    "skuNcm": null,
    "skuStockId": null,
    "skuPartnerTagId": null,
    "createdBy": "integracao@lojaexemplo.com.br"
  }
]

Usado em

Endpoints relacionados

← Ver o grupo: Regra de Preço

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.