Skip to content
platform
EN PT

API reference · Contracts · Store Management

List Contracts

Method
GET
Route
/pricing/contract/list
Base URL
https://ws.autorei.net
Query parameters in the example
limit=20 offset=0
Token
Requires Bearer token
Test in Postman

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

Description

Lists the price contracts of your store, from newest to oldest, with pagination.

The list returns the header of each contract. The customers and products of a contract do not come here.

Query Parameters

Parameter Type Required Description
limit integer No Contracts per page. Default 20, ceiling 50. Above the ceiling, the ceiling applies.
offset integer No How many contracts to skip. Default 0.

Response · 200

Array of contracts, each in the same format as the creation response.

Field Description
id Contract id.
name Contract name.
active Active contract.
partner.id Id of the partner that owns the contract.
partner.name · partner.document Name and document of the partner that owns the contract.
allCustomers · allPartners Contract scope.
priority Contract priority.
dateStart · dateEnd Validity, in UTC.
dateCreated · lastUpdated Creation and last change, in UTC.
priceBeforeAfter Previous price enabled.
contractType BASIC or COUNTDOWN.
isDiscountBlockedByAttendant Discount block for the sales rep.
priceContractPartners Ids of the branches where the contract is valid.
priceContractStates States where the contract is valid.
priceContractCustomerGroups Ids of the contract customer groups.
priceContractStores Ids of the stores where the contract is valid.

Errors

Code When
400 The store has no contract at all on the requested page: {"error":"priceContract.list.empty"}.
401 Token missing, malformed or expired.

Example request

curl --request GET 'https://ws.autorei.net/pricing/contract/list?limit=20&offset=0' \
  --header 'Authorization: Bearer {{access_token}}'

Example responses

200Success — one contract

[
  {
    "id": 4610001,
    "name": "Tabela Atacado 2026",
    "active": true,
    "partner": {
      "id": 5050,
      "name": "Loja Exemplo",
      "document": "30.424.972/0001-74"
    },
    "allCustomers": false,
    "allPartners": false,
    "priority": 10,
    "dateStart": "2026-09-01T00:00:00Z",
    "dateEnd": "2027-06-30T00:00:00Z",
    "dateCreated": "2026-09-04T13:22:32.687284Z",
    "lastUpdated": "2026-09-04T13:22:32.687284Z",
    "priceBeforeAfter": null,
    "contractType": "BASIC",
    "isDiscountBlockedByAttendant": false,
    "priceContractPartners": [],
    "priceContractStates": [
      "SP",
      "MG"
    ],
    "priceContractCustomerGroups": [
      4610101
    ],
    "priceContractStores": []
  }
]

Used in

Related endpoints

← See the group: Contracts

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