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ções | Tempo em Segundos |
|---|---|
| 120 | 60 |
Parâmetros
| Parâmetro | Tipo | Localização | Descrição | Obrigatório |
|---|---|---|---|---|
| IdDataSourceCompanyBranch | string | Header | Identificador da Company Branch. | Sim |
| Authorization | string | Header | Token de autenticação. | Sim |
| id | string[] | Query | Lista de IDs de produtos para busca exata. (Max: 100) | Não |
| reference | string[] | Query | Lista de referências (RefProduct). (Max: 50) | Não |
| shortDescription | string | Query | Texto para busca parcial na descrição curta. | Não |
| status | int | Query | Status do produto no canal de vendas. Status possíveis | Não |
| offset | int | Header | Indica o inicio da paginação. | Não |
| limit | int | Header | Indica o tamanho da pagina (De: 1 a 20). | Não |
| createdAt | datetime | Header | Filtro 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
| Atributo | Tipo | Descrição |
|---|---|---|
| productResponse | Object | Objeto principal da resposta |
| productResponse.totalPages | int | Quantidade total de páginas para o filtro informado. |
| productResponse.currentPage | int | Página atual. |
| productResponse.pageSize | int | Tamanho da página (de 1 a 20). |
| productResponse.products | array | Lista de produtos contidos na resposta. |
| productResponse.products[].id | string | Identificador único do produto. |
| productResponse.products[].name | string | Nome do produto. |
| productResponse.products[].description | string | Descrição do produto. |
| productResponse.products[].refProduct | string | Referência do produto. |
| productResponse.products[].createdAt | string | Data e hora de criação do produto (formato ISO 8601). |
| productResponse.products[].skus | array | Lista de SKUs associados ao produto. |
| productResponse.products[].skus[].id | string | Identificador único do SKU. |
| productResponse.products[].skus[].description | string | Descrição do SKU. |
| productResponse.products[].skus[].ean | string | Código EAN do SKU. |
| productResponse.products[].skus[].refSku | string | Referência do SKU. |
Tabela de Status
| Número (Valor) | Nome do Status | Descrição |
|---|---|---|
| 0 | Uncured | Não curado |
| 1 | Cured | Curado |
| 2 | RefusedByMaster | Recusado pelo master |
| 3 | InMasterAnalysis | Em análise master |
| 4 | Syncing | Sincronizando |
| 5 | IntegrationError | Erro na integração |
| 6 | Active | Ativo |
| 7 | Disabled | Desabilitado |
-
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."