GET Rascunho Produtos - Varejonline/api GitHub Wiki

URLs

GET https://integrador.varejonline.com.br/apps/api/rascunho-produtos

GET https://integrador.varejonline.com.br/apps/api/rascunho-produtos/:id

Parâmetros

Retorno

  • id: Id do rascunho
  • descricao: Descrição do produto
  • nomeSimplificado: Nome simplificado do produto
  • codigoSistema: Código sistema do produto
  • produtoBaseSeminovo: Id do produto seminovo relacionado
  • produtoEquivalente: Id do produto equivalente relacionado
  • tags: Tags do produto
  • codigoNcm: Código NCM do produto
  • codigoCest: Código CEST do produto
  • fci: número de controle da Ficha de Conteúdo de Importação. (string)
  • origem: número de 0 a 7 que representa a origem do produto segundo a receita federal (string)
  • classificacao: Classificação do produto, que indica a finalidade para a qual o produto será utilizado. Pode assumir um dos seguintes valores: PRODUCAO_PROPRIA, REVENDA, ATIVO_IMOBILIZADO, CONSUMO, INSUMO (string)
  • fabricante: Id do fabricante
  • codigoInterno: Código interno do produto (string)
  • especificacao: especificação do produto (string)
  • encomenda: Indicador de encomenda (boolean)
  • sinal: Sinal do produto (numerico)
  • previsaoEntrega: Previsão de entrega (inteiro)
  • disponivelMarketplace: Indicador de disponibilidade no marketplace (boolean)
  • disponivelEcommerce: Indicador de disponibilidade no ecommerce (boolean)
  • amostraGratis: Indicador de amostra gratis(boolean)
  • valePresente: Informações para vale presente (objeto complexo)
    • controleNumeracao: tipo do controle de numeração (AUTOMATICO, MANUAL) (string)
    • usoUnico: uso único (booleano)
    • controlaValidade: controle de validade (booleano)
    • periodoValidadeTipo: tipo do periodo de validade (DIAS, MESES, ANOS) (string)
    • periodoValidadeValor: tempo do periodo de validade (numerico)
    • formatoValePresente: formato do vale presente (FISICO, DIGITAL, AMBOS) (string)
  • codigoBarras: código de barras do produto (string)
  • codigosBarraAdicionais: lista de códigos de barras adicionais do produto (Lista de string)
  • unidade: sigla da unidade do produto (string)
  • unidadeExportacao: sigla da unidade de exportação do produto (string)
  • status: Status do rascunho (INCOMPLETO ou COMPLETO) (string)
  • fichasTecnicas: Dados dos itens que compõem a ficha técnica do produto
    • produto: Produto presente na ficha técnica
      • id: id do produto (long)
      • descricao: Descricao do produto (string)
      • codigoBarras: Código de barras do produto (string)
      • codigoInterno: Código interno do produto (string)
      • codigoSistema: Código sistema do produto (string)
    • quantidade: Quantidade de peças do item na ficha técnica (decimal)
    • precoVenda: Preço de venda (decimal)
  • dadosPorEntidade: Lista de Configurações por Entidade do Produto (opcional)
    • entidade: Id da entidade (long) (obrigatório)
    • estoqueMinimo: Estoque mínimo referencial do produto na entidade (decimal) (obrigatório)
    • estoqueMaximo: Estoque máximo referencial do produto na entidade (decimal) (obrigatório)
    • codBeneficioFiscal: Código do benefício fiscal do produto na entidade (string) (opcional)
    • codBeneficioFiscalRbc: Código do benefício fiscal RBC do produto na entidade (string) (opcional)
    • codBeneficioFiscalCp: Código do crédito presumido do produto na entidade (string) (opcional)
    • percentualCreditoPresumido: Percentual do crédito presumido do produto na entidade (decimal) (opcional)
  • valorAtributos: combinação de atributos da grade que geraram este produto. (Obrigatório para itens de grade)
    • nome: nome do atributo da grade (string) (obrigatório)
    • valor: valor do atributo para este produto (string) (obrigatório)
    • codigo: código do valor do atributo (string) (opcional)
  • rascunhoBase: Dados do produto pai do SKU que será criado. (Obrigatório para itens de grade)
    • id: id do produto pai (Long) (opcional se codigoSistema for informado)
    • codigoSistema: Código referencia base do racsunho pai (string)(opcional se id for informado)
    • nome: Nome do produto pai (string) (obrigatório)
  • modalidadeCalculoFiscalCreditoPresumido: PERCENTUAL_FIXO ou CARGA_TRIBUTARIA_EFETIVA (string)
  • categorias: Lista com os dados das categorias que definem a estrutura mercadológica do produto.
    • id: Id da Categoria (long)
    • nome: Nome da Categoria (string)
    • nivel: Nome do nível onde está localizada a categoria (string)
  • peso: peso do produto (decimal)
  • altura: altura do produto (decimal)
  • comprimento: comprimento do produto (decimal)
  • largura: largura do produto (decimal)
  • fornecedores: Lista de fornecedores com código
    • cnpj: CNPJ do fornecedor
    • codigo: Código do fornecedor
  • estoqueMaximo: Quantidade referencial máxima de estoque do produto (decimal)
  • estoqueMinimo: Quantidade referencial mínima de estoque do produto (decimal)
  • metodoControle: método de controle de estoque do produto, podendo assumir um dos seguintes valores: ESTOCAVEL, LOTE, SERIE, NAO_ESTOCAVEL (string)
  • preco: Preço do Produto na tabela Padrão (decimal)
  • custoReferencial: Preço de custo do Produto (decimal)
  • comissao: Comissão percentual recebida pelo vendedor na venda do produto (decimal)
  • custoUnitarioRoyalties: custo unitário em royalties do produto (decimal)
  • porcentagemRoyalties: percentual de royalties do produto (decimal)
  • precoVariavel: indica se o preço deve ser informado no ato da venda (boolean)
  • margemMinima: margem mínima do produto (decimal)
  • descontoMaximo: Porcentagem máxima de desconto que pode ser oferecida na venda do produto (decimal)
  • urlsFotosProduto: Lista com os endereços (https) das imagens associadas a mercadoria (Array String)
  • controlaLote: Define se o produto irá controlar lotes (boolean)
  • controlaValidadeLote: Define se o produto irá controlar a validade dos lotes (boolean)

Exemplo

GET https://integrador.varejonline.com.br/apps/api/produtos

[
  {
    "id": 1,
    "codigoCest": "22.001.00",
    "origem": "3",
    "status": "Completo",
    "amostraGratis": false,
    "descricao": "CAMISETA POLO",
    "controlaLote": false,
    "precoVariavel": false,
    "categorias": [
      {
        "nome": "TESTE",
        "nivel": "GRUPO"
      },
      {
        "nome": "TESTE",
        "nivel": "SUBGRUPO"
      },
      {
        "nome": "TESTE",
        "nivel": "CATEGORIA"
      },
      {
        "nome": "TESTE",
        "nivel": "FAMÍLIA"
      },
      {
        "nome": "TESTE",
        "nivel": "COLEÇÃO"
      },
      {
        "nome": "TESTE",
        "nivel": "MARCA"
      },
      {
        "nome": "TESTE",
        "nivel": "LINHA"
      },
      {
        "nome": "TESTE",
        "nivel": "TRIBUTAÇÃO"
      }
    ],
    "fichasTecnicas": [],
    "descontoMaximo": 0,
    "codigosBarraAdicionais": [],
    "metodoControle": "ESTOCAVEL",
    "valorAtributos": [],
    "codigoSistema": "6555A.56F",
    "urlsFotosProduto": [],
    "unidade": "UN",
    "custoReferencial": 10,
    "preco": 25,
    "fornecedores": [],
    "modalidadeCalculoFiscalCreditoPresumido": "CARGA_TRIBUTARIA_EFETIVA",
    "encomenda": false,
    "fci": "B01F70AF10BF4B1F848C65FF57F616FE",
    "margemMinima": 2.5,
    "classificacao": "REVENDA",
    "estoqueMinimo": 0,
    "codigoNcm": "7117.90.00",
    "controlaValidadeLote": false,
    "definirPrecoVendaPelaFichaTecnica": false,
    "comissao": 0,
    "disponivelEcommerce": true,
    "dadosPorEntidade": [],
    "disponivelMarketplace": true
  }
]