- Criado por Alexandre Claudino ontem às 6:03 PM
GET /inventories/{product_id}
Descrição
O endpoint GET /inventories/{product_id}
é utilizado para obter informações sobre o inventário de um produto específico. Ele fornece dados detalhados sobre a quantidade disponível do produto em diferentes filiais, bem como informações sobre as últimas movimentações do produto.
Parâmetros
Parâmetros no Caminho (Path)
- product_id: (Obrigatório) O ID do produto para o qual você deseja consultar o inventário.
Parâmetros de Consulta (Query)
page_size: (Obrigatório) A quantidade de registros que você deseja exibir por página. Por exemplo, se você definir esse valor como 10, a resposta mostrará até 10 registros por página.
current_page: (Obrigatório) O número da página atual que você deseja visualizar. Isso é usado em combinação com
page_size
para navegar pelos registros.allowed_on_internet: (Opcional) Um filtro que indica se o produto está disponível para venda na internet para o varejo. Pode ter valores como 0 (não permitido) ou 1 (permitido).
wholesale_internet: (Opcional) Um filtro que indica se o produto está disponível para venda na internet no atacado. Pode ter valores como 0 (não permitido) ou 1 (permitido).
v: (Opcional) A versão utilizada na consulta. Pode ser usado para especificar uma versão específica da API.
Respostas
Sucesso (200)
{ "Pagination": { "TotalCount": 1, "PageSize": 10, "CurrentPage": 1, "version": 1 }, "Items": [ { "SkuId": "12345", "SkuIdAlt": "12345-ALT", "SkuIdUx": "12345-UX", "BranchId": "BR001", "BranchCode": "001", "Quantity": 100, "Barcode": [ "012345678912", "012345678913" ], "UpdateDate": "2024-07-22T14:55:48.771Z", "LastProductEntranceDate": "2024-07-20T14:55:48.771Z", "LastProductExitDate": "2024-07-21T14:55:48.771Z", "LastProductChangeDate": "2024-07-22T14:55:48.771Z" } ] }
Quando a consulta é bem-sucedida, você receberá informações detalhadas sobre o inventário do produto.
Tipo de Mídia
application/json
Erro de Autorização (401)
Se você não estiver autorizado a acessar as informações, você receberá uma mensagem de erro indicando a falta de permissões.
Tipo de Mídia
application/json
{ "erro": "Unauthorized", "stackTrace": "Detalhes do erro, se disponíveis." }
Erro Interno do Servidor (500)
Se ocorrer um erro interno no servidor, você receberá uma mensagem de erro geral.
Tipo de Mídia
application/json
{ "erro": "Internal Server Error", "stackTrace": "Detalhes do erro, se disponíveis." }
Este endpoint é útil para visualizar o inventário atual de um produto específico, facilitando o monitoramento e a gestão de estoque em diferentes filiais. Se houver algum problema com a solicitação, o endpoint fornecerá mensagens de erro para ajudar na resolução.
GET /inventories/transferDate/{date}
Descrição
O endpoint GET /inventories/transferDate/{date}
é utilizado para consultar informações sobre o inventário de produtos com base em uma data de alteração específica. Esse endpoint permite verificar o status dos produtos em diferentes filiais, considerando somente as atualizações feitas até a data fornecida.
Parâmetros
Parâmetros no Caminho (Path)
- date: (Obrigatório) A data de alteração (data_para_transferencia) que você deseja usar para filtrar o inventário dos produtos. Deve ser no formato de data e hora, como "2024-07-22T15:05:54.808Z".
Parâmetros de Consulta (Query)
page_size: (Obrigatório) O número de registros que você deseja visualizar por página. Por exemplo, se você definir esse valor como 20, a resposta mostrará até 20 registros por página.
current_page: (Obrigatório) O número da página atual que você deseja visualizar. Esse parâmetro é usado em conjunto com
page_size
para navegar pelos resultados.allowed_on_internet: (Opcional) Um filtro para indicar se o produto está disponível para venda na internet para o varejo. Pode ser 0 (não permitido) ou 1 (permitido).
wholesale_internet: (Opcional) Um filtro para indicar se o produto está disponível para venda na internet no atacado. Pode ser 0 (não permitido) ou 1 (permitido).
v: (Opcional) Especifica a versão da consulta. Isso é usado para garantir que você está acessando a versão correta da API.
is_default_barcode: (Opcional) Um filtro que indica se o produto usa um código de barras padrão. Pode ser 0 (não padrão) ou 1 (padrão).
Respostas
Sucesso (200)
{ "Pagination": { "TotalCount": 1, "PageSize": 10, "CurrentPage": 1, "version": 1 }, "Items": [ { "SkuId": "12345", "SkuIdAlt": "12345-ALT", "SkuIdUx": "12345-UX", "BranchId": "BR001", "BranchCode": "001", "Quantity": 50, "Barcode": [ "012345678912" ], "UpdateDate": "2024-07-22T15:05:54.808Z", "LastProductEntranceDate": "2024-07-20T15:05:54.808Z", "LastProductExitDate": "2024-07-21T15:05:54.808Z", "LastProductChangeDate": "2024-07-22T15:05:54.808Z" } ] }
Quando a solicitação é bem-sucedida, você recebe uma lista de produtos e suas informações de inventário atualizadas até a data especificada.
Tipo de Mídia
application/json
Erro de Autorização (401)
Se você não tiver as permissões necessárias para acessar as informações, receberá uma mensagem de erro.
Tipo de Mídia
application/json
{ "erro": "Unauthorized", "stackTrace": "Detalhes do erro, se disponíveis." }
Erro Interno do Servidor (500)
Se houver um erro interno no servidor, você receberá uma mensagem de erro geral.
Tipo de Mídia
application/json
{ "erro": "Internal Server Error", "stackTrace": "Detalhes do erro, se disponíveis." }
Este endpoint é útil para consultar e verificar o inventário dos produtos de acordo com as atualizações realizadas até uma data específica. Ele permite que você obtenha informações detalhadas sobre a disponibilidade e movimentações dos produtos, facilitando a gestão e o controle do estoque.
Exemplo do Swagger: