Árvore de páginas

Versões comparadas

Chave

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

...

Definições dos campos do body

Retorno

Deck of Cards
idv1
Card
labelDescrição dos campos e regras

Informação

Coluna

Obrigatório

Tipo

Tamanho

Descrição

Vinculo entre a tabela preço e a tabela produtoproduto_idNãoInteiro
Código de identificação do item na tabela produto (ID)
Data inicial da vigência do preçodata_vigencia_inicialSimData
Data cadastrada no ERP/Retaguarda para o início da vigência do preço cadastrado. Exemplo "2024-03-20 20:56:43.15725".
Data final da vigência do preçodata_vigencia_finalSimData
Data cadastrada no ERP/Retaguarda para o final da vigência do preço cadastrado. Exemplo "2024-03-20 20:56:43.15725".
Valor vigente do itemvalorSimNumérico
Valor a ser cobrado do item no carrinho de venda cadastrado no ERP/Retaguarda
Situação do registrosituacaoSimInteiro

Define se o preço em questão está ativo ou inativo.

  • 0 - Inativo
  • 1 - Ativo
Data de cadastro do registrodata_cadastroSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.

Data de atualização do registro


data_atualizacaoSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
Identificação no retaguardaid_retaguardaNãoTexto100

sincronizado_etiqueta_eletronicaSimInteiro
Defasado
Preço promocional do itempreco_promocionalNãoNumérico
Preço promocional do item. Quando esse campo possui valor, o PDV irá "ignorar" o campo "valor" e irá aplicar ao carrinho o preço promocional para cada unidade. Ele também irá calcular o valor - preco_promocional e apresentar em tela como um desconto no item, para que o usuário saiba que aquele item está em promoção.
Motivo do preço promocional do itemmotivo_descontoNãoTexto150Descrição da promoção em que o item está vinculado
MD5 PAFmd5_pafNãoTexto64

id_produto_embalagemNãoInteiro

Vinculo entre a tabela preço e a tabela regiãoid_regiaoNãoInteiro
Código de identificação da região na tabela região (ID)
Valor de atacado do itemvalor_atacadoNãoNumérico

Valor de atacado do item. Quando o item possui valor no campo quantidade_valor_atacado na tabela produto, o PDV irá "ignorar" o campo "valor" e irá aplicar ao carrinho o valor de atacado do item.

Margem do produtomargemNãoNumérico

Margem do produto

Preço principalpreco_principalNãoInteiro


  • 0 - False
  • 1 - True


Preço origempreco_origemNãoTexto150

(em andamento)

Custo do produtocusto
Numérico

Custo do produto

Indice preçoindice_precoNãoTexto100

Indice preço é o campo para vinculo entre a condição de pagamento e o preço a ser utilizado da tabela de preço.

Requisição

Card
labelComo integrar

Este método é responsável pela criação de novos preço

  • Endpoint: 
    • V2
      • /api/retaguarda/v2/precos
    • V3.1
      • /api/retaguarda/v3/precos
    • V3.2
      • /api/retaguarda/v3/dadosdinamicos/down/13/2
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda
  • Microserviço: PDVSync.Core.Preco

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 criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  13 = preco

Deck of Cards
idversções
Card
labelV3.1 (V2)
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%

Campo

Tipo

Descrição

Obrigatorio

Observações

dataHoraVigenciaInicial

datetime

Data inicial da vigência do preço

Sim

codigoProdutostringCódigo do produtoNãodataHoraVigenciaFinaldatetimeData final da vigência do preçoSimidInquilinostringIdentificador 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 enviadosSimprecoPromocionalstringPreço promocionalNãosincronizadoEtiquetaEletronicaintNão
situacaointSituação do preço Sim0 - Inativo, 1 - Ativo
valorstringValorSim
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 sucessoMessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campoDataobjetoObjeto compartilhamento criadoErrorsListaListas com os erros encontrados no processoTotalTimeinttempo da requisiçãoNumberOfRecordsintnú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 erromessagestringMensagem do errodetailedMessagestringDetalhamento do errohelpUrlstringurl de ajudaTotalTimestringTempo total de buscadetailslista de objetoLista de objeto de errosdetails.guidstringIdentificador do errodetails.codestringCódigo do errodetails.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%

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
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatorio

Observações

dataHoraVigenciaInicialdatetimeData inicial da vigência do preçoSimdataHoraVigenciaFinaldatetimeData final da vigência do preçoSimcodigoProdutostringCódigo do produtoNãoidRetaguardaProdutostringIdentificador do produto na retaguardaSimvalornuméricoValor a ser cobrado do item no carrinho de venda cadastrado no ERP/RetaguardaSimsituacaointSituação do preço Sim0 - Inativo, 1 - AtivosincronizadoEtiquetaEletronicaintDEFASADONãoprecoPromocionalnuméricoPreço promocionalNãoidRetaguardaProdutoEmbalagemstringIdentificador da embalagem na retaguardaNãoidInquilinostringIdentificador do inquilinoSimidRetaguardastringIdentificador do preço na retaguardaSimTamanho máximo: 150 caracteresidProprietariostringIdentificador 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 enviadosSimmotivoDescontostringDescrição da promoção em que o item está vinculadoNãoTamanho máximo: 150 caracteresidRetaguardaRegiaostringIdentificador da região na retaguardaNãoTamanho máximo: 100 caracteresMargemnuméricoNãoPrecoOrigemstringNãoTamanho máximo: 150 caracteresPrecoPrincipalNãoValorAtacadonuméricoNãoIndicePrecostringNãoTamanho máximo: 100 caracteresCustonuméricoNã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 sucessoMessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campoDataobjetoObjeto compartilhamento criadoErrorsListaListas com os erros encontrados no processoTotalTimeinttempo da requisiçãoNumberOfRecordsintnú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 erromessagestringMensagem do errodetailedMessagestringDetalhamento do errohelpUrlstringurl de ajudaTotalTimestringTempo total de buscadetailslista de objetoLista de objeto de errosdetails.guidstringIdentificador do errodetails.codestringCódigo do errodetails.messagestringMensagem do erro details.detailedMessagestringDetalhamento do erro

Para maiores informações de como integrar o Preço, clique aqui.