...

Deck of Cards

id	dk1

Card

label	Como integrar

Apenas nos casos que necessitam de parametros na requisição:

Parametro	Descrição	Tipo	Obrigatório	Observação
idInquilino	Identificador do inquilino	String	Sim
idRetaguardaLoja	Identificador da loja da retaguarda	String	Sim
cpfCnpj	CPF / CNPJ	String	Sim	Parâmetro do tipo Header

------------------------------------------------------------------------------------------------------------------------------

Retornos

Este método é responsável pela criação de uma regra X

Endpoint: /api/retaguarda/v3/dadosdinamicos/down/59/{versão}
- caso outras versoes estejam sendo utilizadas incluir
- v2
- v1
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda
Microserviço: PDVSync.Core.Preco

Este endpoint recebe uma lista de X, permitindo vários em uma mesma requisição. (Com base nas novas atividades melhorar a descrição, envia x dado para tal função)

Aviso

Para que a baixa da Y e X criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo XXXX = YYYYY

É necessário que o inquilino tenha o parametro XXXX - YYYY cadastrado no controle.

Campo destinado a observações detalhes de atenção, pode variar de api para api

Pré-requisitos: Preenchimento correto no METADATA do inquilino.

Endpoint LimiteCredito: Exemplo.: /api/limitecreditodetalhe

O parâmetros desta requisição são enviado no header, abaixo estão listados os parâmetros

Deck of Cards

id	versoes2

Card

label	V3.1

Requisição

Section

Column

width	50%

Exemplo de body da requisição

[
{
"dataHoraVigenciaFinal": "2021-06-21T14:43:18.665Z",
"dataHoraVigenciaInicial": "2021-06-21T14:43:18.665Z",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
}
]

Column

width	50%

Definições dos campos do body

Campo	Tipo	Descrição	Obrigatório	Observações
idInquilino	string	Identificador do inquilino	Sim
idProprietario	string	Identificador do proprietário	Sim
idRetaguarda	string	Identificador do grupo na retaguarda	Sim	Tamanho máximo: 100 caracteres
dataHoraVigenciaInicial	datetime	Data Inicial da vigência da regra	Sim
dataHoraVigenciaFinal	datetime	Data Final da vigência da regra	Sim

Retorno

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

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

Column

width	50%

Definições dos campos do retorno

Campo	Tipo	Descrição
data	Objeto	Retorno dos dados caso tenha
errors	Objeto	Objeto contendo todos os erros encontrados.
message	String	Descrição do erro
numberOfRecords	Int	Número de arquivos processados
success	Bool	Status da requisição
totalTime	Int	Tempo total

Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"data": null,
"errors": {
"0": {
"IdRetaguarda": [
""
]
}
},
"message": null,
"numberOfRecords": 9,
"success": false,
"totalTime": 4077
}

Column

width	50%

Definições dos campos do retorno

Campo	Tipo	Descrição
data	Objeto	Retorno dos dados caso tenha
errors	Objeto	Objeto contendo todos os erros encontrados. Cada propriedade desse objeto é o índice do grupo enviado que está com erro.
message	String	Descrição do erro
numberOfRecords	Int	Número de arquivos processados
success	Bool	Status da requisição
totalTime	Int	Tempo total

...

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 20

Nova versão 21

Chave

------------------------------------------------------------------------------------------------------------------------------

Retornos

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

Exemplo de body de retorno

Definições dos campos do retorno

Atalhos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 20

Nova versão 21

Chave

------------------------------------------------------------------------------------------------------------------------------

Retornos

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

Exemplo de body de retorno

Definições dos campos do retorno