UNIDAD

Endpoints

Buscar unidades

GET /store

Descripción: Devuelve todas las unidades registradas, pudiendo filtrar por estado, nombre, id externo, entre otros.

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: */*

Respuestas:

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

Criar unidade

POST /store

Descripción: Crea una nueva unidad.

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": "Tienda Ejemplo",
  "company_name": "Empresa Ejemplo",
  "store_id": "EX123"
}

Respostas:

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

Buscar unidade por id

GET /store/{id}

Descripción: Devuelve una unidad por id.

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

Respuestas:

  • 200 OK: Devuelve la unidad.
  • 404 Not Found: Unidad no encontrada.

Editar unidade

PUT /store/{id}

Descripción: Edita una unidad 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": "Nuevo Nombre",
  "company_name": "Nueva Empresa"
}

Respuestas:

  • 202 Accepted: Unidad editada con éxito.
  • 404 Not Found: Unidad no encontrada.

Inactivar unidade

DELETE /store/{id}

Descripción: Inactiva una unidad existente.

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

Respuestas:

  • 200 OK: Unidad inactivada con éxito.
  • 404 Not Found: Unidad no encontrada.