TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 3

changes.mady.by.user Bruno Daniel Santos Rodrigues_

Gravado em

comparado com

Nova versão 4

changes.mady.by.user Bruno Daniel Santos Rodrigues_

Gravado em

Chave

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

Este método é responsável pela criação dos dados de observação adicional capa, ao realizarmos uma requisição na API de dados dinamicos (dadosdinamicos/down/106) , serão criadas as informações que serão enviadas para o PDV.

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

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

Aviso

Para que a baixa da observação adicional capa ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 106 = observação adicional capa

Deck of Cards
idversções
Card
labelV3.1V1

Requisição

Section
Column
width40%

Exemplo de body da requisição

[
    {
        "idRetaguarda": "string",
        "idInquilino": "string",
        "idProprietario": "string",        
        "loteOrigem": "string",
        "titulo":"text",
        "subtitulo":"text",
        "nomeFuncionalidade":"text",
        "tipoRotina":10,
        "situacao": 0,
        "momentoRotina":0,
        "dataCadastro":"2021-06-21T14:43:18.665Z",
        "dataAtualizacao":"2021-06-21T14:43:18.665Z"
    }
]


Column
width60%

Definições dos campos do body

CampoTipoDescriçãoObrigatórioObservações
idInquilinostringIdentificação do inquilinoSim
idRetaguardastringIdentificação no retaguardaSimTamanho máximo: 100 caracteres
descricaostring

Descrição da Região.

Sim

Tamanho máximo: 40 caracteres

fretePercentualfloatFrete PercentualNãoO percentual de frete associado à região. 
freteTerceirosfloatFrete TerceirosNãoO valor de frete para terceiros
freteEspecialfloatFrete EspecialNãoValor de frete especial
freteKgfloatFrete KgNãoValor do frete por Kg
idProprietario
identificador do proprietárioSim
idRetaguardaLoja
Identificação da loja
Tamanho máximo: 100 caracteres
loteOrigem
Lote vinculado ao dadoSim
situacaoInteiro

Situação da Região

Sim

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

  • 0 - Inativo
  • 1 - Ativo
ufstring

Uf

Não

Unidade federativa

Retorno

Deck of Cards
idretornos
Card
label200 - Ok
Column
width40%

Exemplo de body de retorno

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

Column
width60%

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

Exemplo de body de retorno

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

Column
width60%

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
labelDado Dinâmico

O Dado dinâmico é uma nova forma para envio de dados entre PDV e Retaguarda.

Para o envio de condição de pagamento pelo Dado dinâmico,  realizar um requisição o seguinte endpoint

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

Versão dado

Versão requisiçãoVersão dado
V3.11
V3.22
Aviso

A propriedade {Versão Dado}, enviado na URL da requisição, deve ser substituído pela versão do dado que será enviado.

O body da requisição é o mesmo enviado no endpoint padrão. Consulte as outras abas dessa seção para ver o que deve ser enviado na requisição de acordo com a versão dado enviado na URL.