O cadastro de compartilhamento é responsável por estabelecer o modelo de distribuição de dados para as lojas
| Dica |
|---|
Para saber mais sobre Compartilhamentos clique aqui. |
1 - Cadastrar compartilhamento
Este método é responsável pela criação de um novo compartilhamento
- Endpoint: /api/retaguarda/v2/compartilhamentos
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de compartilhamentos para que possam ser enviados vários na mesma requisição
| Aviso |
|---|
Para que a baixa do compartilhamento criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 6 = compartilhamento |
| Expandir |
|---|
| title | Exemplo de body da requisição |
|---|
|
[
{
"IdRetaguardaLoja": "string",
"IdRetaguarda": "string",
"IdProprietario": "string",
"IdInquilino": "string",
"NomeCompartilhamento": "string",
"Nivel": int,
"IdRetaguardaPai":"string",
"loteOrigem": "string"
} ] |
| Expandir |
|---|
| title | Definição dos campos de requisição |
|---|
|
Campo | Tipo | Descrição | Observações |
|---|
| IdRetaguardaLoja | string | Identificador da loja na retaguarda | Opcional. Só é preenchido se for um compartilhamento de loja | | IdRetaguarda | string | Identificador do compartilhamento na retaguarda | Obrigatório | | IdProprietario | string | Identificador do proprietário do dado | Obrigatório e no máximo 100 caracteres Quando os dados são enviados é necessário passar esse dado pra identificar a qual compartilhamento pertence o dado. | IdInquilino | string | Identificador do inquilino | Obrigatório | NomeCompartilhamento | string | Nome para identificação do compartilhamento | Obrigatório e no máximo 100 caracteres | Nivel | int | Nível do compartilhamento | Obrigatório Nos compartilhamentos deve ter somente um compartilhamento com nível 0. | IdRetaguardaPai | string | IdRetaguarda do compartilhamento acima deste | Opcional Somente não é preenchido no Nível 0 | loteOrigem | string | Código do lote | Obrigatório |
|
| Expandir |
|---|
| title | Retorno da requisição |
|---|
|
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Expandir |
|---|
| title | Definição dos campos de 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 |
|
2 - Consultar compartilhamento
Este método é responsável pela consulta de um compartilhamento
- Endpoint: /api/pdvsyncclient/v2/compartilhamentos/{id}/{lote}/{qtdRegistros}/{idRetaguardaLoja}/{sequencial?}
- Método: Get
- Autenticação: Bearer token
- Permissão: PDVSyncClient
Este endpoint exibe uma lista de compartilhamentos dos filtros realizados no próprio endpoint
| Expandir |
|---|
| title | Definição dos campos de requisição |
|---|
|
Campo | Tipo | Descrição | Observações |
|---|
| id | string | Id do Inquilino |
| | lote | string | Número do lote |
| | qtdRegistros | int | Quantidade de registros que irá retornar na lista |
| | IdRetaguardaLoja | string | Identificador da loja na retaguarda |
| | sequencial | int | Sequencial para paginação | Opcional |
|
| Expandir |
|---|
| title | Retorno da requisição |
|---|
|
{
"success": false,
"message": "Nenhum registro encontrado",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Expandir |
|---|
| title | Definição dos campos de 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 | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
