Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Aviso

Para que a baixa do Preço criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  13 = preco

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

Requisição

Section
Column
width50%

Exemplo de body da requisição

[
    {
        "codigoProduto": "string",
        "dataHoraVigenciaFinal": "2024-03-28T19:26:14.977Z",
        "dataHoraVigenciaInicial": "2024-03-28T19:26:14.977Z",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "idRetaguardaProduto": "string",
        "idRetaguardaProdutoEmbalagem": "string",
        "loteOrigem": "string",
        "precoPromocional": "string",
        "sincronizadoEtiquetaEletronica": 0,
        "situacao": 0,
        "valor": "string"
    }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatorio

Observações

dataHoraVigenciaInicial

datetime

Data inicial da vigência do preço

Sim


codigoProdutostringCódigo do produtoNão
dataHoraVigenciaFinaldatetimeData final da vigência do preçoSim
idInquilinostringIdentificador do inquilinoSim
idProprietariostringIdentificador do proprietárioSim

Enviar apenas o proprietário da loja. 

Este campo não é uma lista e não aceita mais de um proprietário.

idRetaguardastringIdentificador do preço na retaguardaSimTamanho máximo: 100 caracteres
idRetaguardaProdutostringIdentificador do produto na retaguardaSimTamanho máximo: 100 caracteres
idRetaguardaProdutoEmbalagemstringIdentificador na embalagem na retaguardaNãoTamanho máximo: 100 caracteres
loteOrigemstringIdentificador do lote que os dados serão enviadosSim
precoPromocionalstringPreço promocionalNão
sincronizadoEtiquetaEletronicaint
Não
situacaointSituação do preço Sim0 - Inativo, 1 - Ativo
valorstringValorSim

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,
    "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
Card
labelV3.2
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%
Expandir

Exemplo de body da requisição

[
    {
        "codigoProduto": "string",
        "dataHoraVigenciaFinal": "2024-03-28T19:26:14.977Z",
        "dataHoraVigenciaInicial": "2024-03-28T19:26:14.977Z",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "idRetaguardaProduto": "string",
        "idRetaguardaProdutoEmbalagem": "string",
        "loteOrigem": "string",
        "motivoDesconto": "string",
        "precoPromocional": 0.0,
        "situacao": 0,
        "valor": 0.0,
        "idRetaguardaRegiao": "string",
        "margem": 0.0,
        "PrecoOrigem": "string",
        "PrecoPrincipal": true,
        "ValorAtacado": 0.0,
        "IndicePreco": "string",
        "custo": 0.0
    }
]

Column
width
50%

Definições dos campos

do body

Campo

Tipo

Descrição

Obrigatorio

Observações

dataHoraVigenciaInicialdatetimeData inicial da vigência do preçoSim
dataHoraVigenciaFinaldatetimeData final da vigência do preçoSim
codigoProdutostringCódigo do produtoNão
idRetaguardaProdutostringIdentificador do produto na retaguardaSim
valornuméricoValor a ser cobrado do item no carrinho de venda cadastrado no ERP/RetaguardaSim
situacaointSituação do preço Sim0 - Inativo, 1 - Ativo
sincronizadoEtiquetaEletronicaintDEFASADONão
precoPromocionalnuméricoPreço promocionalNão
idRetaguardaProdutoEmbalagemstringIdentificador
na
Expandir
title200 - Ok
da embalagem na retaguardaNão
idInquilinostringIdentificador do inquilinoSim
idRetaguardastringIdentificador do preço na retaguardaSimTamanho máximo: 150 caracteres
idProprietariostringIdentificador do proprietárioSim

Enviar apenas o proprietário da loja. 

Este campo não é uma lista e não aceita mais de um proprietário.

loteOrigemstringIdentificador do lote que os dados serão enviadosSim
motivoDescontostringDescrição da promoção em que o item está vinculadoNãoTamanho máximo: 150 caracteres
idRetaguardaRegiaostringIdentificador da região na retaguardaNãoTamanho máximo: 100 caracteres
Margemnumérico
Não
PrecoOrigemstring
NãoTamanho máximo: 150 caracteres
PrecoPrincipal

Não
ValorAtacadonumérico
Não
IndicePrecostring
NãoTamanho máximo: 100 caracteres
Expandir
titleDefinição dos campos de retorno
expand400 - Bad Request
Custonumérico
Nã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

Body

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
Expandir
Card
label400 - Bad Request
Column
width50%

Exemplo de body

title

de retorno

{
    "

success

code":

true

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

data

guid":

null

"string",
            "

errors

code":

null

"string",
            "

totalTime

message":

0

"string",
            "

numberOfRecords

detailedMessage":

0

"string"
        }
    ]
}

Column
width
title
50%

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