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
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
- Id do usuário salesforce que será detentor do registro
- Caso não preenchido será o usuário de integração
Opções possiveis:
- true
- false
Opções possíveis:
- true
- false
Opções possíveis:
- true
- false
Opções possíveis:
- true
- false
- Deverá neste campo ser informado o Id do nível no sistema GShop
- 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
Opções possíveis:
- Fixo
- Rateio
Opções possíveis:
- 20% do AMM
- Rateio
- Fixo
- 20% do AMM com limitador
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.
"Name":"Unidade I",
"RecordType":{"Name":"Loja"},
"snap_mall__Situacao_Comercial__c":"Vaga",
"OwnerId":"0051J000004ppUV",
"snap_mall__shopping__c":{"snap_mall__ID_Externo__c":"123456"},
"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":{"snap_mall__ID_Externo__c":"3345678"},
"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",
"
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 |
| |
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:
| ||
Á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:
| ||
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:
| ||
KVA limite | snap_mall__Kva_limite__c | Número(8, 0) | |||
Locada | snap_mall__Alugada__c | Booleano | Opções possíveis:
| ||
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 |
"snap_mall__lojista_anterior__c":"0011J00001DtTOr",
"
Pesquisa(Conta) | Id de uma conta existente | |||
Marca atual | snap_mall__ |
marca_ |
atual__c |
}
{
"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.
"Name":"Unidade II",
"RecordTypeId":"0121J000001DbQC",
"snap_mall__Unidade_relacionada__c":"Outra localizacao",
"OwnerId":"0051J000004ppUV",
"
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 |
| |
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 |
| |
Subgrupo | snap_mall__ |
Subgrupo_ |
sap__c |
"
Pesquisa(Subgrupo) | ||||
Telefonia e internet | snap_mall__ |
Telefonia_internet__c |
"snap_mall__Complemento__c":"2° andar",
"
Booleano | ||||
Tipo de condomínio | snap_mall__ |
tipo_condominio__c |
"
Lista de opções | Opções possíveis:
| |||
Tipo de FP | snap_mall__ |
tipo_ |
fp__c |
"
Lista de opções | Opções possíveis:
| |||
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 |
"snap_mall__Rateio_condominio__c":"12",
"snap_mall__Agua__c":"true",
"
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__
Kvaloja_
limite_
_c":"3","
c/criarUnidade
Descrição: Método de criação de uma Unidade(snap_mall__
Telefonialoja_
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"
),
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":" |
}
{
"id": "a041J000018PuMAQA0",
"success": true,
"errors": []
}
Criar Merchandising:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/Vaga", "snap_mall__shopping__c":"40028922", "snap_mall__Alugada__c":"true", "snap_mall__ |
ativa__c |
":"true", "snap_mall__ |
"Name
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__Energia__c":"false", "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":" |
421456", "snap_mall__ |
corredor__c |
"snap_mall__parametro_aluguel_m2__c":"100000",
"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__Cliente__c":"0011J00001DtTOrQAN",
"snap_mall__marca_anterior__c":"0011J00001DwICF"
":"40028922" } ] } |
Response - Sucesso (Exemplo) |
---|
{ "sucess" : true, "id" : "a0Q0q000000uOCREA2", "errors" : null } |
Alterar Loja:
Método : POST
URI: https://{{dominio}}/services/apexrest/v1/sobjects/snap_mall__loja__c/alterarUnidade
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 Alteracao - 1", "RecordType":{"Name":"Loja"}, "snap_mall__ |
Situacao_ |
Comercial__c":" |
Vaga", "snap_mall |
}
"id
__shopping__c":" |
40028922", " |
snap_mall__Alugada__c":"true", " |
}
Atualizar Unidade:
Método : PATCH
URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/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 |
Descrição:
Método de atualização de uma unidade(":"1000000", "snap_mall__ |
tipo_condominio__c |
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.
"Name":"Unidade I - Espetacúlo
":"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__ |
Energia__c":"false" |
}
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)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__loja_, "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 |
Descrição: Método de deleção de uma Unidade(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.
Body de deleção é vazio.
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":"421456", "snap_mall__corredor__c":"40028922" } ] } |
Response - Sucesso (Exemplo) |
---|
{ "sucess" : true, "id" : "a0Q0q000000uOCREA2", "errors" : null } |