Tote

Alterar uma loja

Sandbox

https://horizon-api-sb.app.rpe.tech

PATCH

/api/v1/lojas/{idLoja}

Lojas

Use este endpoint para alterar o cadastro de um estabelecimento.

Serviço exclusivo para processadora Dock.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://horizon-api-sb.app.rpe.tech/api/v1/lojas/' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "razaoSocial": "RETAIL PAYMENT ECOSSYSTEM",
    "inscricaoEstadual": "123.456.789-1112",
    "endereco": {
        "rua": "Rua Rodrigo Mayume Chaves Piscina Júnior",
        "bairro": "Bessa",
        "localidade": "João Pessoa",
        "uf": "PB",
        "complemento": "CORE",
        "numero": "123",
        "cep": "99999999"
    },
    "telefone": {
        "area": "83",
        "numero": "999999999"
    },
    "telefoneAdicional": {
        "area": "83",
        "numero": "999999999"
    },
    "email": "rpe@rpe.tech",
    "observacao": "Modelo de response: cadastro de lojas."
}'

Response Example

200 - Processadora Dock

{
    "id": 33,
    "razaoSocial": "RETAIL PAYMENT ECOSSYSTEM",
    "nomeFantasia": "RPE",
    "logradouro": "Rua das Flores",
    "numero": "123",
    "complemento": "CORE",
    "cep": "99999999",
    "bairro": "Bessa",
    "cidade": "João Pessoa",
    "estado": "PB",
    "cnpj": "28485091000111",
    "dataCadastro": "2025-02-07T11:05:45.513516",
    "idExterno": "c1b2c3d4e5d8",
    "email": "rpe@rpe.tech",
    "inscricaoEstadual": "596362135910",
    "telefone": {
        "id": 65,
        "area": "83",
        "numero": "99999999"
    },
    "telefoneAdicional": {
        "id": 66,
        "area": "83",
        "numero": "999999999"
    },
    "numeroEstabelecimento": 123456,
    "naturezaEstabelecimento": "PROPRIO",
    "observacao": "Modelo de response: cadastro de lojas."
}

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

idLoja

integer <int64>

requerido

Identificador do estabelecimento.

Padrão:

Exemplo:

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Parâmetros Bodyapplication/json

Informações sobre o estabelecimento.

razaoSocial

string

requerido

Razão social do estabelecimento.

<= 256 Caracteres

Exemplo:

RETAIL PAYMENT ECOSSYSTEM

inscricaoEstadual

string

opcional

Inscrição estadual do estabelecimento.

Para cada nova requisição, é necessário alterar a inscricaoEstadual.

<= 16 Caracteres

Exemplo:

123.456.789-1112

Padrão de combinação:

(^[0-9-./]*)|^$

endereco

object (EnderecoRequest)

requerido

Informações sobre o endereço.

rua

string

requerido

Endereço físico da loja ou da unidade de negócio.

<= 256 Caracteres

Exemplo:

Rua Rodrigo Mayume Chaves Piscina Júnior

bairro

string

requerido

Bairro onde a loja ou unidade de negócio está localizada.

<= 256 Caracteres

Exemplo:

Bessa

localidade

string

requerido

Cidade onde o estabelecimento está cadastrado.

<= 256 Caracteres

Exemplo:

João Pessoa

string

requerido

Estado onde o estabelecimento está cadastrado.

>= 2 Caracteres<= 2 Caracteres

Exemplo:

complemento

string

opcional

Complemento do endereço, se houver.

<= 256 Caracteres

Exemplo:

CORE

numero

string

opcional

Número do endereço do estabelecimento.

<= 64 Caracteres

Exemplo:

123

cep

string

requerido

CEP (Código de Endereçamento Postal) associado ao endereço da loja ou unidade de negócio.

Exemplo:

99999999

Padrão de combinação:

[0-9]{8}

telefone

TelefoneRequest

requerido

Informações para requisição de adição de telefone.

One of

allOf {2}

One of

TelefoneRequest

Processadora Cards

Informações para requisição de adição de telefone.

telefoneAdicional

TelefoneRequest

opcional

Informações para requisição de adição de telefone.

One of

allOf {2}

One of

TelefoneRequest

Processadora Cards

Informações para requisição de adição de telefone.

string

opcional

Email do estabelecimento.

<= 64 Caracteres

Exemplo:

rpe@rpe.tech

observacao

string

opcional

Obsevação sobre o estabelecimento.

<= 256 Caracteres

Exemplo:

Modelo de response: cadastro de lojas.

Examples

Respostas

🟢200OK

application/json

Body

opcional

One of

Processadora Dock

integer

opcional

Identificador do estabelecimento.

Exemplo:

dataCadastro

string <date-time>

opcional

Data e hora de cadastro do estabelecimento.

Exemplo:

2025-02-07T11:05:45.513516

idExterno

string

opcional

Identificador externo.

Exemplo:

c1b2c3d4e5d8

nomeFantasia

string

opcional

Nome fantasia do estabelecimento.

Exemplo:

RPE

razaoSocial

string

opcional

Razão social.

Exemplo:

RETAIL PAYMENT ECOSSYSTEM

cnpj

string

opcional

CNPJ do estabelecimento.

Exemplo:

28485091000111

inscricaoEstadual

string

opcional

Inscrição estadual do estabelecimento.

Para realizar testes, gere uma nova inscricaoEstadual a cada requisição utilizando a ferramenta de sua escolha.

Exemplo:

596362135910

endereco

object

opcional

Informações sobre o endereço do estabelecimento.

telefone

object

opcional

Informações do telefone do estabelecimento.

telefoneAdicional

object

opcional

Informações do telefone adicional do estabelecimento.

string

opcional

Email do estabelecimento.

Exemplo:

rpe@rpe.tech

observacao

string

opcional

Obsevação sobre o estabelecimento.

Exemplo:

Modelo de response: cadastro de lojas.

numeroEstabelecimento

integer <int64>

opcional

Número do estabelecimento.

Exemplo:

123456

naturezaEstabelecimento

enum<string>

opcional

Natureza do estabelecimento.

Valores permitidos:

PROPRIOCREDENCIADO

Exemplo:

PROPRIO

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor