Este método é responsável pela criação de região. ao realizarmos uma requisição na API de região (dadosdinamicos/down/106) , serão criadas as regiõ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 regiões 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

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ção	Versão dado
V3.1	1
V3.2	2

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.