Á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 retorno

Deck of Cards
idversções
Card
idcard1
labelDescrição dos campos e regras
Tamanho máximo de caracteres. O IdRetaguarda da Praça precisa já existir no banco do PDV para ser atrelada no envio, caso não será preenchida em branco.Tamanho máximo de caracteres. O IdRetaguarda da Rede do Cliente precisa já existir no banco do PDV para ser atrelada no envio, caso não será preenchida em branco.
InformaçãoCampo Banco PDVCampo Json APIObrigatórioTipoTamanhoDescriçãoObservações
Situacao

situacao

Situacao

Sim

int

1


0 - Inativo, 1 - Ativo 

Caso não enviado será cadastrado com 0 


IdInquilino

N/A

IdInquilino

Sim

string




IdRetaguarda

id_retaguarda

IdRetaguarda

Sim

string

100


Tamanho máximo de 100 caracteres

DataHoraVigenciaInicial

data_vigencia_inicial

DataHoraVigenciaInicial

Não

Datetime


Data de inicio da vigência do preço


DataHoraVigenciaFinal

data_vigencia_final

DataHoraVigenciaFinal

Não

Datetime


Data de termino da vigência do preço


IdProprietario

N/A

IdProprietario

Sim

string




LoteOrigem

N/A

LoteOrigem

Sim

string

100



Tamanho máximo de 100 caracteres.

IdRetaguardaLoja

id_retaguarda_loja

IdRetaguardaLoja

Não

string

100




Cliente

id_cliente

N/A

Não

inteiro



FK tabela de cliente

N/A

IdRetaguardaCliente

Não

string

100


O IdRetaguarda do cliente precisa já existir no banco do PDV. Caso não existir o idretaguarda na tabela cliente do PDV o Sync retornará erro de que o cliente não foi encontrado.


IdRetaguardaClientePrincipal

id_cliente_principal


Não

inteiro



FK tabela de cliente

N/A

IdRetaguardaClientePrincipal

Não

string

100


O IdRetaguarda do cliente principal precisa já existir no banco do PDV. Caso não existir o idretaguarda do cliente principal na tabela cliente do PDV o Sync retornará erro de que o cliente principal não foi encontrado.

Identificação do grupo cliente especifico

id_grupo_cliente

N/A




FK tabela de grupo_cliente - campo id

DEFASADO

Identificação do grupo cliente não especificoIdRetaguardaGrupoCliente

Id_retaguarda_grupo_cliente

IdRetaguardaGrupoCliente

Não

string

100

FK tabela de grupo_cliente - campo id_retaguarda_grupo

O grupo cliente O IdRetaguarda do Grupo de Cliente precisa já existir no banco do PDV para ser atrelada no envio, caso não será preenchida em branco(tabela grupo_cliente - campo id_retaguarda_grupo). Caso não existir o dado informado, o Sync retornará erro de que o Id_retaguarda_grupo não foi encontrado.

IdRetaguardaPagamentoCondicao

id_pagamento_condicao

IdRetaguardaPagamentoCondicao

Não

string

100


O Tamanho máximo de 100 caracteres. O IdRetaguarda da condição de pagamento precisa já existir no banco do PDV para ser atrelada no envio, caso não será preenchida em branco.

IdRetaguardaProduto

id_produto

IdRetaguardaProduto

Sim

string

100


O Tamanho máximo de 100 caracteres. O IdRetaguarda do Produto precisa já existir no banco do PDV para ser atrelada no envio.

IdRetaguardaRamoAtividade

id_ramo_atividade

IdRetaguardaRamoAtividade

Não

string

100


O Tamanho máximo de 100 caracteres. O IdRetaguarda do Ramo de Atividade precisa já existir no banco do PDV para ser atrelada no envio, caso não será preenchida em branco.

IdRetaguardaPraca

id_retaguarda_praca

IdRetaguardaPraca

Não

string

100



IdRetaguardaRedeCliente

id_retaguarda_rede_cliente

IdRetaguardaRedeCliente

Não

string

100



Prioritaria

prioritaria

Prioritaria

Não

bool




UsarTodasEmbalagens

usar_todas_embalagens

UsarTodasEmbalagens

Não

bool




Valor

valor

Valor

Sim

decimal




IdRetaguardaProdutoEmbalagem 


IdRetaguardaProdutoEmbalagem 

Não

string

100


O IdRetaguarda do Produto Embalagem precisa já existir no banco do PDV para ser atrelada no envio, caso não será preenchida em branco.




Requisição

Exemplo de body da requisição

[
    {
        "DataHoraVigenciaFinal": "2024-10-01 12:00:00.000",
        "DataHoraVigenciaInicial": "2024-09-30 12:00:00.000",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "IdRetaguardaCliente": "string",
        "IdRetaguardaClientePrincipal": "string",
        "IdRetaguardaGrupoCliente": "string",
        "IdRetaguardaLoja": "string",
        "IdRetaguardaPagamentoCondicao": "string",
        "IdRetaguardaPraca": "string",
        "IdRetaguardaProduto": "string",
        "IdRetaguardaProdutoEmbalagem": "string",
        "IdRetaguardaRedeCliente": "string",
        "loteOrigem": "string",
        "Prioritaria": true,
        "Situacao": 1,
        "UsarTodasEmbalagens": true,
        "Valor": 0.0
    }
]

Retorno

Card
idComoIntegrar
labelComo integrar

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

Card
idComoIntegrar
labelComo integrar

Este método é responsável pela criação de um novo Preço Promocional

  • Endpoint: /api/retaguarda/v3/dadosdinamicos/down/28/{versaoJson}
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda
  • Microserviço: PDVSync.Core.Preco

Este endpoint recebe uma lista de preços promocionais permitindo enviar vários em uma mesma requisição

Aviso

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

Observação: no parâmetro {versaoJson} enviar o número 2, que refere-se a primeira versão do Json que está detalhado abaixo.

Deck of Cards
idversões2
Card
labelV3.2
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%

Campo

Tipo

Descrição

SuccessboolIndica se a criação do ramo atividade foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do ramo atividade eles serão enviados nesse campo
DataobjetoObjeto ramo atividade 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 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