GET Distribuicao amostra - Varejonline/api GitHub Wiki
URLs
GET https://integrador.varejonline.com.br/apps/api/distribuicao-amostra
GET https://integrador.varejonline.com.br/apps/api/distribuicao-amostra/:id
Parâmetros
- inicio: Entenda a Coleta Paginada
- quantidade: Entenda a Coleta Paginada
- apenasVigenciaPermanente: apenas distribuições com vigência permanente (boolean)
- somenteAtivos: apenas distribuições que estão ativas (boolean)
- observacao: observação da distribuição (string)
- idObjetivo: id do objetivo comercial (long)
Retorno
- id: identificador da distribuição (long)
- entidades: informações das entidades (objeto complexo)
- id: identificador da entidade (long)
- nome: nome da entidade (string)
- documento: número do documento da entidade (string)
- descricao: descrição da distribuição (string)
- objetivo: objetivo comercial (objeto complexo)
- id: identificador do objetivo (long)
- nome: nome do objetivo (string)
- vigenciaPermanente: indica se a vigência é permanente (boolean)
- vigenciaInicial: data de vigência inicial (string)
- vigenciaFinal: data de vigência final (string)
- observacao: observação da distribuição (string)
- considerarTodoEstoque: indica se será considerado todo o estoque (boolean)
- unicaPorCliente: caso considere todo o estoque, indica se será única por cliente (boolean)
- ativo: indica se a distribuição está ativa (boolean)
- dadosProdutos: informações dos produtos (objeto complexo)
- produto: (obrigatório se existir itens. Informar um dos critérios para busca do produto. Utiliza-se o primeiro critério da ordem)
- id: id do produto (long)
- codigoSistema: código de sistema do produto. (string)
- codigoInterno: código interno do produto. (string)
- codigoBarras: código de barras do produto. (string)
- limitarQuantidade: indica se a quantidade será limitada (boolean)
- quantidadeDistribuir: se for limitada, quantidade que será distribuída (Number)
- unicaPorCliente: indica se será única por cliente (boolean)
- produto: (obrigatório se existir itens. Informar um dos critérios para busca do produto. Utiliza-se o primeiro critério da ordem)
Exemplo
GET https://integrador.varejonline.com.br/apps/api/distribuicao-amostra
[
{
"id": 1,
"descricao": "Junto a venda",
"dadosProdutos": [],
"ativo": true,
"considerarTodoEstoque": true,
"vigenciaPermanente": true,
"unicaPorCliente": false
}
]