BigShop API
Build powerful integrations with the BigShop Truck Repair Management Platform.
https://api.bigshopai.com/v1
Authentication
Include your API key in the X-Api-Key header:
curl -X GET "https://api.bigshopai.com/v1/customers" \
-H "X-Api-Key: YOUR_API_KEY"Error Codes
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Error |
❤️ Health Check
Check the API status and availability.
/v1/health
Returns the current health status of the API.
🏢 Customers
Manage customer records for your repair shop.
/v1/customers
List all customers with optional filtering and pagination.
Query Parameters
| limit | integer | Max results (default: 50) |
| offset | integer | Skip results for pagination |
| search | string | Search by name or email |
/v1/customers
Create a new customer record.
Request Body
| name | string | Customer name |
| type | string | company | individual |
| string | Contact email | |
| phone | string | Phone number |
🚛 Vehicles
Manage vehicle records linked to customers.
/v1/vehicles
List all vehicles with optional filtering.
Query Parameters
| customerId | string | Filter by customer |
| limit | integer | Max results |
/v1/vehicles
Create a new vehicle record.
Request Body
| customerId | string | Owner customer ID |
| vin | string | Vehicle Identification Number |
| licensePlate | string | License plate number |
| make | string | Vehicle make (e.g., Peterbilt) |
| model | string | Vehicle model |
| year | integer | Model year |
| mileage | integer | Current mileage |
📋 Work Orders
Manage repair work orders and service tickets.
/v1/work-orders
List all work orders with filtering options.
Query Parameters
| status | string | pending | in_progress | completed | cancelled |
| customerId | string | Filter by customer |
| vehicleId | string | Filter by vehicle |
/v1/work-orders
Create a new work order.
Request Body
| customerId | string | Customer ID |
| vehicleId | string | Vehicle ID |
| complaint | string | Customer complaint description |
| priority | string | low | medium | high | urgent |
| assignedTo | string | Technician user ID |
📦 Inventory
Manage parts and supplies inventory.
/v1/inventory
List all inventory items.
Query Parameters
| category | string | Filter by category |
| lowStock | boolean | Show only low stock items |
| search | string | Search by name or SKU |
🔍 Inspections
Manage vehicle inspection records.
/v1/inspections
List all inspection records.
Query Parameters
| vehicleId | string | Filter by vehicle |
| workOrderId | string | Filter by work order |
| status | string | passed | failed | pending |
👥 Users
Manage shop users and technicians.
/v1/users
List all users in the shop.
Query Parameters
| role | string | admin | manager | technician | service_writer |
| active | boolean | Filter by active status |
/v1/users/me
Get the current authenticated user's profile.
🔔 Webhooks
Configure webhooks to receive real-time notifications.
/v1/webhooks
List all configured webhooks.
Available Webhook Events
| Event | Description |
|---|---|
| work_order.created | New work order created |
| work_order.updated | Work order status changed |
| work_order.completed | Work order marked complete |
| customer.created | New customer added |
| vehicle.created | New vehicle added |
| inspection.completed | Inspection finished |
| inventory.low_stock | Item below threshold |