- Criado por Alexandre Claudino ontem às 6:07 PM
GET /ruptures
Descrição
O endpoint GET /ruptures, e
ste endpoint permite obter uma lista de rupturas de estoque. Rupturas de estoque ocorrem quando um produto está esgotado e não pode ser entregue conforme o pedido.
Parâmetros
Este endpoint não requer parâmetros. Você pode simplesmente fazer a requisição para obter a lista de rupturas.
Respostas
Sucesso (200)
{ "Orders": [ { "SalesChannelOrderId": "string", "Items": [ { "OrderId": 0, "SalesChannelOrderId": "string", "OrderOriginId": "string", "DeliveryOriginId": "string", "B2CTransferStatus": 0, "OriginBranch": "string", "DateRupture": "2024-07-22T19:14:01.188Z", "OrderItem": 0, "ProductId": "string", "ProductColorId": "string", "Size": 0, "SizeName": "string", "Barcode": "string", "IsCanceled": true, "Quantity": 0, "RuptureId": 0, "ReasonRupture": "string", "UpdateDate": "2024-07-22T19:14:01.188Z", "User": "string", "SkuId": "string", "SkuAlt": "string", "SkuIdUx": "string" } ] } ] }
A requisição foi bem-sucedida e retornou a lista de rupturas de estoque.
Erro de Autorização (401)
A requisição não foi autorizada. Pode ser necessário fornecer credenciais apropriadas.
Não Encontrado (404)
O recurso solicitado não foi encontrado. Pode ser que não haja rupturas de estoque ou o endpoint esteja incorreto.
Erro Interno do Servidor (500)
Ocorreu um erro interno no servidor ao processar a requisição.
{ "erro": "string", "stackTrace": "string" }
Para obter a lista de rupturas de estoque, faça uma requisição para o endpoint /ruptures
. A resposta incluirá informações sobre cada ruptura, como a data da ruptura, o motivo e detalhes do produto afetado.
GET /reptures/orders/{orderId}
Descrição
O endpoint GET /ruptures/orders/{orderId}, este endpoint permite pesquisar rupturas de estoque específicas para um pedido com base no ID do pedido fornecido. Rupturas de estoque ocorrem quando um produto está esgotado e não pode ser entregue conforme o pedido.
Parâmetros
- orderId (obrigatório): ID do pedido para o qual você deseja buscar informações sobre rupturas de estoque. Este é um número inteiro.
Respostas
Sucesso (200)
{ "Orders": [ { "SalesChannelOrderId": "string", "Items": [ { "OrderId": 0, "SalesChannelOrderId": "string", "OrderOriginId": "string", "DeliveryOriginId": "string", "B2CTransferStatus": 0, "OriginBranch": "string", "DateRupture": "2024-07-22T19:27:37.478Z", "OrderItem": 0, "ProductId": "string", "ProductColorId": "string", "Size": 0, "SizeName": "string", "Barcode": "string", "IsCanceled": true, "Quantity": 0, "RuptureId": 0, "ReasonRupture": "string", "UpdateDate": "2024-07-22T19:27:37.478Z", "User": "string", "SkuId": "string", "SkuAlt": "string", "SkuIdUx": "string" } ] } ] }
A requisição foi bem-sucedida e retornou as informações sobre rupturas de estoque para o pedido especificado.
Erro de Autorização (401)
O pedido com o ID fornecido não foi encontrado. Pode ser que o ID esteja incorreto ou o pedido não tenha rupturas de estoque registradas.
Não Encontrado (404)
O pedido com o ID fornecido não foi encontrado. Pode ser que o ID esteja incorreto ou o pedido não tenha rupturas de estoque registradas.
Erro Interno do Servidor (500)
Ocorreu um erro interno no servidor ao processar a requisição.
{ "erro": "string", "stackTrace": "string" }
Para buscar rupturas de estoque para um pedido específico, faça uma requisição para o endpoint /ruptures/orders/{orderId}
, substituindo {orderId}
pelo ID do pedido desejado. A resposta incluirá detalhes sobre cada ruptura relacionada ao pedido, como a data da ruptura, o motivo e detalhes dos produtos afetados.
GET /reptures/transferDate/{date}
Descrição
O endpoint GET /ruptures/transferDate/{date}, este endpoint permite pesquisar rupturas de estoque com base na data de alteração (data_para_transferencia) fornecida. Rupturas de estoque ocorrem quando um produto está esgotado e não pode ser entregue conforme o pedido.
Parâmetros
- date (obrigatório): Data da alteração para a qual você deseja buscar informações sobre rupturas de estoque. A data deve estar no formato de data e hora (por exemplo,
2024-07-22T19:32:43Z
).
Respostas
Sucesso (200)
{ "Orders": [ { "SalesChannelOrderId": "string", "Items": [ { "OrderId": 0, "SalesChannelOrderId": "string", "OrderOriginId": "string", "DeliveryOriginId": "string", "B2CTransferStatus": 0, "OriginBranch": "string", "DateRupture": "2024-07-22T19:32:43.266Z", "OrderItem": 0, "ProductId": "string", "ProductColorId": "string", "Size": 0, "SizeName": "string", "Barcode": "string", "IsCanceled": true, "Quantity": 0, "RuptureId": 0, "ReasonRupture": "string", "UpdateDate": "2024-07-22T19:32:43.266Z", "User": "string", "SkuId": "string", "SkuAlt": "string", "SkuIdUx": "string" } ] } ] }
A requisição foi bem-sucedida e retornou a lista de rupturas de estoque para a data especificada.
Erro de Autorização (401)
A requisição não foi autorizada. Pode ser necessário fornecer credenciais apropriadas.
Não Encontrado (404)
Não foram encontradas rupturas de estoque para a data fornecida. Verifique se a data está correta ou se há rupturas para esse período.
Erro Interno do Servidor (500)
Ocorreu um erro interno no servidor ao processar a requisição.
{ "erro": "string", "stackTrace": "string" }
Para buscar informações sobre rupturas de estoque para uma data específica, faça uma requisição para o endpoint /ruptures/transferDate/{date}
, substituindo {date}
pela data desejada no formato de data e hora. A resposta incluirá detalhes sobre cada ruptura registrada para essa data, como a data da ruptura, o motivo e detalhes dos produtos afetados.
Exemplo do Swagger: