Árvore de páginas

Para permitir uma gestão centralizada e automatizada das regras de precificação no TOTVS Varejo PDV Omni é necessário que o mesmo possua uma região relacionada aos preços. Isso permite futuras expansões e ajustes nas políticas de preços, suportando promoções, preços fixos e dinâmicos de forma flexível e escalável

O cadastro de região irá permitir as seguintes configurações:


    Informação Coluna Obrigatório Tipo Tamanho Descrição
    Descrição

    descricao

    Sim

    Texto

    40

    Descrição da Região

    Situação da Região situacao Sim Inteiro

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

    • 0 - Inativo
    • 1 - Ativo
    Data cadastro data_cadastro Sim Data
    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data atualização data_atualizacao Sim Data
    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
    Identificação no retaguarda id_retaguarda Sim Texto 100
    Uf uf Não Texto 2

    Unidade federativa

    Frete Percentual frete_percentual Não Numérico
    O percentual de frete associado à região. 
    Frete Terceiros frete_terceiros Não Numérico
    O valor de frete para terceiros
    Frete Especial frete_especial Não Numérico
    Valor de frete especial
    Frete Kg frete_kg Não Numérico
    Valor do frete por Kg

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

    • Endpoint: /api/retaguarda/v3/dadosdinamicos/down/100/1
    • Método: Post
    • Autenticação: Bearer token
    • Permissão: Retaguarda

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

    Para que a baixa da região criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 100 = regiao

    Requisição

    Exemplo de body da requisição

    [
        {
            "idInquilino": "string",
            "idRetaguarda": "string",
            "descricao": "string",
            "fretePercentual": 0.0,
            "freteTerceiros": 0.0,
            "freteEspecial": 0.0,
            "freteKg": 0.0,
            "idProprietario": "string",
            "idRetaguardaLoja": "string",
            "loteOrigem": "string",
            "situacao": 0,
            "uf": "string"
        }
    ]


    Definições dos campos do body

    Campo Tipo Descrição Obrigatório Observações
    idInquilino string Identificação do inquilino Sim
    idRetaguarda string Identificação no retaguarda Sim Tamanho máximo: 100 caracteres
    descricao string

    Descrição da Região.

    Sim

    Tamanho máximo: 40 caracteres

    fretePercentual float Frete Percentual Não O percentual de frete associado à região. 
    freteTerceiros float Frete Terceiros Não O valor de frete para terceiros
    freteEspecial float Frete Especial Não Valor de frete especial
    freteKg float Frete Kg Não Valor do frete por Kg
    idProprietario
    identificador do proprietário Sim
    idRetaguardaLoja
    Identificação da loja
    Tamanho máximo: 100 caracteres
    loteOrigem
    Lote vinculado ao dado Sim
    situacao Inteiro

    Situação da Região

    Sim

    Define se a região em questão está ativa ou inativa.

    • 0 - Inativo
    • 1 - Ativo
    uf string

    Uf

    Não

    Unidade federativa

    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 compartilhamento foi feita com sucesso
    Message string Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
    Data objeto Objeto compartilhamento 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