Pular para o conteúdo principal

PaginaOfProdutoResponse

Uma página de resultados, com o suficiente para o integrador iterar.

itens object[]obrigatório

Os itens desta página.

  • Array [
  • codigointeger<int64>

    Código do produto.

    descricaostring

    Descrição do produto, como no cadastro.

    nomeProdutonull | stringanulável

    Nome comercial, usado na vitrine quando preenchido.

    skunull | stringanulável

    SKU do produto.

    tagsnull | stringanulável

    Tags do produto, como gravadas no ERP.

    unidadestring

    Sigla da unidade de medida.

    unidadeDescricaostring

    Nome da unidade de medida.

    grupo(null | integer)<int32>anulável

    Código do grupo.

    grupoDescricaonull | stringanulável

    Descrição do grupo.

    marca(null | integer)<int32>anulável

    Código da marca.

    marcaDescricaonull | stringanulável

    Descrição da marca.

    ncmnull | stringanulável

    Código NCM.

    cestnull | stringanulável

    Código CEST.

    cstnull | stringanulável

    CST ou CSOSN, conforme o regime da empresa.

    quantidadePromocaonumber<double>

    Quantidade destinada a promoção.

    alturainteger<int32>

    Altura, na unidade em que o ERP a cadastra.

    largurainteger<int32>

    Largura, na unidade em que o ERP a cadastra.

    profundidadeinteger<int32>

    Profundidade, na unidade em que o ERP a cadastra.

    detalhesnull | stringanulável

    Texto livre de apresentação para a loja.

    exportarParaEcommerceboolean

    Se o ERP marcou o produto para ir à loja.

    dataUltimaAtualizacaonull | stringanulável

    Quando o produto foi alterado pela última vez no ERP.

    ativoboolean

    Se o produto está ativo no cadastro do ERP.

    grades object[]

    Grades do produto na filial da credencial, com as cores de cada uma.

  • Array [
  • codigointeger<int32>

    Código da grade, como em /grades.

    descricaostring

    Descrição da grade.

    skunull | stringanulável

    SKU da grade, quando cadastrado.

    quantidadenumber<double>

    Quantidade disponível ao e-commerce nesta grade.

    cores object[]

    Cores desta grade. Vazia quando a grade não tem cores.

  • Array [
  • codigointeger<int32>

    Código da cor, como em /cores.

    descricaostring

    Descrição da cor.

    skunull | stringanulável

    SKU da cor, quando cadastrado.

    skuIdnull | stringanulável

    Identificador externo da variação, quando cadastrado.

    quantidadenumber<double>

    Quantidade disponível ao e-commerce nesta cor.

  • ]
  • ]
  • precos object[]

    Preços do produto na filial da credencial, um por tabela de preço.

  • Array [
  • tabelaPrecointeger<int32>

    Código da tabela de preço, como em /tabelas-preco.

    tabelaPrecoDescricaostring

    Descrição da tabela de preço.

    valorCustonumber<double>

    Valor de custo.

    percentualLucronumber<double>

    Percentual de lucro aplicado sobre o custo.

    valorVendanumber<double>

    Valor de venda. Quando há promoção aplicada, já é o valor promocional.

    quantidadenumber<double>

    Quantidade a partir da qual esta tabela vale.

    promocao(null | integer)<int32>anulável

    Código da promoção aplicada, quando há uma.

    promocaoDescricaonull | stringanulável

    Descrição da promoção aplicada, quando há uma.

  • ]
  • fornecedores object[]

    Fornecedores vinculados ao produto, com o código de cada um.

  • Array [
  • codigointeger<int64>

    Código do fornecedor, como em /fornecedores.

    descricaostring

    Razão social do fornecedor.

    codigoNoFornecedornull | stringanulável

    O código que o fornecedor usa para este produto.

    cnpjnull | stringanulável

    CNPJ gravado no vínculo.

  • ]
  • composicao object[]

    Componentes do produto, quando ele é composto.

  • Array [
  • componenteinteger<int64>

    Código do produto componente.

    componenteDescricaostring

    Descrição do produto componente.

    quantidadenumber<double>

    Quantidade do componente na composição.

    percentualnumber<double>

    Participação do componente, em percentual.

  • ]
  • imagens object[]

    Imagens liberadas para o e-commerce. Só metadado e o endereço de download.

  • Array [
  • codigointeger<int32>

    Código da imagem.

    titulostring

    Título da imagem.

    textoAlternativonull | stringanulável

    Texto alternativo, para acessibilidade.

    principalboolean

    Se é a imagem principal do produto.

    urlnull | stringanulável

    Endereço para baixar o arquivo.

  • ]
  • ]
  • paginaAtualinteger<int32>obrigatório

    Número da página devolvida, começando em 1.

    tamanhoPaginainteger<int32>obrigatório

    Quantos itens cabem em uma página, já limitado ao máximo do endpoint.

    totalItensinteger<int32>obrigatório

    Total de itens que a consulta encontrou, em todas as páginas.

    totalPaginasinteger<int32>

    Total de páginas para este tamanho de página.

    temProximaboolean

    Verdadeiro enquanto houver página seguinte.

    PaginaOfProdutoResponse
    {
    "itens": [
    {
    "codigo": 0,
    "descricao": "string",
    "nomeProduto": "null",
    "sku": "null",
    "tags": "null",
    "unidade": "string",
    "unidadeDescricao": "string",
    "grupo": "null",
    "grupoDescricao": "null",
    "marca": "null",
    "marcaDescricao": "null",
    "ncm": "null",
    "cest": "null",
    "cst": "null",
    "quantidadePromocao": 0,
    "altura": 0,
    "largura": 0,
    "profundidade": 0,
    "detalhes": "null",
    "exportarParaEcommerce": true,
    "dataUltimaAtualizacao": "null",
    "ativo": true,
    "grades": [
    {
    "codigo": 0,
    "descricao": "string",
    "sku": "null",
    "quantidade": 0,
    "cores": [
    {
    "codigo": 0,
    "descricao": "string",
    "sku": "null",
    "skuId": "null",
    "quantidade": 0
    }
    ]
    }
    ],
    "precos": [
    {
    "tabelaPreco": 0,
    "tabelaPrecoDescricao": "string",
    "valorCusto": 0,
    "percentualLucro": 0,
    "valorVenda": 0,
    "quantidade": 0,
    "promocao": "null",
    "promocaoDescricao": "null"
    }
    ],
    "fornecedores": [
    {
    "codigo": 0,
    "descricao": "string",
    "codigoNoFornecedor": "null",
    "cnpj": "null"
    }
    ],
    "composicao": [
    {
    "componente": 0,
    "componenteDescricao": "string",
    "quantidade": 0,
    "percentual": 0
    }
    ],
    "imagens": [
    {
    "codigo": 0,
    "titulo": "string",
    "textoAlternativo": "null",
    "principal": true,
    "url": "null"
    }
    ]
    }
    ],
    "paginaAtual": 0,
    "tamanhoPagina": 0,
    "totalItens": 0,
    "totalPaginas": 0,
    "temProxima": true
    }