Interessados: Comercial, Delivery, Tax Support e Produtos

Resumo: Possibilita a consulta de Grupos de produtos com produtos associados
API – Consulta de Grupos com produtos associados
Por Carlos Cornejo

A API de Consulta de Grupos com produtos associados, utiliza como fonte de informações o Site Systax, especificamente em: Tabelas > Grupos de Produtos > Configurações

Ela funciona através do método GET, ou seja, não possui um body para chamada e o final de seu endpoint vai variar de acordo com a ação que for enviada para consulta e tem como padrão a forma de autenticação via Token.

Importante observar que por se tratar de uma API quem consumirá é um sistema, as API’s não foram construídas para uso manual, internamente na Systax utilizamos para conferencia da utilização dos nossos clientes, já que nem todas nossas API’s possui uma interface.

Endpoint principal: https://app.systax.com.br/cadastro-geral/assoc/products-groups

É possível realizar a busca através das seguintes opções:

- Descrição do grupo;
- Código do produto;
- Origem do produto;
- Código do produto + Origem do produto;
- Data de associação do produto ao Grupo;

Descrição do grupo

Para realizar a busca utilizando a descrição do grupo existem duas possibilidades:

1) Informar o nome completo do grupo, onde o endpoint será: https://app.systax.com.br/cadastro-geral/assoc/products-groups?descricao_grupo= nome completo do grupo

Exemplo:

Ao realizar a consulta dessa forma a API irá retornar todos os grupos com essa descrição e que possuem produtos associados.

2) Informar apenas uma palavra, um código ou parte da descrição, onde o endpoint será: https://app.systax.com.br/cadastro-geral/assoc/products-groups?descricao_grupo= palavra, código ou parte da descrição

Exemplo com uma palavra:

Ao realizar a consulta dessa forma a API irá retornar todos os grupos com “BA” em sua descrição e que possuem produtos associados.

Exemplo com um código:

Ao realizar a consulta dessa forma a API irá retornar todos os grupos com “121” em sua descrição e que possuem produtos associados.

Exemplo com parte da descrição:

Ao realizar a consulta dessa forma a API irá retornar todos os grupos com “BA-BA-121-2” em sua descrição e que possuem produtos associados. Notem que nesse caso a descrição não está completa, então a API vai buscar tudo que possua na descrição o que foi informado no Endpoint.




Código do produto

Para realizar a busca utilizando o código do produto existem duas possibilidades:

Informar o código do produto exato ou parte do código, onde o endpoint será: http://devapp.systax.com.br/cadastro-geral/assoc/products-groups?cod_prod= código do produto exato ou parte do código

Exemplo com o produto exato:

Nesse caso a API irá retornar todos os Grupos que contenham o produto 100293 associado.

Exemplo com parte do código:

Nesse caso foi utilizado um código menor, para que API retornasse mais registros, onde vai considerar tudo que possua 10 no código de produtos associados a grupos.

Origem do produto

Para realizar a busca pela origem do produto deve ser utilizado o seguinte endpoint: http://devapp.systax.com.br/cadastro-geral/assoc/products-groups?origem_produto= origem do produto

Exemplo:

Nesse caso a API vai retornar todos os grupos que possuem produtos de origem 2 associados.

Código do produto + Origem do produto

Para realizar a busca utilizando o código do produto + a origem do produto existe duas possibilidades:

Informar o código exato do produto junto com a origem ou informar parte do código junto com a origem. O endpoint será: http://devapp.systax.com.br/cadastro-geral/assoc/products-groups?cod_prod=  código do produto ou parte do código  &origem_produto= origem do produto

 

Exemplo de código exato + origem

Nesse caso a API vai retornar todos os grupos que possuem produtos com código 100293 e origem 2



Exemplo de parte do código + origem



Nesse caso a API vai retornar todos os grupos com produtos que contenham 10 em seu código e sejam de origem 2.



Data de associação do produto ao grupo

Para realizar a busca utilizando a data de associação do produto ao grupo existem duas formatações possíveis:

- (aaaa-mm-dd)
- (dd/mm/aaaa)

O endpoint será: http://devapp.systax.com.br/cadastro-geral/assoc/products-groups?data_assoc= data de associação do produto ao grupo

Exemplo com a formatação aaaa-mm-dd:



Nesse caso a API vai retornar todas as associações que ocorreram no dia 14.12.2022

Exemplo com a formatação dd/mm/aaaa:



Nesse caso também vai retornar todas as associações que ocorreram no dia 14.12.2022. A única diferença foi a formatação indicada no endpoint.

Busca com informações inexistentes

Para todos os casos exemplificados acima, quando não houver retorno de informações com os dados inseridos no endpoint, a API vai retornar “not found”.

Exemplo:

Conclusão

A API de Consulta de Grupos com produtos associados facilita a busca de informações que antes era realizada somente pelo site Systax, dessa forma através de apenas uma chamada é possível captar diversas informações sobre os grupos do cliente que possuem produtos associados, isso é um facilitador até para casos de integração.

____________________________________________________________________________________________________________

Interested: Commercial, Delivery, Tax Support and Products

Summary: Enables the search of Product Groups with associated products
API – Group consultation with related products
By Carlos Cornejo

The Group Consultation API with associated products uses the Systax Site as a source of information, specifically in: Tables > Product Groups > Settings

It works through the GET method, that is, it does not have a body for call and the end of its endpoint will vary according to the action that is sent for query and has as default the form of authentication via Token.
It is important to note that since it is an API who will consume is a system, the API’s were not built for manual use, internally at Systax we use for conference use of our customers, since not all of our APIs have an interface.

Main Endpoint: https://app.systax.com.br/cadastro-general/assoc/products-groups

You can search through the following options:

- Description of the group;
- Product code;
- Origin of the product;
- Product code + Origin of the product;
- Date of association of the product with the Group;

Group description
To perform the search using the group description there are two possibilities:

1) Enter the full name of the group, where the endpoint will be: https://app.systax.com.br/cadastro-geral/assoc/products-groups?description_group=

Example:

By performing the query in this way the API will return all groups with this description and that have associated products.

2) Just enter a word, code or part of the description, where the endpoint will be: https://app.systax.com.br/cadastro-geral/assoc/products-groups?description_group=

Example with a word:

By performing the query in this way the API will return all groups with “BA” in their description and that have associated products.

Example with a code:

By performing the query in this way the API will return all groups with “121” in their description and that have associated products.

Example with part of the description:

By performing the query in this way the API will return all groups with “BA-BA-121-2” in their description and that have associated products. Note that in this case the description is not complete, so the API will retrieve everything that has in the description that was informed in the Endpoint.

Product Code

To perform the search using the product code there are two possibilities:

Enter the exact product code or part of the code, where the endpoint will be: http://devapp.systax.com.br/cadastro-geral/assoc/products-groups?cod_prod=

Example with the exact product:

In this case, the API will return all Groups containing the associated product 100293.



Example with part of the code:

In this case, a smaller code was used, so that the API would return more records, where it will consider everything that has 10 in the product code associated with groups.

Origin of the product

The following endpoint should be used to search for the origin of the product: http://devapp.systax.com.br/cadastro-geral/assoc/products-groups?source_product=

Example:

In this case the API will return all groups that have associated source 2 products.

Product Code + Product Origin

To perform the search using the product code + the origin of the product there are two possibilities:

Indicate the exact code of the product along with the source or part of the code alongside the source. The endpoint will be: http://devapp.systax.com.br/cadastro-general/assoc/products-groups?cod_prod= & origin_product=


Exact code example + source

In this case the API will return all groups that have products with code 100293 and source 2

Example of part of code + source

In this case the API will return all groups with products that contain 10 in their code and are from source 2.

Date of product association with the group

To perform the search using the date of association of the product to the group there are two possible formatting:

- (aaaa-mm-dd)
- (dd/mm/aaaa)

The endpoint will be: http://devapp.systax.com.br/cadastro-general/assoc/products-groups?data_assoc=

Example with formatting aaaa-mm-dd:

In this case the API will return all associations that occurred on 14.12.2022

Example with dd/mm/aaaa formatting:

In this case you will also return all associations that occurred on 14.12.2022. The only difference was the formatting specified in the endpoint.

Search with non-existent information

For all cases exemplified above, when there is no return of information with the data entered in the endpoint, the API will return “not found”.

Example:

Conclusion

The Group Consultation API with associated products facilitates the search for information that was previously carried out only by the Systax site, in this way, through just one call it is possible to capture various information about the customer groups that have related products, this is a facilitator even for integration cases.

Voltar