- Criado por Alexandre Claudino ontem às 6:15 PM
POST /stocks/transferDate/{date}
Descrição
O endpoint POST /stocks/transferDate/{date}, este endpoint é usado para gerar um novo lote de estoque com base em uma data de alteração específica. Pode ser utilizado para atualizar ou criar novos registros de estoque a partir da data informada.
Parâmetros
date (obrigatório): A data de alteração que será usada para gerar o novo lote. Este parâmetro deve ser no formato de data e hora (ex:
2024-07-22T19:00:00Z
).v (opcional): Versão da API que está sendo usada. Pode ser
1
ou3
. Por padrão, o valor é3
.application (opcional): Descrição da aplicação que está realizando a solicitação. Por exemplo, pode ser
OMS
para um sistema de gerenciamento de pedidos.
Respostas
Sucesso (200)
{ "Id": 0 }
A solicitação foi bem-sucedida e um novo lote foi gerado com base na data fornecida.
Solicitação Inválida (400)
A solicitação contém dados inválidos ou está malformada.
{ "erro": "string", "stackTrace": "string" }
Não autorizado (401)
A solicitação não foi autorizada. Verifique suas credenciais e permissões.
Erro Interno (500)
Ocorreu um erro interno no servidor ao processar a solicitação.
{ "erro": "string", "stackTrace": "string" }
Para gerar um novo lote de estoque, envie uma requisição POST para o endpoint /stocks/transferDate/{date}
, substituindo {date}
pela data de alteração desejada. Você pode também incluir os parâmetros opcionais v
e application
conforme necessário. A resposta confirmará a criação do lote e fornecerá um identificador para o novo lote gerado.
GET /accountingmovement/order/{orderId}/fulfillment/{fulfillmentId}
Descrição
O endpoint GET /stocks/status/{lote_id}, e
ste endpoint é utilizado para consultar o status de um lote específico de estoque, fornecendo informações sobre o andamento e detalhes do lote com base em seu identificador.
Parâmetros
lote_id (obrigatório): O identificador único do lote que você deseja consultar. Este é um número inteiro que representa o lote específico.
v (opcional): Versão da API que está sendo usada. Pode ser
1
ou3
. O valor padrão é3
.
Respostas
Sucesso (200)
{ "Id": 0, "StartDate": "2024-07-22T20:08:49.084Z", "EndDate": "2024-07-22T20:08:49.084Z", "UpdateDate": "2024-07-22T20:08:49.084Z", "Status": "string", "Application": "string", "TotalCount": 0, "LastUpdateDate": "2024-07-22T20:08:49.084Z", "MessgeError": "string" }
A solicitação foi bem-sucedida e as informações sobre o status do lote foram retornadas.
- Id: Identificador do lote.
- StartDate: Data e hora em que o lote foi iniciado.
- EndDate: Data e hora em que o lote foi concluído (se aplicável).
- UpdateDate: Data e hora da última atualização do lote.
- Status: Status atual do lote (ex: "Em Andamento", "Concluído").
- Application: Aplicação associada ao lote.
- TotalCount: Número total de itens no lote.
- LastUpdateDate: Data e hora da última atualização.
- MessgeError: Mensagem de erro, se houver.
Não autorizado (401)
A solicitação não foi autorizada. Verifique suas credenciais e permissões.
Não Encontrado (404)
O lote com o identificador fornecido não foi encontrado.
Erro Interno (500)
Ocorreu um erro interno no servidor ao processar a solicitação.
{ "erro": "string", "stackTrace": "string" }
Para verificar o status de um lote, envie uma solicitação GET para o endpoint /stocks/status/{lote_id}
, substituindo {lote_id}
pelo identificador do lote que você deseja consultar. Opcionalmente, você pode incluir o parâmetro v
para especificar a versão da API. A resposta fornecerá detalhes sobre o status e progresso do lote.
GET /stocks/lote/{lote_id}
Descrição
O endpoint GET /stocks/lote/{lote_id}, este endpoint permite pesquisar os itens presentes em um lote específico de estoque. Ele fornece uma lista dos itens associados a um lote, incluindo detalhes como a quantidade e as datas relevantes para cada item.
Parâmetros
- lote_id (obrigatório): O identificador único do lote que você deseja consultar. Este é um número inteiro que representa o lote específico.
- v (opcional): Versão da API que está sendo usada. Pode ser
1
ou3
. O valor padrão é3
. - page_size (opcional): Número de registros que você deseja ver por página. Isso ajuda a controlar a quantidade de informações retornadas em uma única resposta.
- current_page (opcional): Número da página atual que você está visualizando, útil para navegação em múltiplas páginas de resultados.
Respostas
Sucesso (200)
{ "Pagination": { "TotalCount": 0, "PageSize": 0, "CurrentPage": 0 }, "Items": [ { "SkuId": "string", "SkuIdAlt": "string", "SkuIdUx": "string", "BranchId": "string", "BranchCode": "string", "Quantity": 0, "Barcode": [ "string" ], "UpdateDate": "2024-07-22T20:18:07.159Z", "LastProductEntranceDate": "2024-07-22T20:18:07.159Z", "LastProductExitDate": "2024-07-22T20:18:07.159Z", "LastProductChangeDate": "2024-07-22T20:18:07.159Z" } ] }
A solicitação foi bem-sucedida e a lista de itens do lote foi retornada.
- Pagination: Informações sobre a paginação dos resultados.
- TotalCount: Número total de itens no lote.
- PageSize: Número de itens por página.
- CurrentPage: Página atual dos resultados.
- Items: Lista dos itens no lote.
- SkuId: Identificador do SKU.
- SkuIdAlt: Identificador alternativo do SKU.
- SkuIdUx: Identificador do SKU para uso externo.
- BranchId: Identificador da filial.
- BranchCode: Código da filial.
- Quantity: Quantidade disponível no lote.
- Barcode: Código de barras associado ao item.
- UpdateDate: Data da última atualização do item.
- LastProductEntranceDate: Data da última entrada do produto.
- LastProductExitDate: Data da última saída do produto.
- LastProductChangeDate: Data da última alteração do produto.
Solicitação Inválida (400)
A solicitação não pôde ser processada devido a parâmetros inválidos ou outros problemas com a requisição.
{ "erro": "string", "stackTrace": "string" }
Não autorizado (401)
A solicitação não foi autorizada. Verifique suas credenciais e permissões.
Erro Interno (500)
Ocorreu um erro interno no servidor ao processar a solicitação.
{ "erro": "string", "stackTrace": "string" }
Para pesquisar os itens de um lote, envie uma solicitação GET para o endpoint /stocks/lote/{lote_id}
, substituindo {lote_id}
pelo identificador do lote que você deseja consultar. Você pode incluir parâmetros opcionais como v
para versão da API, page_size
para limitar o número de itens por página, e current_page
para especificar qual página de resultados você quer ver. A resposta incluirá informações detalhadas sobre os itens presentes no lote.
Exemplo do Swagger: