Pular para o conteúdo
platform
PT EN

Referência da API · Contratos · Gestão loja

Listar Contratos

Método
GET
Rota
/pricing/contract/list
URL base
https://ws.autorei.net
Parâmetros de consulta do exemplo
limit=20 offset=0
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 os contratos de preço da sua loja, do mais recente para o mais antigo, com paginação.

A listagem devolve o cabeçalho de cada contrato. Os clientes e os produtos de um contrato não vêm aqui.

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
limit integer Não Contratos por página. Default 20, teto 50. Acima do teto, vale o teto.
offset integer Não Quantos contratos pular. Default 0.

Resposta · 200

Array de contratos, cada um no mesmo formato da resposta da criação.

Campo Descrição
id Id do contrato.
name Nome do contrato.
active Contrato ativo.
partner.id Id do parceiro dono do contrato.
partner.name · partner.document Nome e documento do parceiro dono do contrato.
allCustomers · allPartners Abrangência do contrato.
priority Prioridade do contrato.
dateStart · dateEnd Vigência, em UTC.
dateCreated · lastUpdated Criação e última alteração, em UTC.
priceBeforeAfter Preço anterior habilitado.
contractType BASIC ou COUNTDOWN.
isDiscountBlockedByAttendant Bloqueio de desconto pelo atendente.
priceContractPartners Ids das filiais em que o contrato vale.
priceContractStates UFs em que o contrato vale.
priceContractCustomerGroups Ids dos grupos de clientes do contrato.
priceContractStores Ids das lojas em que o contrato vale.

Erros

Código Quando
400 A loja não tem contrato nenhum na página pedida: {"error":"priceContract.list.empty"}.
401 Token ausente, malformado ou expirado.

Exemplo de requisição

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

Respostas de exemplo

200Sucesso: um contrato

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

Usado em

Endpoints relacionados

← Ver o grupo: Contratos

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