Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
Este método é responsável pela criação de novos

...

estoque
  • Endpoint: /api/retaguarda/v2/precosestoques
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

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 Preço Estoque criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  13 = preco14 = estoque

titleDefinição dos campos de requisição
Deck of Cards
idversções
Card
labelV3.1 (V2)

Requisição

Section
Column
width50%
Expandir

Exemplo de body da requisição

[
    {
        "

dataHoraVigenciaInicial

codigoProduto":

"2024-03-28T19:26:14.977Z

"string",
        "idInquilino": "string",
        "idProprietario": "string",
        "

dataHoraVigenciaFinal

idRetaguarda": "

2024-03-28T19:26:14.977Z

string",
        "

codigoProduto

idRetaguardaProduto": "string",
        "

idRetaguardaProduto

loteOrigem": "string",
        "

valor

saldo": "string",
        "situacao": 0
    }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

idRetaguardaProdutoStringIdentificador do produto na retaguardaSimTamanho máximo: 100 caracteres
codigoProdutoStringCódigo do produtoSim
saldoStringSaldo do estoque do produtoSim
situacaoInteiroSituação do estoque Sim0 - Inativo, 1 - Ativo
idInquilinoStringIdentificador do inquilinoSim
idRetaguardaStringIdentificador do estoque na retaguardaSimTamanho máximo: 100 caracteres
idProprietarioStringIdentificador do proprietárioSim
loteOrigemStringIdentificador do lote em que os dados serão enviadosSim

Retorno

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

{
    "success": true,
    "message": "Requisição inserida com sucesso!",
    "data": null,
    "errors": null,
    "

sincronizadoEtiquetaEletronica

totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

{
   

"precoPromocional

"code": "string",
    "message": "string",
    "detailedMessage": "string",
    "

idRetaguardaProdutoEmbalagem

helpUrl": "string",
    "details": [
        {
            "

idInquilino

guid": "string",
            "

idRetaguarda

code": "string",
            "

idProprietario

message": "string",
            "

loteOrigem

detailedMessage": "string"
        }
    ]

Expandir

}

Column
width50%

Definições dos campos do retorno

title

Campo

Tipo

Descrição

Observações

dataHoraVigenciaInicialdatetimeData inicial da vigência do preçoObrigatório
dataHoraVigenciaFinaldatetimeData final da vigência do preçoObrigatório
codigoProdutostringCódigo do produtoOpcional
idRetaguardaProdutostringIdentificador do produto na retaguardaObrigatório
valorstringValorObrigatório
situacaointSituação do preço (0 - Inativo, 1 - Ativo)Obrigatório
sincronizadoEtiquetaEletronicaintOpcional
precoPromocionalstringPreço promocionalOpcional
idRetaguardaProdutoEmbalagemstringIdentificador na embalagem na retaguardaOpcional
idInquilinostringIdentificador do inquilinoObrigatório
idRetaguardastringIdentificador do preço na retaguardaObrigatório
idProprietariostringIdentificador do proprietárioObrigatório
loteOrigemstringIdentificador do lote que os dados serão enviadosObrigatório para a integração
Expandir
titleDefinição dos campos de retorno

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro
expandtitle
Card
labelV3.2
Expandir
title200 - Ok
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
width50%

Exemplo de body da requisição

[
    {
        "dataAtualizacaoPaf": "2000-01-01",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "idRetaguardaProduto": "string",
        "loteOrigem": "string",
        "saldo": 0,
        "saldoPaf": 0.0,
        "situacao": 0
    }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

idRetaguardaProdutoStringIdentificador do produto na retaguardaSimTamanho máximo: 100 caracteres
saldoPafnuméricoSaldo PAFNão
saldoIntSaldo do estoque do produtoSim
situacaoInteiroSituação do estoque Sim0 - Inativo, 1 - Ativo
idInquilinoStringIdentificador do inquilinoSim
idRetaguardaStringIdentificador do estoque na retaguardaSimTamanho máximo: 100 caracteres
idProprietarioStringIdentificador do proprietárioSim
loteOrigemStringIdentificador do lote em que os dados serão enviadosSim
dataAtualizacaoPafDatetimeData de atualização do PafNão

Retornos

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

{
    "success": true,
    "message": "Requisição inserida com sucesso!",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "string",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro