API Reference

Exibe todos os produtos paginados.

Exemplo de um retorno completo:

{
  "page": 1,
  "pageSize": 100,
  "totalRecords": 251,
  "items": [
    {
      "id": 424797,
      "alphaCode": "9",
      "name": "Produto com variação e 2 modificadores obrigatórios",
      "sellValue": 1000.0,
      "costValue": 500.0,
      "eanCode": "123456789",
      "netWeight": 0.0,
      "grossWeight": 0.0,
      "minimumStock": 0.0,
      "observation": "",
      "exTipi": "",
      "cest": "",
      "isFractional": false,
      "favorite": 0,
      "noStock": false,
      "isOpenValue": false,
      "isHidden": false,
      "updatedAt": "2023-01-17T20:14:20.726Z",
      "showCatalog": true,
      "hasVariant": true,
      "isArchived": false,
      "promotionalValue": 0.0,
      "promotionalExpirationDate": "2023-01-17T20:14:20.726Z",
      "promotionalDisplayTimer": false,
      "category": {
        "description": "Produto com Variação",
        "viewMode": "IMAGE",
        "text": "",
        "color": "",
        "showCatalog": true
      },
      "supplier": {
        "id": 123,
        "type": "CLIENTE",
        "personType": "FISICA",
        "cpfCnpj": "12345678900",
        "rgIe": "1234567",
        "companyName": "supplier Company",
        "fantasyName": "supplier Fantasia",
        "im": 456,
        "suframa": 789,
        "isentoIcms": true,
        "isSimples": false,
        "observation": "supplier observations",
        "email": "[email protected]",
        "foneCallingCode": "+55",
        "phone": "123456789",
        "celularCallingCode": "+55",
        "cellphone": "987654321",
        "birthday": 19900101,
        "limit": 1000.0,
        "addresses": [
          {
            "addressType": "RESIDENCIAL",
            "zipCode": "12345-678",
            "streetType": "Rua",
            "address": "supplier Street",
            "number": "123",
            "complement": "Apartment 456",
            "district": "supplier District"
          }
        ]
      },
      "unit": {
        "description": "teste",
        "symbol": "te"
      },
      "ncm": {
        "code": 96084000,
        "codeString": "9608.40.00",
        "description": "LAPISEIRAS"
      },
      "productOrigin": "NACIONAL",
      "taxesRule": {
        "id": "c867b75c-22ae-4049-b07c-9223e6cc92aa",
        "name": "Testando IPI - Chaturos"
      },
      "detail": {
        "id": 424797,
        "viewMode": "TEXT",
        "text": "Pr",
        "color": "#ff9ca2a6"
      },
      "modifiers": [
        {
          "name": "Modificador com 2 itens Obrigatórios",
          "required": true,
          "maxQuantity": 2,
          "items": [
            {
              "position": 2,
              "name": "Teste 2",
              "sellValue": 70.0,
              "costValue": 35.0
            },
            {
              "position": 1,
              "name": "Teste 1",
              "sellValue": 40.0,
              "costValue": 20.0
            }
          ]
        },
        {
          "name": "Modificador com 2 itens Obrigatórios",
          "required": true,
          "maxQuantity": 2,
          "items": [
            {
              "position": 2,
              "name": "Teste 2",
              "sellValue": 70.0,
              "costValue": 35.0
            },
            {
              "position": 1,
              "name": "Teste 1",
              "sellValue": 40.0,
              "costValue": 20.0
            }
          ]
        }
      ],
      "variants": [
        {
          "id": "cd6a9bc0-925a-11eb-814a-5fa3a55646b8",
          "name": "Teste 11111",
          "deleted": false,
          "sku": "",
          "sellValue": 1000.0,
          "costValue": 500.0,
          "noStock": false,
          "minimumStock": 0.0,
          "position": 0
        }
      ],
      "googleProductCategory": {
        "mainCategory": "Main Category",
        "subCategory1": "Subcategory 1",
        "subCategory2": "Subcategory 2",
        "subCategory3": "Subcategory 3",
        "subCategory4": "Subcategory 4",
        "subCategory5": "Subcategory 5",
        "subCategory6": "Subcategory 6"
      },
      "productType": "PRODUCT",
      "warrantyDurationType": "YEAR",
      "warrantyDuration": 1
    }
  ]
}

Descrição de todos os campos possíveis

CampoDescrição
page (int)Número da página.
pageSize (int)Tamanho da página.
totalRecords (int)Total de registros.
------
items (Object)Lista de itens.
id (int)id do produto.
alphaCode (StriCódigo alfanumérico do produto.
name (String)Nome do produto.
sellValue (double)Valor de venda do produto.
costValue (double)Valor de custo do produto.
eanCode (String)Código EAN do produto.
netWeight (double)Peso líquido do produto.
grossWeight (double)Peso bruto do produto.
minimumStock (double)Estoque mínimo do produto.
observation (String)Observação do produto.
exTipi (String)Excessão da tabela do IPI.
cest (String)CEST do produto.
isFractional (boolean)Se o produto é fracionado.
favorite (boolean)Se o produto é favorito.
noStock (boolean)Se não há estoque do produto.
isOpenValue (boolean)Se o valor está aberto.
isHidden (boolean)Se o produto está oculto.
updatedAt (ZonedDateTime)Data de atualização do produto.
showCatalog (boolean)Exibir catálogo do produto.
hasVariant (boolean)Se o produto tem variante.
isArchived (boolean)Se o produto está arquivado.
promotionalDisplayTimer (boolean)Exibir temporizador promocional do produto.
promotionalValue (double)Valor promocional do produto.
promotionalExpirationDate (ZonedDateTime)Data de expiração promocional do produto.
productOrigin (String)Origem do produto.
productType (String)Tipo de produto.
warrantyDurationType (String)Tipo de duração da garantia.
warrantyDuration (int)Duração da garantia.
------
category (Object)Detalhes sobre a categoria. Inclui:
description (String)Descrição da categoria.
viewMode (String)Modo de visualização da categoria.
text (String)Texto da categoria.
color (String)Cor da categoria.
showCatalog (boolean)Exibir catálogo da categoria.
------
supplier (Object)Objeto Customer.
id (int)Id do cliente.
type (String)Tipo de cliente (CLIENTE, FORNECEDOR, TRANSPORTADORA).
personType (String)Tipo de pessoa (FISICA, JURIDICA).
cpfCnpj (String)CPF ou CNPJ do cliente.
rgIe (String)RG ou IE do cliente.
companyName (String)Nome da empresa do cliente.
fantasyName (String)Nome fantasia do cliente.
im (Long)Inscrição municipal do cliente.
suframa (Integer)Suframa do cliente.
isentoIcms (Boolean)Se o cliente é isento de ICMS.
isSimples (Boolean)Se o cliente é simples nacional.
observation (String)Observações sobre o cliente.
email (String)Email do cliente.
foneCallingCode (String)Código de chamada do telefone do cliente.
phone (Stirng)Número do telefone do cliente.
celularCallingCode (String)Código de chamada do celular do cliente.
cellphone (String)Número do celular do cliente.
birthday (Integer)Aniversário do cliente.
limit (Double)Limite do cliente.
------
address (Object)Objeto de Endereço.
addressType (String)Tipo de endereço (RESIDENCIAL, COMERCIAL, OUTROS).
zipCode (String)CEP do endereço.
streetType (String)Tipo de rua do endereço.
address (String)Endereço.
number (Stirng)Número do endereço.
complement (String)Complemento do endereço.
district (String)Bairro do endereço.
------
unit (Object)Objeto de Unidade.
description (String)Descrição da unidade.
symbol (String)Símbolo da unidade.
------
ncm (Object)Objeto NCM.
code (Integer)Código NCM.
codeString (String)Código NCM em String.
description (String)Descrição do NCM.
------
taxeRule (Object)Objeto Taxe Rule.
id (String)Id da regra de imposto.
name (String)Nome da regra de imposto.
------
productDetail (Object)Objeto de detalhe do produto.
id (Integer)Id do detalhe do produto.
viewMode (String)Modo de visualização do detalhe do produto.
text (String)Texto do detalhe do produto.
color (String)Cor do detalhe do produto.
------
modifier (Object)Objeto de Modificador.
name (String)Nome do modificador.
required (Boolean)Se é obrigatório.
maxQuantity (Integer)Quantidade máxima.
------
items (Object)Itens do modificador.
position (integer)Posição do item.
name (String)Nome do item.
sellValue (double)Valor de venda do item.
costValue (double)Valor de custo do item.
------
productVariant (Object)Objeto da Variação do Produto.
id (String)id da variante.
name (String)Nome da variante.
deleted (boolean)Se foi deletado.
sku (String)SKU da variante.
sellValue (double)Valor de venda da variante.
costValue (double)Valor de custo da variante.
noStock (boolean)Se não tem estoque.
minimumStock (Double)Estoque mínimo.
position (int)Posição da variante.
------
googleProductCategory (Object)Objeto Categorias do produto no Google.
mainCategory (String)Categoria principal.
subCategory1 (String)Subcategoria.
subCategory2 (String)Subcategoria.
subCategory3 (String)Subcategoria.
subCategory4 (String)Subcategoria.
subCategory5 (String)Subcategoria.
subCategory6 (String)Subcategoria.
------
Language
Authorization
Click Try It! to start a request and see the response here!