Consulta de produtos via API GET

Consulta a nível de Produto

Esse endpoint permite, através de um GET HTTP no caminho /productreference/product consultar os produtos cadastrados:

curl 'http://SERVER:PORT/api//productreference/product?pageSize=300&pageIndex=0&productReferenceId=ff4afd2d-30b0-4951-baf3-d618186061cc' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4'

Resposta em caso de sucesso

{
    "items": [
        {
            "id": "ff4afd2d-30b0-4951-baf3-d618186061cc",
            "fullDescription": "143-143",
            "sku": "143",
            "description": "143",
            "barcode": null,
            "type": "RAW",
            "color": null,
            "size": null,
            "fraction": null,
            "measureUnit": null,
            "productId": "4f584b93-7223-4bf7-91ab-87e4689dcff2",
            "productReferenceId": "ff4afd2d-30b0-4951-baf3-d618186061cc",
            "productGridId": null,
            "averageCost": null,
            "productCustom": null,
            "productGridCustom": null
        },
    ]
}

Descrição dos campos

Campos da API:

• id - Identificador do produto
• fullDescription - Sku + Descrição do produto
• sku - SKU do produto
• description - Descrição do produto
• barcode - Código de barras do produto
• type - Tipo do produto
• color - Cor do produto
• size - Tamanho do produto
• fraction - Fração do produto
• measureUnit - Unidade de medida do produto
• productId - ID do produto
• productReferenceId - ID da referência do produto
• productGridId - ID do produto da grade
• averageCost - Custo médio do produto
• productCustom - Campo custom do produto
• productGridCustom - Campo custom da grade de produtos

Resposta em caso de erro

{
    "errorMessage": "Mensagem de erro"
}

Autenticação

A chamada para esses endpoints necessitam autenticação do tipo Basic(Base64 encoded) com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678

• integração:12345678 => Base64 encoded => aW50ZWdyYcOnw6NvOjEyMzQ1Njc4
• Header de autenticação => Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4

Parâmetros da requisição:

• SERVER - O IP ou DNS do servidor onde o sistema Valesoft está instalado
• PORT - A porta definida na instalação do sistema.
• pageIndex - Índice da página atual de resultado, iniciando em 0
• pageSize - Quantidade de itens da página atual de resultado

Filtragem dos resultados

É possível filtrar através de parâmetros query quaisquer campos presentes no resultado da api, incluindo campos personalizadas das tabelas envolvidas, como no exemplo cURL acima onde é filtrado o productReferenceId productReferenceId=ff4afd2d-30b0-4951-baf3-d618186061cc.

Consulta de estoque de produtos via API GET

Consulta a nível de EPC

Esse endpoint permite, através de um GET HTTP no caminho dashboard/stock/product consultar o estoque de produtos e EPC's:

curl 'http://SERVER:PORT/api/dashboard/stock/product?pageSize=300&pageIndex=0&epc=274732413032303638343930' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4'

Resposta em caso de sucesso

{
    "items": [
        {
            "id": "274732413032303638343930",
            "sku": "CHP00212C020",
            "productId": "732155cf-f462-410a-b990-7936ff2eb057",
            "fullDescription": "CHP00212C020 - CHAPA POLIDA CINZA ANDORINHA COMERCIAL",
            "measureUnit": "M²",
            "productReferenceId": "f3a34a64-e0b2-43f9-acb2-f45e1b8334c2",
            "averageCost": 0.0,       
            "placeId": null,
            "placeReference": null,
            "placeName": null,
            "fraction": 6.008,
            "epcId": "00006a75-5f27-47da-b2be-102b2458092b",
            "epc": "274732413032303638343930",
            "batch": "056577-068",
            "epcParentId": null,
            "costcenterId": null,
            "costcenterReference": null,
            "costcenterName": null,
            "placeCustom": null,
            "costCenterCustom": null,
            "epcCustom": {
                "paginacao": "E"
            }
        }
    ],
}

Descrição dos campos

Campos da API:

• id - Identificador do estoque (epcId)
• sku - Sku do produto
• productId - ID do produto
• fullDescription - SKU + Descrição do produto
• measureUnit - Unidade de medida
• productReferenceId - ID da referência do produto
• averageCost - Custo médio do produto
• placeId - ID do local
• placeReference - Referência do local
• placeName - Nome do local
• fraction - Fração do produto
• epcId - ID do EPC
• epc - EPC
• batch - Lote
• epcParentId - EPC Pai
• costcenterId - ID do centro de custo
• costcenterReference - Referência do centro de custo
• costcenterName - Nome do centro de custo
• placeCustom - Campo custom do local
• costCenterCustom - Campo custom do centro de custo
• epcCustom - Campo custom do EPC

Resposta em caso de erro

{
    "errorMessage": "Mensagem de erro"
}

Autenticação

A chamada para esses endpoints necessitam autenticação do tipo Basic(Base64 encoded) com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678

• integração:12345678 => Base64 encoded => aW50ZWdyYcOnw6NvOjEyMzQ1Njc4
• Header de autenticação => Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4

Parâmetros da requisição:

• SERVER - O IP ou DNS do servidor onde o sistema Valesoft está instalado
• PORT - A porta definida na instalação do sistema.
• pageIndex - Índice da página atual de resultado, iniciando em 0
• pageSize - Quantidade de itens da página atual de resultado

Filtragem dos resultados

É possível filtrar através de parâmetros query quaisquer campos presentes no resultado da api, incluindo campos personalizadas das tabelas envolvidas, como no exemplo cURL acima onde é filtrado o epc epc=274732413032303638343930.