Árvore de páginas

Versões comparadas

Chave

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

(aviso)

Button
Cor#FF0000
TextoTDN MIGRADO CLASSIFICACAO PRODUTO
Linkhttps://tdn.totvs.com/pages/viewpage.action?pageId=842702566

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

...

Aviso

Para que a baixa da Classificação criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  11 = ClassificacaoProduto

titleexpandtitleDefinição de requisição
Deck of Cards
idversções
Card
labelV3.1 (V2)

Requisição

Section
Column
width50%
Expandir

Exemplo de body da requisição

[
    {
        "descricao": "string",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "idRetaguardaPai": "string",
        "loteOrigem": "string",
        "nome": "string",
        "sigla": "string",
        "situacao": 0
    }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

string

Descrição da classificação

Sim

Tamanho máximo: 100 caracteres

idInquilinostringIdentificador do inquilinoSim
idProprietariostringIdentificador do proprietárioSim
idRetaguardastringIdentificador do imposto na retaguardaSimTamanho máximo: 100 caracteres
idRetaguardaPaistringIdentificador na retaguar da classificação paiNãoTamanho máximo: 100 caracteres
loteOrigemstringIdentificador do lote para envio dos dadosSim
nomestringNome da classificação

Sim

Tamanho máximo: 50 caracteres

siglastringSigla da classificação

Não

Tamanho máximo: 50 caracteres

situacaointSituação da classificação Sim0 - Inativo, 1 - Ativo

Retorno

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

Exemplo de body de retorno

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

"situacao": 0

    "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Column
width50%

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

[
    {
        "descricao": "string",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "

idProprietario

idRetaguardaPai": "string",
        "loteOrigem": "string",
        "nome": "string",
        "sigla": "string",
        "situacao": 0
    }
]

Column
width
50%

Definições dos campos

do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricaostringDescrição da classificação
Obrigatório

Sim

Tamanho máximo: 100 caracteres

nomestringNome da classificação
Obrigatório

Sim

Tamanho máximo: 50 caracteres

siglastringSigla da classificação
Opcional

Não

Tamanho máximo: 50 caracteres

idRetaguardaPaistringIdentificador na
retaguar da
retaguarda classificação pai
Opcional
Não
situacaointSituação da classificação
(
Sim0 - Inativo, 1 - Ativo
)
Obrigatório
idInquilinostringIdentificador do inquilino
Obrigatório
Sim
idRetaguardastringIdentificador
do imposto
da classificação na retaguarda
Obrigatório
Sim
idProprietariostringIdentificador do proprietário
Obrigatório
Expandir
title200 - Ok
Sim
loteOrigemstringIdentificador do lote para envio dos dados
Obrigatório para a integração Expandir
titleDefinição dos campos de retorno
expandtitle
Sim


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