Pular para o conteúdo
platform
PT EN

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

Listar Contratos da Filial

Método
GET
Rota
/pricing/contract/list/store/:partnerId
URL base
https://ws.autorei.net
Parâmetros de rota
:partnerId
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

Permite que uma conta matriz liste os contratos de preço de uma de suas filiais, do mais recente para o mais antigo, com paginação.

A resposta é idêntica à da listagem da própria loja, a diferença é a filial consultada, que vem na rota e é validada contra os vínculos da sua matriz.

Parâmetros de Rota

Parâmetro Tipo Obrigatório Descrição
partnerId integer Sim Id da filial dona do contrato. Precisa estar vinculada à matriz do token.

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 partnerId da rota não é numérico: {"error":"Invalid target partner ID"}.
400 A loja não tem contrato nenhum na página pedida: {"error":"priceContract.list.empty"}.
401 Token ausente, malformado ou expirado: {"error":"Authentication required for this route"}.
403 A filial não está vinculada à sua matriz: {"error":"Access denied: Invalid partnership"}. Diferente de 400, aqui o payload está certo, o que falta é o vínculo.

Exemplo de requisição

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

Respostas de exemplo

200Sucesso: um contrato

[
  {
    "id": 4610002,
    "name": "Tabela Atacado Filial 2026",
    "active": true,
    "partner": {
      "id": 5057,
      "name": "Loja Exemplo - Filial Campinas",
      "document": "30.424.972/0002-55"
    },
    "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.