BigShop Developer

Returns the current health status of the API.

List all customers with optional filtering and pagination.

Create a new customer record.

Retrieve a single customer record.

Update a customer record. Only fields you include are changed; omitted fields are left untouched.

Soft-delete a customer. The record is hidden from list endpoints but kept on the underlying row so historical work orders / invoices keep resolving the customer name.

List all vehicles with optional filtering and search capabilities.

Create a new vehicle record.

Retrieve a single vehicle record.

Update a vehicle record. Only fields you include are changed.

Soft-delete a vehicle. The record is hidden from list endpoints; historical work orders keep resolving the vehicle display name.

Create a service request. Returns 201 with the new request's id, requestNumber (e.g. SR-4F9A2C), and status. Pass a stable clientRequestId to make retries idempotent — a repeat within a short window returns the same request with duplicate: true.

List all work orders with filtering options.

Retrieve a single work order with fully assembled service blocks, line items (labor / parts / tires / materials / fees), and resolved customer / vehicle names.

Create a new work order.

Update top-level work-order fields (status, priority, name, description, due date, assigned technicians, etc.). For per-service-block edits use the /services/{svcId} endpoints below; this route does not overwrite the nested services array.

Soft-delete a work order. Use the dedicated /permanent-delete endpoint (admin only) for hard deletion of test data; soft-deleted records can be restored via /restore.

Update a single service block (name, description, labor entries, parts, tires, financials). Pass version from your last read; on conflict the server returns 409 and the latest stored version.

Remove a service block (and its labor / parts / tires / materials line items) from a work order. Totals on the work order are recomputed server-side.

Update a single line item (labor, part, tire, material, fee) inside a service block. Use this for small edits like changing labor status or part quantity without re-PATCHing the whole service block.

Remove a single line item from a service block.

List all inventory items.

List all purchase orders for the shop. Filter by status (e.g. ordered), vendor ID, or date range.

Retrieve details of a single purchase order including line items (parts), received counts, unit costs, and audit log.

Create a new purchase order. Supports optional Idempotency-Key header to prevent duplicate orders on retry.

Receive line items on an existing purchase order directly into shop inventory. Updates stock levels, logs receipt entries, and marks the purchase order received.

List all inspection records.

Retrieve a single inspection with all its line items (passed / failed / NA results, photos, technician notes).

Update top-level inspection fields (status, technician, notes). Use the dedicated /items/{itemId} endpoint to edit individual checklist items.

Soft-delete an inspection. Photos remain in S3 (lifecycle policy handles eventual cleanup); the record is hidden from list endpoints.

List all users in the shop.

Get the current authenticated user's profile.

Create a new shop user. The user receives an email invite with a temporary password unless password is set explicitly.

Retrieve a user by ID, including admin-only fields like isActive, last login, and permission overrides.

Update user fields (name, role, phone). Admin-only. To change a password use /set-password instead.

Soft-delete a user. The user can no longer log in, but historical work-order assignments still resolve their name. Use /permanent-delete for irreversible removal of test accounts.

Force-set a user's password (admin-initiated reset). The new password is hashed server-side; the plaintext is never stored or echoed back.

Re-enable a previously deactivated user. The user can log in again immediately; historical assignments are unchanged.

Disable a user without deleting them. The user can no longer log in or appear in technician pickers, but their historical activity is preserved. Reverse with /activate.

Hard-delete a user record. Irreversible. Use this only for test accounts or compliance-mandated deletion (right-to-be-forgotten); historical work-order assignments will fall back to displaying just the user ID.

List all configured webhooks for your tenant.

Register a new webhook subscription. Returns the endpoint secret (whsec_...) once upon creation. Use HTTPS URLs in production.

Request Body

{
  "name": "ASA Pro Parts Bot",
  "url": "https://integration.asarepair.com/api/webhooks/bigshop",
  "events": [
    "inventory.created",
    "inventory.updated",
    "purchase_order.received"
  ]
}

Response (201 Created)

{
  "data": {
    "id": "7f8b9a2c-4d3e-4b1a-8c9d-1e2f3a4b5c6d",
    "name": "ASA Pro Parts Bot",
    "url": "https://integration.asarepair.com/api/webhooks/bigshop",
    "secret": "whsec_0000000000000000000000000000000000000000",
    "events": ["inventory.created", "inventory.updated", "purchase_order.received"],
    "isActive": true,
    "createdAt": "2026-10-04T01:23:45.678Z",
    "warning": "Store this secret securely. It will not be shown again."
  }
}