Shopmonkey MCP by usefulapi

Fetch the user this API key acts as — id, name, company, default location and permissions. A cheap way to confirm the key works and to find your locationId. Shopmonkey: GET /v3/user/me.

无需输入参数。

Search customers with a server-side filter, sort and paging. Returns customers with their emails and phone numbers. Shopmonkey: POST /v3/customer/search.

Find the customers that own any of the given phone numbers — the usual way to identify a caller. Shopmonkey: POST /v3/customer/phone_number/search.

Find the customers that own any of the given email addresses. Shopmonkey: POST /v3/customer/email/search.

Fetch a single customer by id — contact details, emails, phone numbers, counts of vehicles/orders/appointments. Shopmonkey: GET /v3/customer/:id.

List the vehicles owned by a customer (year/make/model, VIN, plate, mileage). Shopmonkey: GET /v3/customer/:id/vehicle.

List a customer's work orders (estimates, repair orders, invoices) — their service history. Shopmonkey: GET /v3/customer/:id/order.

Fetch a single vehicle by id, including its mileage and tire-pressure logs. Shopmonkey: GET /v3/vehicle/:id.

List work orders for the shop, paged. Use orderBy: {createdDate: 'desc'} for newest first. Each order carries its number, status flags, totals in cents, workflow status and assigned technicians. For name/date filters use shopmonkey_search_orders; for one customer's orders use shopmonkey_list_customer_orders. Shopmonkey: GET /v3/order.

Find work orders by case-insensitive name substring, creation date, customer or status. Reads pages and checks filters locally because some shops ignore GET filters. Scans 300 orders by default and at most 500 per call; continue with nextScanSkip. On vendor throttling, wait retryAfterSeconds before continuing; do not restart from 0. Matches are sorted by createdDate, newest first, then paged with limit/matchSkip (default 100 results). complete: false means only a segment was scanned: newer matches may exist outside it; continue with nextScanSkip or increase maxOrders. scanSkip is a scan offset, not a matched-result offset. A changing order list can shift offsets; restart from 0 for a fresh search. Shopmonkey: GET /v3/order.

Read purchase orders with parts, tires, received quantities, inventory links and Draft/Ordered/Received/Fulfilled/Cancelled status. Paged; use orderBy for sorting. The public API documents reads and deletions, but no create/update/receive endpoints: change status, Receive All and inventory linking in the Shopmonkey UI. Shopmonkey: GET /v3/purchase_order.

Read one purchase order, including its status, vendor, parts/tires, ordered and received quantities, inventory links and associated work order. Purchase-order creation, status changes and receiving are not documented public API operations; use the Shopmonkey UI for those writes. Shopmonkey: GET /v3/purchase_order/:id.

Fetch a single work order by id — customer, vehicle, complaint, totals (parts/labor/tax in cents), payment state and profitability. Shopmonkey: GET /v3/order/:id.

List the files attached to a work order (photos, screenshots, PDFs such as part slips): id, name, type, size, whether original/thumbnail links exist and availableVariants that have safe download links. Use shopmonkey_get_order_file with a file id to see the content, for example to read the text of a part slip. Shopmonkey's public API has no separate notes endpoint: an image added in a note is listed here only if Shopmonkey stores it as an order file. Shopmonkey: GET /v3/order/:id (files).

Return one file attached to a work order so you can see it: a JPEG, PNG, GIF or WebP image as image content (read the text of a part slip or screenshot from it), a PDF as an embedded file. Get fileId and availableVariants from shopmonkey_list_order_files. With variant omitted, use the original link when available, otherwise its safe thumbnail link; the result states the actual variant. An explicit variant is never substituted. variant "thumbnail" returns Shopmonkey's smaller preview: use it when the original is larger than 3 MB or a HEIC/TIFF photo. Read-only. Shopmonkey: GET /v3/order/:id, then the file's link.

Find a work order by the number the shop sees (e.g. 1042 or #1042), also matching an overridden external number. Tries server-side filters on the first call, then scans newest first, comparing numbers exactly. Scans 300 orders by default, at most 500 and five scan requests per call. If not found and hasMore is true, continue with nextScanSkip as scanSkip and the same number; do not restart from 0. On rateLimited wait retryAfterSeconds (about 60 seconds if absent). A changing order list can shift offsets. Returns the order or found: false for the scanned segment; complete is true only when a scan from 0 reaches the end. Shopmonkey: GET /v3/order.

List the services (jobs) on a work order with their line items — labor, parts, tires, fees, subcontracts — authorization status and totals. Shopmonkey: GET /v3/order/:orderId/service.

Search the appointment calendar by date range, customer, order or technician. Returns appointments with their customer. Shopmonkey: POST /v3/appointment/search.

Search the parts inventory — name, part number, SKU, quantity on hand/available/reserved, retail and wholesale cost in cents, bin location, brand and vendor. Filter e.g. {"sku": "ABC-123"}. Shopmonkey: POST /v3/inventory_part/search.

List the shop's canned services (reusable job templates like 'Oil change') with their labor, parts and fees and total in cents. Shopmonkey: GET /v3/canned_service.

List the workflow statuses (the columns of the shop's work-order board) with their position. Use the id to move an order with shopmonkey_update_order. Shopmonkey: GET /v3/workflow_status.

List the shop's users (service writers, technicians, admins) — the ids to use for technicians and service writers. Shopmonkey: GET /v3/user.

Find time entries and their ids, technician, order, activity, running state, clock-in/out times and duration. Use inProgress: true to reconcile a clock-in/out whose response was uncertain. Paginate with limit/skip. Shopmonkey: POST /v3/timesheet/search (read-only).

Read one time entry to inspect its technician, order, activity, running state and clock-in/out times. Use the timesheetId returned by shopmonkey_clock_in or shopmonkey_list_time_entries. Shopmonkey: GET /v3/timesheet/:id.

Start an order-level timer now for orderId and technicianId (a user id from shopmonkey_list_users). Omit confirm to preview; confirm: true starts it. Reuses an already-running timer on this order and refuses to silently stop/switch any other activity. Returns timesheetId for clock-out and verifies the running entry. Never automatically retries a write; after an uncertain response inspect shopmonkey_list_time_entries. Does not backdate or edit recorded hours. Shopmonkey: POST /v3/timesheet/clock_in with activity Order.

Stop an order-level timer now, scoped to orderId and technicianId. Pass timesheetId from clock-in/list, or omit it to resolve exactly one active matching entry. Omit confirm to preview, then call with the preview's timesheetId and confirm: true. Checks entry ownership/activity and verifies it stopped. Already-stopped entries are returned without a write. Never automatically retries; inspect shopmonkey_get_time_entry after an uncertain response. Does not edit past hours. Shopmonkey: PUT /v3/timesheet/:id/clock_out.

Create a customer (a person) or a fleet account. Add an email afterwards with shopmonkey_add_customer_email. Shopmonkey: POST /v3/customer.

Update a customer's name, address, note or preferences. Only the fields you pass are sent. Shopmonkey: PUT /v3/customer/:id.

Add an email address to an existing customer, optionally as their primary address. Shopmonkey: POST /v3/customer/:id/email.

Create a vehicle, optionally attached to a customer. Shopmonkey: POST /v3/vehicle.

Open a new work order (it starts as an estimate) for a customer and vehicle. Add services and labor with shopmonkey_add_service. Shopmonkey: POST /v3/order.

Update a work order — move it to another workflow status, change its status (Estimate, RepairOrder, Invoice), edit complaint/recommendation, due date, service writer, or archive it. Only the fields you pass are sent. Shopmonkey: PUT /v3/order/:id.

Book an appointment on the shop calendar, optionally for a customer, vehicle and order and assigned to technicians. Confirmation/reminder messages are only sent if you ask. Shopmonkey: POST /v3/appointment.

Change an existing appointment — move it (new startDate/endDate), rename it, change its note, color, technicians, customer, vehicle or linked order, or set its confirmation status. Only the fields you pass are sent, so nothing is duplicated. Find the id with shopmonkey_search_appointments. Shopmonkey: PUT /v3/appointment/:id.

WRITE — removes an appointment from the shop calendar. To move it instead, use shopmonkey_update_appointment. Without confirm it only previews: it reads the appointment and deletes nothing. Show the preview to the user, then call again with confirm: true. After the delete the appointment is read again to verify it is gone. Shopmonkey: DELETE /v3/appointment/:id.

Add a new service (job) to a work order, e.g. 'Road Call', optionally with labor lines (name, hours, hourly rate in cents). The service is created first, then each labor line is added to it. Find the order id with shopmonkey_find_order_by_number. To add labor to a service that exists, use shopmonkey_add_labor. Shopmonkey: POST /v3/order/:orderId/service, then POST /v3/order/:orderId/service/:serviceId/labor.

Copy a saved canned service onto an existing work order in one vendor request, including its labor, parts and fees. Use shopmonkey_list_canned_services for cannedServiceId. Creates a new service each time; check shopmonkey_list_order_services before retrying an uncertain result. Shopmonkey: POST /v3/order/:orderId/service with fromCannedServiceId.

Add a fixed-cent fee/surcharge to an existing work order service, e.g. amountCents: 3000 for a $30 fuel or on-site fee. Uses the vendor's FixedCents fee type, not a labor line. Get serviceId with shopmonkey_list_order_services. Each call creates a fee; check the service before retrying an uncertain result. Shopmonkey: POST /v3/order/:orderId/service/:serviceId/fee.

Send a free-form customer message by Email, SMS or All through Shopmonkey messaging. This sends the supplied text without sharing an estimate or changing order authorization. Contact ids must belong to customerId; omitted ids use the primary or only contact (or the selected order contact when orderId is given). Optional orderId must belong to this customer. Returns message delivery statuses; creation does not guarantee delivery. Shopmonkey: GET /v3/customer/:id, optionally GET /v3/order/:id, then POST /v3/message.

Add a labor line (name, hours, hourly rate in cents, technician) to a service on a work order. Get the service id with shopmonkey_list_order_services; to start a new service, use shopmonkey_add_service. Shopmonkey: POST /v3/order/:orderId/service/:serviceId/labor.

Share a work order's estimate through Shopmonkey messaging by Email, SMS or All. Reads the order and customer, enables customer authorization on the order, then creates an Order share message. This requests the customer's approval; it does not record approval. Supply the message text. Contact ids must belong to the order's customer; omitted ids use the order's selected contact, the primary contact, or the only contact. Returns Shopmonkey's message and delivery statuses (creation does not guarantee delivery). Invoiced or deleted orders cannot be sent. Shopmonkey: GET /v3/order/:id, GET /v3/customer/:id, PUT /v3/order/:id, POST /v3/message.

Add a part line to an existing service on a work order. Use shopmonkey_list_order_services for serviceId and shopmonkey_search_inventory_parts for inventoryPartId. Prices are per unit in cents; quantity may be fractional. Inventory reservation and reduction happen only if explicitly requested. Returns data.part with the new part id. This does not create or fulfill a vendor purchase order: those writes are not documented in Shopmonkey's public API. Shopmonkey: POST /v3/order/:orderId/service/:serviceId/part.

Preview then remove one service and all its labor, parts, fees, tires and subcontract lines. Show the cascade preview before confirming with its fingerprint. Refuses authorized/invoiced/paid/archived/deleted/read-only orders, orders with payments or a non-Unlocked invoiceLockState, authorized services and inventory/PO-linked parts or tires. Verifies absence after deletion. DELETE /v3/order/:orderId/service/:id.

Preview then remove one labor line belonging to this work order service. Show the preview, then confirm with its fingerprint. Refuses authorized/invoiced/paid/archived/deleted/read-only orders, orders with payments or a non-Unlocked invoiceLockState, and authorized services. Verifies absence. DELETE /v3/order/:orderId/service/:serviceId/labor/:id.

Preview then remove one part line belonging to this work order service. Show the preview, then confirm with its fingerprint. Refuses authorized/invoiced/paid/archived/deleted/read-only orders, orders with payments or a non-Unlocked invoiceLockState, authorized services and inventory/PO-linked parts. Verifies absence. DELETE /v3/order/:orderId/service/:serviceId/part/:id.