UNIDADE

Endpoints

Buscar unidades

GET /store

Descrição: Retorna todas as unidades cadastradas, podendo filtrar por status, nome, id externo, entre outros.

GET /public/store?limit=100&page=1&status=active HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respostas:

  • 200 OK: Retorna lista de unidades.
  • 422 Unprocessable Entity: Parâmetros inválidos.

Criar unidade

POST /store

Descrição: Cria uma nova unidade.

POST /public/store HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*

{
  "trade_name": "Loja Exemplo",
  "company_name": "Empresa Exemplo",
  "store_id": "EX123"
}

Respostas:

  • 201 Created: Unidade criada com sucesso.
  • 400 Bad Request: Parâmetros inválidos.

Buscar unidade por id

GET /store/{id}

Descrição: Retorna uma unidade pelo id.

GET /public/store/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respostas:

  • 200 OK: Retorna a unidade.
  • 404 Not Found: Unidade não encontrada.

Editar unidade

PUT /store/{id}

Descrição: Edita uma unidade existente.

PUT /public/store/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*

{
  "trade_name": "Novo Nome",
  "company_name": "Nova Empresa"
}

Respostas:

  • 202 Accepted: Unidade editada com sucesso.
  • 404 Not Found: Unidade não encontrada.

Inativar unidade

DELETE /store/{id}

Descrição: Inativa uma unidade existente.

DELETE /public/store/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respostas:

  • 200 OK: Unidade inativada com sucesso.
  • 404 Not Found: Unidade não encontrada.