TOTVS Varejo PDV Omni

Árvore de páginas

Este método é responsável pela criação de um novo Ramo de Atividade

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

Este endpoint recebe uma lista de preços promocionais para que possam ser enviados vários na mesma requisição

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.

    Requisição

    Exemplo de body da requisição

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


    Definições dos campos do body

    Campo

    Tipo

    Descrição

    Obrigatório

    Observações
    Situacao int Situação cadastral Sim

    0 - Inativo, 1 - Ativo 

    Caso não enviado será cadastrado com 0 
    IdInquilino string Identificador do inquilino Sim
    IdRetaguarda string Identificador do perfil na retaguarda  Sim Tamanho máximo de 100 caracteres
    DataHoraVigenciaInicial Datetime Data de inicio da vigência do preço Não
    DataHoraVigenciaFinal Datetime Data de termino da vigência do preço Não
    IdProprietario string Identificador do proprietário Sim
    LoteOrigem string Lote vinculado ao dado Sim
    IdRetaguardaLoja string ID Retaguarda da loja Não Tamanho máximo de 100 caracteres. 
    IdRetaguardaCliente string Identificador do Cliente Não Tamanho máximo de 100 caracteres. O IdRetaguarda do Cliente precisa já existir no banco do PDV para ser atrelada no envio, caso não será preenchida em branco.
    IdRetaguardaClientePrincipal string Identificador do Cliente Principal Não Tamanho máximo de 100 caracteres. O IdRetaguarda do Cliente Principal precisa já existir no banco do PDV para ser atrelada no envio, caso não será preenchida em branco.
    IdRetaguardaGrupoCliente string Identificador do Grupo de Cliente Não Tamanho máximo de 100 caracteres. 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.
    IdRetaguardaPagamentoCondicao string Identificador da Condição de Pagamento  Nã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 string Identificação do Produto Sim Tamanho máximo de 100 caracteres. O IdRetaguarda do Produto precisa já existir no banco do PDV para ser atrelada no envio.
    IdRetaguardaRamoAtividade string Identificação do Ramo de Atividade Nã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 string Identificação da Praça Não Tamanho máximo de 100 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.
    IdRetaguardaRedeCliente string Identificação da Rede do Cliente Não Tamanho máximo de 100 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.
    Prioritaria bool
    		Não
    UsarTodasEmbalagens bool
    		Não
    Valor decimal Valor do preço promocional Sim

    Retorno

    Exemplo de body de retorno

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

    Definições dos campos do retorno

    Campo

    Tipo

    Descrição
    Success bool Indica se a criação do ramo atividade foi feita com sucesso
    Message string Caso ocorra erros durante a criação do ramo atividade eles serão enviados nesse campo
    Data objeto Objeto ramo atividade criado
    Errors Lista Listas com os erros encontrados no processo
    TotalTime int tempo da requisição
    NumberOfRecords int número de dados inseridos

    Exemplo de body de retorno

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

    Definições dos campos do retorno

    Campo

    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
    • Sem rótulos