- Endpoints:
- /api/retaguarda/v2/estoques
- /api/retaguarda/v3/estoques
- /dadosdinamicos/down/14/{versãoJson}
- Método: POST
- Autenticação: Bearer token
- Permissão: Retaguarda
- Microserviço: PDVSync.Core.Estoque
Este endpoint recebe uma lista de preços para que possam ser enviados vários na mesma requisição | Aviso |
|---|
Para que a baixa do Estoque criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 14 = estoque |
| Deck of Cards |
|---|
| | Card |
|---|
| Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"codigoProduto": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"idRetaguardaProduto": "string", "produtoLote": [
{
"situacao": 0,
"quantidade": 0,
"identificacaoLote": "string",
"dataValidade": "2025-01-29T17:29:33.798Z",
"estoqueIdRetaguarda": "string",
"idRetaguarda": "string"
}
],
"loteOrigem": "string",
"saldo": "string",
"situacao": 0
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
| idRetaguardaProduto | String | Identificador do produto na retaguarda | Sim | Tamanho máximo: 100 caracteres | | codigoProduto | String | Código do produto | Sim |
| | saldo | String | Saldo do estoque do produto | Sim |
| | situacao | Inteiro | Situação do estoque | Sim | 0 - Inativo, 1 - Ativo | | produtoLote | Lista de Objetos | Lista de Identificação do Lote do Produto | Não |
| | produtoLote.situacao | Inteiro | Identifica se o registro esta ativo ou inativo | Sim | 0 - Inativo, 1 - Ativo | | produtoLote.quantidade | Decimal | Quantidade de produtos disponível no lote. | Sim | Maior que zero | | produtoLote.identificacaoLote | String | Código ou identificação única do lote. | Sim | Tamanho máximo: 15 caracteres | | produtoLote.dataValidade | Data/Hora | Data de validade do lote. | Não |
| | produtoLote.estoqueIdRetaguarda | String | Identificador do estoque na retaguarda | Sim | Tamanho máximo: 100 caracteres | | produtoLote.idRetaguarda | String | Identificador do lote do produto na retaguarda. | Sim | Tamanho máximo: 100 caracteres | | idInquilino | String | Identificador do inquilino | Sim |
| | idRetaguarda | String | Identificador do estoque na retaguarda | Sim | Tamanho máximo: 100 caracteres | | idProprietario | String | Identificador do proprietário | Sim |
| | loteOrigem | String | Identificador do lote em que os dados serão enviados | Sim |
|
|
|
Retorno | Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
| Card |
|---|
| | Informações |
|---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"dataAtualizacaoPaf": "2000-01-01",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"idRetaguardaProduto": "string", "produtoLote": [
{
"situacao": 0,
"quantidade": 0,
"identificacaoLote": "string",
"dataValidade": "2025-01-29T17:29:33.798Z",
"estoqueIdRetaguarda": "string",
"idRetaguarda": "string"
}
],
"loteOrigem": "string",
"saldo": 0,
"saldoPaf": 0.0,
"situacao": 0
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
| idRetaguardaProduto | String | Identificador do produto na retaguarda | Sim | Tamanho máximo: 100 caracteres | | saldoPaf | numérico | Saldo PAF | Não |
| | saldo | Int | Saldo do estoque do produto | Sim |
| | situacao | Inteiro | Situação do estoque | Sim | 0 - Inativo, 1 - Ativo | | produtoLote | Lista de Objetos | Lista de Identificação do Lote do Produto | Não |
| | produtoLote.situacao | Inteiro | Identifica se o registro esta ativo ou inativo | Sim | 0 - Inativo, 1 - Ativo | | produtoLote.quantidade | Decimal | Quantidade de produtos disponível no lote. | Sim | Maior que zero | | produtoLote.identificacaoLote | String | Código ou identificação única do lote. | Sim | Tamanho máximo: 15 caracteres | | produtoLote.dataValidade | Data/Hora | Data de validade do lote. | Não |
| | produtoLote.estoqueIdRetaguarda | String | Identificador do estoque na retaguarda | Sim | Tamanho máximo: 100 caracteres | | produtoLote.idRetaguarda | String | Identificador do lote do produto na retaguarda. | Sim | Tamanho máximo: 100 caracteres | | idInquilino | String | Identificador do inquilino | Sim |
| | idRetaguarda | String | Identificador do estoque na retaguarda | Sim | Tamanho máximo: 100 caracteres | | idProprietario | String | Identificador do proprietário | Sim |
| | loteOrigem | String | Identificador do lote em que os dados serão enviados | Sim |
| | dataAtualizacaoPaf | Datetime | Data de atualização do Paf | Não |
|
|
|
Retornos| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
|
|
