A entidade divisões dos clientes controla de quais divisões cada cliente pode comprar.
Ela é destinada às contas de indústria configuradas para trabalhar com divisões. Nas contas que não trabalham com divisões, os endpoints desta entidade respondem 412. Para consultar e criar as divisões em si, utilize a entidade Divisões.
Cada registro é um vínculo entre uma divisão e um cliente. Um cliente pode estar vinculado a mais de uma divisão.
O guia Indústrias com divisões explica o modelo completo: os nomes dos campos por tipo de conta, onde o filtro ?divisao_id= funciona e quais erros a API devolve.
Filtros disponíveis
Você pode aplicar os seguintes filtros na consulta GET:
- divisao_id: retorna apenas os vínculos de uma divisão
- cliente_id: retorna apenas os vínculos de um cliente
- alterado_apos: retorna apenas os vínculos alterados após a data e hora informadas
- ultimo_id: retorna apenas os vínculos com
idmaior que o informado, para paginar consultas grandes
Exemplo: ?divisao_id=987&cliente_id=12345
Nesta consulta, o filtro
representada_idretorna412. Utilizedivisao_id.
Estrutura de Retorno (GET)
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único do vínculo no Mercos. |
| divisao_id | Integer | Identificador da divisão vinculada ao cliente. |
| cliente_id | Integer | Identificador do cliente vinculado à divisão. |
| excluido | Boolean | Indica se o vínculo está excluído. |
| ultima_alteracao | DateTime | Data e hora da última modificação deste vínculo no Mercos. |
Parâmetros do JSON de envio (POST)
Os dois campos são obrigatórios.
| Campo | Tipo | Descrição |
|---|---|---|
| cliente_id (obrigatório) | Integer | Identificador do cliente no Mercos. |
| divisoes_ids (obrigatório) | Array de Integer | Identificadores das divisões das quais o cliente pode comprar. |
A lista enviada em
divisoes_idssubstitui os vínculos que o cliente já tem: as divisões que não estiverem na lista são desvinculadas. Envie uma lista vazia para desvincular o cliente de todas as divisões.
O envio não devolve corpo na resposta: o sucesso é indicado pelo status 200.
Liberar todas as divisões (POST /liberar_todas)
Para liberar todas as divisões da conta a um cliente, utilize POST /v1/divisoes_clientes/liberar_todas
informando apenas o cliente_id. A operação remove os vínculos que o cliente tem — sem vínculos, ele pode
comprar de todas as divisões. É o equivalente ao liberar_todas de tabelas de preço, categorias e condições
de pagamento.
| Campo | Tipo | Descrição |
|---|---|---|
| cliente_id (obrigatório) | Integer | Identificador do cliente no Mercos. |
O envio não devolve corpo na resposta: o sucesso é indicado pelo status 200.