Page Comparison

Representa uma unidade locatícia de um shopping (loja, quiosque, banner, etc.)

Para criação de uma Unidade Locatícia se faz necessário previamente possuir cadastrado na base : Shopping e Tipo de Unidade

Tipos de registro

Rótulo tipo de registro

Nome de API

Descrição

LojaLojaLocação temporáriaLocacao_temporariaMerchandisingMerchandising

Está informação dos tipos de registros é importante, pois para o cadastro e atualização de cada unidade, dependendo do tipo de registro existem diferentes campos a serem obrigatoriamente informados.

Campos de Unidade

Rótulo do campoNome de APITipo de dadoObrigatórioGroup ShoppingDescriçãoProprietárioOwnerPesquisa(Usuário,Fila)X

Id do usuário salesforce que será detentor do registro
Caso não preenchido será o usuário de integração

Tipo de registroRecordTypeIdXTipo de registro da Unidade UnidadeNameTexto(80)XNumLojaABLsnap_mall__Area__cNúmero(10, 2)AreaLojaÁrea despesa comumsnap_mall__Area__despesa_comum__cNúmero(10, 2)AreaLojaDespComumÁrea com mezaninosnap_mall__Area__mezanino__cNúmero(10, 2)AreaLojaComMezaninoÁguasnap_mall__Agua__cBooleano

Opções possiveis:

true
false

Área de fachadasnap_mall__area_fachada__cNúmero(10, 2)Ativasnap_mall__ativa__cBooleanoAtividade SAPsnap_mall__Atividade_sap__cPesquisa(AtividadeId da atividadeComplementosnap_mall__Complemento__cTexto(10)Contrato atualsnap_mall__Contrato_atual__cPesquisa(Contrato)Id, para caso se aplique, pesquise por um contrato existente.Corredorsnap_mall__corredor__cPesquisa(Corredor)CRDsnap_mall__CRD__cPorcentagem(10, 4)CRDDespComumCRD se vagasnap_mall__CRD__cPorcentagem(10, 4)CRDSeVagaEstamos enviando a mesma informação de CRDCRD co mezaninosnap_mall__CRD__cPorcentagem(10, 4)CRDComMezaninoEstamos enviando a mesma informação de CRDData da inauguraçãosnap_mall__Data_inauguracao__cDataApenas o númeroData de entradasnap_mall__Data_entrada__cDataDataEntradaData de desativaçãosnap_mall__Data_desativacao__cDataDataDesativacaoEnergiasnap_mall__Energia__cBooleano

Opções possíveis:

true
false

FaseFaseGrupo SAPsnap_mall__Grupo_sap__cPesquisa(Grupo)ID Externosnap_mall__ID_Externo__cTexto(50)ChaveExternaId informado para futuras alterações no registroInauguradasnap_mall__inaugurada__cBooleano

Opções possíveis:

true
false

KVA limitesnap_mall__Kva_limite__cNúmero(8, 0)Locadasnap_mall__Alugada__cBooleano

Opções possíveis:

true
false

Localização geográficasnap_mall__Localizacao_geografica__cTexto(255)LocalizacaoLojista anteriorsnap_mall__lojista_anterior__cPesquisa(Conta)Id de uma conta existente Lojista atualsnap_mall__Cliente__cPesquisa(Conta)Id de uma conta existenteMarca anteriorsnap_mall__marca_anterior__cPesquisa(Conta)Id de uma conta existenteMarca atualsnap_mall__marca_atual__cPesquisa(Conta)Id de uma conta existenteParâmetro de aluguel por m2snap_mall__parametro_aluguel_m2__cMoeda(10, 2)Parâmetro de CDU por m2snap_mall__parametro_cdu_m2__cMoeda(10, 2)Pisosnap_mall__Piso__cPesquisa(Piso)NivelPreço de referênciasnap_mall__Preco_referencia__cMoeda(10, 2)Rateio do condomíniosnap_mall__Rateio_condominio__cPorcentagem(12, 4)Shoppingsnap_mall__shopping__cPesquisa(Shopping)IdFilialSituaçãosnap_mall__Situacao_Comercial__cLista de opçõesX

Opções possíveis:
Assuntos especiais
Ativa
Com proposta
Contrato assinado
Contrato assinado pela empresa
Contrato assinado pelo lojista
Despejo
Em locação
Em prospecção
Nova proposta
Proposta aprovada
Prospecção
Repasse
Reserva técnica
Vaga

Subgruposnap_mall__Subgrupo_sap__cPesquisa(Subgrupo)Telefonia e internetsnap_mall__Telefonia_internet__cBooleanoTipo de condomíniosnap_mall__tipo_condominio__cLista de opções

Opções possíveis:

Fixo
Rateio

Tipo de FPsnap_mall__tipo_fp__cLista de opções

Opções possíveis:

20% do AMM
Rateio
Fixo
20% do AMM com limitador

Tipo de unidadesnap_mall__Tipo_unidade__cPesquisa(Tipo de unidade)XTipoDeLojaUnidade relacionadasnap_mall__Unidade_relacionada__cTexto(20)Valor do aluguel atualsnap_mall__valor_aluguel_atual__cMoeda(10, 2)Valor do CDU por m2snap_mall__valor_cdu_m2__cMoeda(10, 2)Valor do condomínio por m2snap_mall__valor_condominio_m2__cMoeda(10, 2)Valor do FP por m2snap_mall__valor_fp_m2__cMoeda(10, 2)

Criar Loja:

Método : POST

URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__loja__c/

Descrição: Método de criação de uma Unidade(snap_mall__loja__c) do tipo Loja, informando todos os campos utilizados por uma Loja.

Request

{
"Name":"Unidade I",
"RecordType":{"Name":"Loja"},
"snap_mall__Situacao_Comercial__c":"Vaga",
"OwnerId":"0051J000004ppUV",
"snap_mall__shopping__c":"a001J00001Kw3TI",
"snap_mall__Alugada__c":"true",
"snap_mall__Tipo_unidade__c":"a0g1J00000DHJmr",
"snap_mall__ativa__c":"true",
"snap_mall__inaugurada__c":"false",
"snap_mall__Area__c":"50",
"snap_mall__Piso__c":"a031J00000eeTp3QAE",
"snap_mall__area_fachada__c":"200000.12",
"snap_mall__Localizacao_geografica__c":"parcial",
"snap_mall__corredor__c":"a0P1J00000TXfLLUA1",
"snap_mall__valor_condominio_m2__c":"1000000",
"snap_mall__tipo_condominio__c":"Fixo",
"snap_mall__Rateio_condominio__c":"12",
"snap_mall__valor_fp_m2__c":"100000",
"snap_mall__parametro_cdu_m2__c":"1000887",
"snap_mall__Contrato_atual__c":"a071J00000PoB46QAF",
"snap_mall__marca_atual__c":"001o000000TcBeT",
"snap_mall__valor_aluguel_atual__c":"1200",
"snap_mall__Cliente__c":"0011J00001DwI9T",
"snap_mall__marca_anterior__c":"0011J00001DwICF",
"snap_mall__lojista_anterior__c":"0011J00001DtTOr",
"snap_mall__ID_Externo__c":"321456"
}

Response

{
"id": "a041J000018PuHqQAK",
"success": true,
"errors": []
}

Criar Locação temporária:

Método : POST

URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__loja__c/

Descrição: Método de criação de uma Unidade(snap_mall__loja__c) do tipo Locação temporária, informando todos os campos utilizados por uma Locação temporária.

Request

{
"Name":"Unidade II",
"RecordTypeId":"0121J000001DbQC",
"snap_mall__Unidade_relacionada__c":"Outra localizacao",
"OwnerId":"0051J000004ppUV",
"snap_mall__shopping__c":"a001J00001Kw3TI",
"snap_mall__Situacao_Comercial__c":"Vaga",
"snap_mall__Tipo_unidade__c":"a0g1J00000DHJmr",
"snap_mall__Alugada__c":"false",
"snap_mall__Complemento__c":"2° andar",
"snap_mall__ativa__c":"true",
"snap_mall__Grupo_sap__c":"a0E1J00000KdqA5UAJ",
"snap_mall__Subgrupo_sap__c":"a0H1J00000L0E2yUAF",
"snap_mall__Atividade_sap__c":"a0G1J00003FZCb7UAH",
"snap_mall__parametro_aluguel_m2__c":"1000",
"snap_mall__valor_condominio_m2__c":"1000000",
"snap_mall__Rateio_condominio__c":"12",
"snap_mall__Agua__c":"true",
"snap_mall__Energia__c":"false",
"snap_mall__Kva_limite__c":"3",
"snap_mall__Telefonia_internet__c":"false",
"snap_mall__Contrato_atual__c":"a071J00000PoB46QAF",
"snap_mall__marca_atual__c":"001o000000TcBeT",
"snap_mall__marca_anterior__c":"0011J00001DwICF",
"snap_mall__lojista_anterior__c":"0011J00001DtTOr",
"snap_mall__ID_Externo__c":"888888"
}

Response

{
"id": "a041J000018PuMAQA0",
"success": true,
"errors": []
}

Criar Merchandising:

Método : POST

URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__loja__c/

Descrição: Método de criação de uma Unidade(snap_mall__loja__c) do tipo Merchandising, informando todos os campos utilizados por uma Merchandising.

Request

{
"Name":"Unidade I",
"RecordType":{"Name":"Merchandising"},
"snap_mall__Situacao_Comercial__c":"Vaga",
"OwnerId":"0051J000004ppUV",
"snap_mall__shopping__c":"a001J00001Kw3TI",
"snap_mall__Alugada

Representa uma unidade locatícia de um shopping (loja, quiosque, banner, etc.)

Para criação de uma Unidade Locatícia se faz necessário previamente possuir cadastrado na base : Shopping e Tipo de Unidade

Tipos de registro

Rótulo tipo de registro	Nome de API	Descrição
Loja	Loja
Locação temporária	Locacao_temporaria
Merchandising	Merchandising

Está informação dos tipos de registros é importante, pois para o cadastro e atualização de cada unidade,

dependendo do tipo de registro existem diferentes campos a serem obrigatoriamente informados.

Campos de Unidade

Rótulo do campo	Nome de API	Tipo de dado	Obrigatório	Group Shopping	Descrição
Proprietário	Owner	Pesquisa(Usuário,Fila)	X		Id do usuário salesforce que será detentor do registro Caso não preenchido será o usuário de integração
Tipo de registro	RecordType	Id	X		Tipo de registro da Unidade
Unidade	Name	Texto(80)	X	NumLoja
ABL	snap_mall__Area__c	Número(10, 2)		AreaLoja
Área despesa comum	snap_mall__Area__despesa_comum__c	Número(10, 2)		AreaLojaDespComum
Área com mezanino	snap_mall__Area__mezanino__c	Número(10, 2)		AreaLojaComMezanino
Água	snap_mall__Agua__c	Booleano			Opções possiveis: true false
Área de fachada	snap_mall__area_fachada__c	Número(10, 2)
Ativa	snap_mall__ativa__c	Booleano
Atividade SAP	snap_mall__Atividade_sap__c	Pesquisa(Atividade			Id da atividade
Complemento	snap_mall__Complemento__c	Texto(10)
Contrato atual	snap_mall__Contrato_atual__c	Pesquisa(Contrato)			Id, para caso se aplique, pesquise por um contrato existente.
Corredor	snap_mall__corredor__c	Pesquisa(Corredor)
CRD	snap_mall__CRD__c	Porcentagem(10, 4)		CRDDespComum
CRD se vaga	snap_mall__CRD__c	Porcentagem(10, 4)		CRDSeVaga	Estamos enviando a mesma informação de CRD
CRD co mezanino	snap_mall__CRD__c	Porcentagem(10, 4)		CRDComMezanino	Estamos enviando a mesma informação de CRD
Data da inauguração	snap_mall__Data_inauguracao__c	Data			Apenas o número
Data de entrada	snap_mall__Data_entrada__c	Data		DataEntrada
Data de desativação	snap_mall__Data_desativacao__c	Data		DataDesativacao
Energia	snap_mall__Energia__c	Booleano			Opções possíveis: true false
Fase				Fase
Grupo SAP	snap_mall__Grupo_sap__c	Pesquisa(Grupo)
ID Externo	snap_mall__ID_Externo__c	Texto(50)		ChaveExterna	Id informado para futuras alterações no registro
Inaugurada	snap_mall__inaugurada__c	Booleano			Opções possíveis: true false
KVA limite	snap_mall__Kva_limite__c	Número(8, 0)
Locada	snap_mall__Alugada__c	Booleano			Opções possíveis: true false
Localização geográfica	snap_mall__Localizacao_geografica__c	Texto(255)		Localizacao
Lojista anterior	snap_mall__lojista_anterior__c	Pesquisa(Conta)			Id de uma conta existente
Lojista atual	snap_mall__Cliente__c	Pesquisa(Conta)			Id de uma conta existente
Marca anterior	snap_mall__marca_anterior__c	Pesquisa(Conta)			Id de uma conta existente
Marca atual	snap_mall__marca_atual__c	Pesquisa(Conta)			Id de uma conta existente
Parâmetro de aluguel por m2	snap_mall__parametro_aluguel_m2__c	Moeda(10, 2)
Parâmetro de CDU por m2	snap_mall__parametro_cdu_m2__c	Moeda(10, 2)
Piso	snap_mall__Piso__c	Pesquisa(Piso)		Nivel	Deverá neste campo ser informado o Id do nível no sistema GShop
Preço de referência	snap_mall__Preco_referencia__c	Moeda(10, 2)
Rateio do condomínio	snap_mall__Rateio_condominio__c	Porcentagem(12, 4)
Shopping	snap_mall__shopping__c	Pesquisa(Shopping)		IdFilial
Situação	snap_mall__Situacao_Comercial__c	Lista de opções	X		Opções possíveis: Assuntos especiais Ativa Com proposta Contrato assinado Contrato assinado pela empresa Contrato assinado pelo lojista Despejo Em locação Em prospecção Nova proposta Proposta aprovada Prospecção Repasse Reserva técnica Vaga
Subgrupo	snap_mall__Subgrupo_sap__c	Pesquisa(Subgrupo)
Telefonia e internet	snap_mall__Telefonia_internet__c	Booleano
Tipo de condomínio	snap_mall__tipo_condominio__c	Lista de opções			Opções possíveis: Fixo Rateio
Tipo de FP	snap_mall__tipo_fp__c	Lista de opções			Opções possíveis: 20% do AMM Rateio Fixo 20% do AMM com limitador
Tipo de unidade	snap_mall__Tipo_unidade__c	Pesquisa(Tipo de unidade)	X	TipoDeLoja
Unidade relacionada	snap_mall__Unidade_relacionada__c	Texto(20)
Valor do aluguel atual	snap_mall__valor_aluguel_atual__c	Moeda(10, 2)
Valor do CDU por m2	snap_mall__valor_cdu_m2__c	Moeda(10, 2)
Valor do condomínio por m2	snap_mall__valor_condominio_m2__c	Moeda(10, 2)
Valor do FP por m2	snap_mall__valor_fp_m2__c	Moeda(10, 2)

Criar Loja:

Método :POST

URI: https://{{dominio}}/services/apexrest/v1/sobjects/snap_mall__loja__c/criarUnidade

Descrição: Método de criação de uma Unidade(snap_mall__loja__c),

informando todos os campos utilizados por uma Loja. Retornando o Id da Unidade

Request (Exemplo)

{"unidade":[
{
"Name":"Unidade EFO - Teste - 1",
"RecordType":{"Name":"Loja"},
"snap_mall__Situacao_Comercial__c":"Vaga",
"snap_mall__shopping__c":"40028922",
"snap_mall__Alugada__c":"true",
"snap_mall__ativa__c":"true",
"snap_mall__inaugurada__c":"false",
"snap_mall__Area__c":"40",
"snap_mall__area_fachada__c":"200000.12",
"snap_mall__Localizacao_geografica__c":"parcial",
"snap_mall__valor_condominio_m2__c":"1000000",
"snap_mall__tipo_condominio__c":"Fixo",
"snap_mall__Telefonia_internet__c":"false",
"snap_mall__

Tipo

Rateio_

unidade

condominio__c":"

a0g1J00000DHJmr

12",
"snap_mall__valor_fp_

ativa

m2__c":"

false

100000",
"snap_mall__Data_inauguracao__c":"2018-01-01",
"snap_mall__

inaugurada

Energia__c":"

true

false",
"snap_mall__

Complemento

Kva_limite__c":"

complexo

3",
"snap_mall__

Area

Complemento__c":"

50

complexo",
"snap_mall__parametro_cdu_

Piso

m2__c":"

a031J00000eeTp3QAE

1000887",
"snap_mall__valor_aluguel_

corredor

atual__c":"

a0P1J00000TXfLLUA1

3200",
"snap_mall__

Localizacao

ID_

geografica

Externo__c":"

total

421456",
"snap_mall__

parametro

corredor_

aluguel_m2__c":"100000",
"

_c":"40028922"
}
]
}

Response - Sucesso (Exemplo)
{ "sucess" : true, "id" : "a0Q0q000000uOCREA2", "errors" : null }

Alterar Loja:

Método : POST

URI: https://{{dominio}}/services/apexrest/v1/sobjects/snap_mall__

Agua

loja__c

":"true",
"snap_mall__Energia__c":"false",
"

/alterarUnidade

Descrição: Método de criação de uma Unidade(snap_mall__

Kva_limite

loja__c

":"3",
"snap_mall__Telefonia_internet__c":"false",
"snap_mall__Contrato_atual__c":"a071J00000PoB46QAF",
"snap_mall__marca_atual__c":"001o000000TcBeT"

),

informando todos os campos utilizados por uma Loja. Retornando o Id da Unidade

Request (Exemplo)
{"unidade":[ { "Name":"Unidade Alteracao - 1", "RecordType":{"Name":"Loja"}, "snap_mall__

Cliente

Situacao_Comercial__c":"

0011J00001DtTOrQAN

Vaga",
"snap_mall__

marca_anterior

shopping__c":"

0011J00001DwICF

40028922",
"snap_mall__

lojista

Alugada_

_

c":"

0011J00001DtTOr

true",
"snap_mall__

ID

ativa_

Externo

_

c":"

777777"
}

Response

{
"id": "a041J000018PuMPQA0",
"success": true,
"errors": []
}

Atualizar Unidade:

Método : PATCH

URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__loja__c/ (Id do registro salesforce)

URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__loja__c/snap_mall__ID_Externo__c/ (Id externo)

Descrição:

Método de atualização de uma unidade(snap_mall__loja__c) de qualquer tipo, informando no body apenas os campos que se deseja atualizar. Lembrando que devem ser informados apenas campos pertinentes ao tipo de registro escolhido (Loja, Locação temporária e Merchandising).

Existem duas possibilidades de atualização da Unidade: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.

O método PATCH pode ser utilizado par Upsert, em caso do Id externo informado não existir na base e contiver todos os campos obrigatórios no body.

URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__loja__c/

Request

{
"Name":"Unidade I - Espetacúlo

true",
"snap_mall__inaugurada__c":"false",
"snap_mall__Area__c":"40",
"snap_mall__area_fachada__c":"200000.12",
"snap_mall__Localizacao_geografica__c":"parcial",
"snap_mall__valor_condominio_m2__c":"1000000",
"snap_mall__tipo_condominio__c":"Fixo",
"snap_mall__Telefonia_internet__c":"false",
"snap_mall__Rateio_condominio__c":"12",
"snap_mall__valor_fp_m2__c":"100000",
"snap_mall__Data_inauguracao__c":"2018-01-01",
"snap_mall__

ativa

Energia__c":"false"

}

Response

Response de atualização em caso de sucesso retorna vazio.

Deletar Unidade:

Método : DELETE

URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__loja__c/ (Id do registro salesforce)

,
"snap_mall__Kva_limite__c":"3",
"snap_mall__Complemento__c":"complexo",
"snap_mall__parametro_cdu_m2__c":"1000887",
"snap_mall__valor_aluguel_atual__c":"3200",
"snap_mall__ID_Externo__c

/ (Id externo)Descrição: Método de deleção de uma Unidade(

":"421456",
"snap_mall__

ID_Externo__c) de qualquer tipo. Existem duas possibilidades de deleção da Unidade: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.

Request

Body de deleção é vazio.

Response

Response de deleção retorna vazio.

Este artigo identifica e descreve os módulos do SnapMall que podem ser integrados com outros sistemas.

Integração de faturas

corredor__c":"40028922"
}
]
}

Response - Sucesso (Exemplo)
{ "sucess" : true, "id" : "a0Q0q000000uOCREA2", "errors" : null }

Versions Compared

Old Version 3

New Version Current

Key