Exemplos de Chamadas
Nesta seção serão expostos alguns modelos de chamadas que podem ser realizadas na API Fbits em conjunto com uma explicação sobre como funcionam os possíveis parâmetros dessas chamadas.
GET /produtos/{identificador}
Para realizar essa chamada dois parâmetros são obrigatórios, o identificador do produto e o campo tipoIdentificador que define se esse identificador é um Sku ou Produto Variante Id. Existe em adição a esses dois previamente citados o parâmetro camposAdicionais que é do tipo multi seleção e sua função é definir quais informações extras devem ser retornadas para o produto buscado. Por padrão dados como : atacado, estoque, atributos, informações de um produto não são retornadas no seu GET.
Abaixo exemplo de uma chamada que retorna todos os dados adicionais de um produto:
GET /categorias
Esse método possui 3 parâmetros opcionais do tipo booleano, são eles: hierarquia, apenasReseller e apenasUltimoNivel. Todos esse possuem falso como valor padrão.
O parâmetro hierarquia define se as categorias devem ser retornadas de forma hierárquica ou de forma individual.
Caso seja setado como verdadeiro a hierarquia das categorias será montada, ou seja as subcategorias de uma categoria serão
apresentadas numa lista dentro da categoria "pai". Caso seja setado como falso as categorias serão retornadas numa lista simples,
e haverá um campo do tipo string chamado "CaminhoHierarquia" que irá representar a estrutura hierárquica em que aquela categoria se encontra.
Abaixo os exemplos de uma chamada utilizando o parâmetro hierarquia como verdadeiro e como falso:
https://api.fbits.net/categorias?hierarquia=true
Exemplo da estrutura JSON retornada para essa chamada:
"id": 1,
"nome": "Categoria Exemplo",
"categoriaPaiId": 0,
"categoriaERPId": "",
"ativo": true,
"isReseller": false,
"exibirMatrizAtributos": "Neutro",
"quantidadeMaximaCompraUnidade": 0,
"valorMinimoCompra": 0,
"subCategorias": [{
"id": 2,
"nome": "SubCategoria Exemplo",
"categoriaPaiId": 1,
"categoriaERPId": "",
"ativo": true,
"isReseller": false,
"exibirMatrizAtributos": "Neutro",
"quantidadeMaximaCompraUnidade": 0,
"valorMinimoCompra": 0,
"subCategorias": null
}]
}]
https://api.fbits.net/categorias?hierarquia=false
Exemplo da estrutura JSON retornada para essa chamada:
"id": 2,
"nome": "SubCategoria Exemplo",
"categoriaPaiId": 1,
"categoriaERPId": "",
"ativo": true,
"isReseller": false,
"exibirMatrizAtributos": "Neutro",
"quantidadeMaximaCompraUnidade": 0,
"valorMinimoCompra": 0,
"caminhoHierarquia": "Categoria Exemplo > SubCategoria Exemplo"
}]
O parâmetro apenasReseller funciona como um filtro onde quando for setado como verdadeiro irá garantir que as categorias retornadas sejam apenas categorias que estão disponíveis para serem utilizadas na funcionalidade Reseller da plataforma fbits
Já o parâmetro apenasUltimoNivel quando verdadeiro define que as categorias retornadas são o último nível em sua hierarquia
Abaixo um exemplo de uma chamada que combina todos esses campos:
https://api.fbits.net/categorias?hierarquia=false&apenasReseller=true&apenasUltimoNivel=true
Para detalhes sobre as chamadas relacionadas a baixa de pedidos clique aqui.