Produtos
Busca os produtos e seus skus

Busca produtos e seus skus

GEThttps://erp.hub.it4360.com/api/v1/products

Este endpoint permite buscas os produtos e seus sku.

Rate limit

Quantidade de RequisiçõesTempo em Segundos
12060

Parâmetros

ParâmetroTipoLocalizaçãoDescriçãoObrigatório
IdDataSourceCompanyBranchstringHeaderIdentificador da Company Branch.Sim
AuthorizationstringHeaderToken de autenticação.Sim
idstring[]QueryLista de IDs de produtos para busca exata. (Max: 100)Não
referencestring[]QueryLista de referências (RefProduct). (Max: 50)Não
shortDescriptionstringQueryTexto para busca parcial na descrição curta.Não
statusintQueryStatus do produto no canal de vendas. Status possíveisNão
offsetintHeaderIndica o inicio da paginação.Não
limitintHeaderIndica o tamanho da pagina (De: 1 a 20).Não
createdAtdatetimeHeaderFiltro para buscar os produtos criados nessa data (formato ISO 8601).Não

Exemplos de Requisição

 
curl --location 'https://erp.hub.it4360.com/api/v1/products?id=00000000-0000-0000-0000-000000000000&id=12345655-1111-3333-4444-22222222222&reference=refproduct123&shortDescription=descproduct' \
     --header 'IdDataSourceCompanyBranch: BR57BCF9-D043-4480-B9EF-A7C2641F0B82' \
     --header 'offset: 1' \
     --header 'limit: 20' \
     --data ''
 

Respostas

  • 200 Ok - Sucesso.

Corpo da Resposta (Exemplo):

           {
               "productResponse": 
               {
                   "totalPages": 5802,
                   "currentPage": 5802,
                   "pageSize": 20,
                   "total": 116024,
                   "products": 
                   [
                       {
                           "id": "0f769673-923b-xxxx-xxxx-69f62132044a",
                           "name": "Produto exemplo",
                           "description": "Desc product",
                           "refProduct": "123A",
                           "createdAt": "2022-12-29T17:22:11.953",
                           "skus": 
                           [
                               {
                                   "id": "84f957ea-xxxx-xxx-8c95-bb5a9aafb2bb",
                                   "description": "Produto exemplo unico",
                                   "ean": "123AUN",
                                   "refSku": "123AUN"
                               }
                           ],
                           "channelStatus": [
                               {
                                   "channelId": "xxxxxx-xxxxx-xxxx-xxxxx-xxxxxxxxxxx",
                                   "channel": "Canal Exemplo",
                                   "status": 6,
                                   "statusDescription": "Active"
                               }
                            ]
                       }
                 ]
               }
           }

Atributos do corpo da Resposta

AtributoTipoDescrição
productResponseObjectObjeto principal da resposta
productResponse.totalPagesintQuantidade total de páginas para o filtro informado.
productResponse.currentPageintPágina atual.
productResponse.pageSizeintTamanho da página (de 1 a 20).
productResponse.productsarrayLista de produtos contidos na resposta.
productResponse.products[].idstringIdentificador único do produto.
productResponse.products[].namestringNome do produto.
productResponse.products[].descriptionstringDescrição do produto.
productResponse.products[].refProductstringReferência do produto.
productResponse.products[].createdAtstringData e hora de criação do produto (formato ISO 8601).
productResponse.products[].skusarrayLista de SKUs associados ao produto.
productResponse.products[].skus[].idstringIdentificador único do SKU.
productResponse.products[].skus[].descriptionstringDescrição do SKU.
productResponse.products[].skus[].eanstringCódigo EAN do SKU.
productResponse.products[].skus[].refSkustringReferência do SKU.

Tabela de Status

Número (Valor)Nome do StatusDescrição
0UncuredNão curado
1CuredCurado
2RefusedByMasterRecusado pelo master
3InMasterAnalysisEm análise master
4SyncingSincronizando
5IntegrationErrorErro na integração
6ActiveAtivo
7DisabledDesabilitado
  • 400 Bad Request - Não foi possível atender à requisição. Valide os dados informados.

    Corpo da Resposta (Exemplo):

        "Mensagem de erro detalhada."
  • 404 Not Found - Não encontrado.

    Corpo da Resposta (Exemplo):

    "O DataSourceCompanyBranch com o Id: xxxxx-xxxx-xxxx-xxxx, não foi encontrado."