Agora no Bluesoft ERP, é possível consultar o GTIN ou PLU de um produto via API.
Com esta nova API é possível realizar a consulta paginada dos GTINs e PLUs vinculados a um produtoKey específico.
Detalhes da API
| Característica | Detalhe |
| Método | GET |
| Endpoint | /api/comercial/produtos/gtin-plu |
Parâmetros da URL (Query Parameters)
A API implementa paginação e permite a filtragem opcional por produtoKey ou por gtinPlu.
| Parâmetro | Tipo | Opcional/Default | Descrição |
| produtoKey | integer | Opcional | Identificador único do produto para filtrar os códigos associados. |
| gtinPlu | string | Opcional | Código de barras (GTIN ou PLU) para buscar o produto correspondente. |
| page | integer | Opcional, Default: 0 | Número da página a ser retornada. |
| pageSize | integer | Opcional, Default: 30 | Quantidade de registros por página, com limite máximo de 1000. |
Os parâmetros produtoKey e gtinPlu são mutuamente exclusivos. A requisição deve conter apenas um dos dois para ser considerada válida.
Estrutura do Retorno:
O retorno é uma lista de objetos. Cada objeto representa um produto e contém a lista dos seus respectivos códigos (GTIN/PLU).
Se o filtro for por produtoKey, a API deve retornar um objeto contendo os GTINs/PLUs associados a ele.
Se o filtro for por gtinPlu, a API deve retornar uma lista de produtos que possuem aquele código associado.
Os campos no JSON de retorno seguem o padrão camelCase.
Campos no Objeto gtinPlus
| Campo (JSON) | Descrição | Mapeamento |
produtoKey | Chave de identificação do produto. | PRODUTO_KEY |
tipoCodigo | Tipo do código (PLU/GTIN). | TIPO_CODIGO |
itemKey | Chave do item. | ITEM_KEY |
gtinPlu | O código de barras (GTIN ou PLU). | BARRA_ORIGINAL_KEY ou BARRA_KEY |
gerado | Indica se o código foi gerado. Retornado como valor booleano (true ou false). | GERADO |
gtinVencimento | Indica se o GTIN é do tipo vencimento. Retornado como valor booleano (true ou false). | GTIN_VENCIMENTO |
GET – Consulta por produtoKey
Endpoint: api/comercial/produtos/gtin-plu
GET – Consulta por gtinPlu
Endpoint: api/comercial/produtos/gtin-plu
Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui.
Para saber mais sobre a utilização das APIs do ERP, clique aqui.