Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

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 campoNome de APITipo de dadosObrigatórioDescrição
Abreviaçãosnap_mall__abreviacao__cTexto(2)XInformação da sigla de abreviação do estado
Criado porCreatedByIdPesquisa(Usuário)XPreenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração
EstadoNameTexto(80)X
Informação do nome completo do estado
ID Externosnap_mall__id_externo__cTexto(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íssnap_mall__pais__cLista de opções

Lista de países*

ProprietárioOwnerIdPesquisa(Usuário,Grupo)

Última modificação feita porLastModifiedByIdPesquisa(Usuário)XInformaçã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":"Sao Paulo"

}


Response

Response em caso de sucesso da atualização retornará vazio.


Deletar Estado:

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__estado__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.