O objeto Estado (snap_mall__estado__c) contém todas as informações de cadastro do centro de custo que serão utilizadas para o cadastro da cidade, no objeto Cidade
Campos de Estado
| Rótulo do campo | Nome de API | Tipo de dados | Obrigatório | Descrição |
|---|---|---|---|---|
| Abreviação | snap_mall__abreviacao__c | Texto(2) | X | Informação da sigla de abreviação do estado |
| Criado por | CreatedById | Pesquisa(Usuário) | X | Preenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração |
| Estado | Name | Texto(80) | X | Informação do nome completo do estado |
| ID Externo | snap_mall__id_externo__c | Texto(80) (ID externo) (Não-diferenciação exclusiva de maiúsculas e minúsculas) | ID do sistema ERP, que poderá ser informado no momento da inserção da conta, para futuras atualizações, através deste ID | |
| País | snap_mall__pais__c | Lista de opções | Lista de países* | |
| Proprietário | OwnerId | Pesquisa(Usuário,Grupo) | ||
| Última modificação feita por | LastModifiedById | Pesquisa(Usuário) | X | Informação do usuário de sistema que realizou a ultima modificação ou usuário da integração |
Criar Estado:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__estado__c/
Descrição: Método de criação de um Estado(snap_mall__estado__c), informando todos os campos utilizados para um tipo.
Request |
|---|
| { "Name":"São Paulo", "snap_mall__estado__c":"a021J00000UcpKk", "snap_mall__id_externo2__c":"987654321" } |
| Response |
|---|
Atualizar Estado:
Método :PATCH
URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__estado__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__estado__c/snap_mall__id_externo__c/ (Id externo)
Descrição:
Método de atualização de um Estado(snap_mall__estado__c) de qualquer tipo, informando no body apenas os campos que se deseja atualizar.
Existem duas possibilidades de atualização do Estado: 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.
Request |
|---|
| { "Name":"São Paulo", "snap_mall__pais__c":"Brasil", "snap_mall__abreviacao__c":"SP" } |
| Response |
|---|
| { "id": "a021J00000UcpPPQAZ", "success": true, "errors": [] } |
Response em caso de sucesso da atualização retornará vazio.
Deletar Cidade:
Método : DELETE
URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__estado__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__estado__c/snap_mall__id_externo__c/ (Id externo)
Descrição: Método de deleção de um Estado(snap_mall__id_externo__c) de qualquer tipo. Existem duas possibilidades de deleção do Estado: 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.