API reference · Price Rule

List Price Rules

Method: GET
Route: /v1/priceRule
Base URL: https://ws.autorei.net
Query parameters in the example: name=Desconto Atacado limit=5
Token: Requires Bearer token

Opens this request in the public API documentation, the official source of the reference.

Description

Lists the active price rules of your store. A deactivated rule does not appear here.

Query parameters

Parameter	Type	Required	Description
`name`	string	No	Filters by rule name. See The name filter is exact.
`limit`	integer	No	Rules per page. Default 5, cap 25 — a value above that is reduced to 25, with no error.
`offset`	integer	No	Starting record of the page. Default 0.

Business rules

The name filter is exact

name compares the full name, not a fragment: ?name=Desconto does not find the rule Desconto Atacado. Send the full name, with the same spaces and accents as in the registration.

Response · 200

Array with one rule per item, and [] when nothing matches the filter.

Field	Type	Description
`id`	integer	Rule id. It is what you use to deactivate it.
`name`	string	Rule name.
`priority`	integer	Application priority.
`type`	string	`PERCENT` or `REAL`.
`value`	number	Value applied.
`cumulative`	boolean	Whether the rule can be added to others.
`stateRegistration`	boolean	Corresponds to the `customerHasStateRegistration` you sent — the field changes name in the response.
`quantity`	integer	Minimum quantity of the item. `null` when not used.
`warehouseState` · `customerState`	string	States (UF) configured in the rule. `null` when not used.
`customerTagId` · `customerTypeId` · `customerCnae` · `customerPaysIcms`	—	Configured customer criteria.
`customerTypeName`	string	Customer type name. Comes as `""` when the rule does not use `customerTypeId`.
`skuStockId` · `skuPartnerTagId` · `skuNcm`	—	Configured product criteria.
`isDiscountBlockedByAttendant`	boolean	Whether the rule blocks the attendant's discount in the cart.
`createdBy`	string	E-mail of the user who created the rule, resolved from your token.

Errors

Code	When
400	Non-numeric `limit` or `offset`: `{"error":"invalid limit"}`.
401	Token missing, malformed or expired.

Example request

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

Example responses

200Success — filtering by exact name

[
  {
    "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"
  }
]

Used in

POST Create Price Rule /v1/priceRule
DELETE Delete Price Rule /v1/priceRule/:id

← See the group: Price Rule

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.