POST Distribuicao amostra - Varejonline/api GitHub Wiki

URLs

POST https://integrador.varejonline.com.br/apps/api/distribuicao-amostra

Parâmetros

Envie um JSON no corpo da requisição, contendo:

  • id: identificador da distribuição (long)
  • entidades: informações das entidades (objeto complexo)
    • id: identificador da entidade (long)
  • 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)

Retorno

Retorna um Json com informações do resultado da operação realizada, contendo:

  • idRecurso: id do produto gerado.
  • codigoMensagem: Código de identificação da operação realizada. veja a lista de Códigos
  • mensagem: Mensagem da operação realizada

Exemplo

POST https://integrador.varejonline.com.br/apps/api/distribuicao-amostra

{
    "descricao": "Abaixar estoque",
    "entidades": [
        {
            "id": 3,
        },
        {
            "id": 9,
        }
    ],
    "dadosProdutos": [
        {
            "produto": {
                "id": 269
            },
            "unicaPorCliente": false,
            "limitarQuantidade": true,
            "quantidadeDistribuir": 5
        }
    ],
    "objetivo": {
        "id": 1
    },
    "observacao": "TESTE",
    "considerarTodoEstoque": false,
    "unicaPorCliente": false,
    "vigenciaPermanente": true
}