...

Deck of Cards

id	dfk

Card

id	card1
label	Definição de Campos e Regras

Informação	Coluna	Obrigatório	Tipo	Tamanho	Descrição
Data de cadastro	data_cadastro	Sim	Data		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de 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	Não	Texto	100
Código do canal	codigo	Sim	Inteiro		Código do canal de venda
Descrição do canal	descricao	Não	Texto	100	Descrição do canal de venda que será apresentado no PDV para identificação
Código interno do canal	codigo_interno	Não	Inteiro		Código interno do canal de venda, atualmente, corresponde ao mesmo da coluna codigo
Situação	situacao	Sim	Inteiro		Define se o registro em questão está ativo ou inativo no banco do TOTVSPDV 0 - Inativo 1 - Ativo

Card

id	card2
label	Microsserviço

Este método é responsável pela criação de tipo de canais de venda.

Endpoint: /api/retaguarda/v2/canaisvenda
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda

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

Aviso
Para que a baixa do canal venda criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 24 = canal venda

Deck of Cards

id	versoes

Card

label	V3.1 (V2)

Requisição

Section

Column

width	40%

Exemplo de body da requisição

[
{
"codigo": 0,
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"situacao": 0
}
]

Column

width	60%

Definições dos campos do body

Campo	Tipo	Descrição	Observações	Obrigatório
codigo	Int	Código do canal de venda		Sim
descricao	String	Descrição do canal de venda	Tamanho máximo: 100 caracteres	Sim
idInquilino	String	Identificador do inquilino		Sim
idProprietario	String	Identificador do proprietário		Sim
idRetaguarda	String	Identificador do canal venda na retaguarda	Tamanho máximo: 100 caracteres	Sim
loteOrigem	String	Identificador do lote		Sim
situacao	Int	Situação do canal venda	0 - Inativo, 1 - Ativo	Sim

Retorno

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	40%

Exemplo de body de retorno

{
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	60%

Definições dos campos do retorno

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

Card

label	400 - Bad Request

Aviso
Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint

Deck of Cards

id	clienteBadRequest

Card

label	Caso 1

Informações
Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório

Column

width	40%

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

Column

width	60%

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

Card

label	Caso 2

Informações
Este retorno ocorre quando algo na aplicação não ocorreu da forma esperada, por exemplo, quando uma exceção é lançada pela aplicação

Section

Column

width	40%

{
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	60%

Campo	Tipo	Descrição
Success	bool	Indica se a criação do cliente foi feita com sucesso
Message	string	Messagem com os erros
Data	objeto	Objeto cliente
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Card

label	V3.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

width	40%

Exemplo de body da requisição

[
{
"codigo": 0,
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"situacao": 0
}
]

Column

width	60%

Definições dos campos do body

Campo	Tipo	Descrição	Obrigatório	Observações
codigo	Int	Código do canal de venda	Sim	Não Nulo
descricao	String	Descrição do canal de venda	Sim	Tamanho máximo: 100 caracteres
idInquilino	String	Identificador do inquilino	Sim
idProprietario	String	Identificador do proprietário	Sim
idRetaguarda	String	Identificador do canal venda na retaguarda	Sim	Tamanho máximo: 100 caracteres
loteOrigem	String	Identificador do lote	Sim
situacao	Int	Situação do canal venda	Sim	Situação do endereço (0 - Inativo, 1 - Ativo)

Retornos

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	40%

Exemplo de body de retorno

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

Column

width	60%

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

Card

label	400 - Bad Request

Column

width	40%

Exemplo de body de retorno

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

Column

width	60%

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

Expandir

title	Definição dos campos de retorno

Expandir

title	200 - Ok

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

Expandir

title	Body de retorno

{
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Expandir

title	400 - Bad Request

Aviso
Devido a arquitetura implantada temos dois retornos de erros que foram padronizados na versão três deste endpoint

Deck of Cards

id	clienteBadRequest

Card

label	Caso 1

Informações
Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório

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

Card

label	Caso 2

Informações
Este retorno ocorre quando algo na aplicação não ocorreu da forma esperada, por exemplo, quando uma exceção é lançada pela aplicação

Campo	Tipo	Descrição
Success	bool	Indica se a criação do cliente foi feita com sucesso
Message	string	Mensagem com os erros
Data	objeto	Objeto cliente
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Expandir

title	Body de retorno

{
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

...

Árvore de páginas

Versões comparadas

Versão antiga 9

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 9

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno