STORE

Endpoints

Search stores

GET /store

Description: Returns all registered stores, with the ability to filter by status, name, external ID, among others.

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

Responses:

  • 200 OK: Returns a list of stores.
  • 422 Unprocessable Entity: Invalid parameters.

Create store

POST /store

Description: Creates a new store.

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": "Example Store",
  "company_name": "Example Company",
  "store_id": "EX123"
}

Responses:

  • 201 Created: Store created successfully.
  • 400 Bad Request: Invalid parameters.

Search store by id

GET /store/{id}

Description: Returns a store by id.

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

Responses:

  • 200 OK: Returns the store.
  • 404 Not Found: Store not found.

Edit store

PUT /store/{id}

Description: Edits an existing store.

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": "New Name",
  "company_name": "New Company"
}

Responses:

  • 202 Accepted: Store edited successfully.
  • 404 Not Found: Store not found.

Deactivate store

DELETE /store/{id}

Description: Deactivates an existing store.

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

Responses:

  • 200 OK: Store deactivated successfully.
  • 404 Not Found: Store not found.
Transaction V2
Employee