{ "opencollection": "1.0.0", "info": { "name": "Shopmonkey Appointments Work Orders API", "version": "v3" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Work Orders", "type": "folder" }, "items": [ { "info": { "name": "Find all Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.shopmonkey.cloud/v3/order" }, "docs": "CONFIRMED endpoint (shopmonkey.dev/resources/order). Lists work orders with filtering, pagination, and sorting." }, { "info": { "name": "Create one Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.shopmonkey.cloud/v3/order", "body": { "type": "json", "data": "{}" } }, "docs": "CONFIRMED endpoint. Creates a new work order for a customer/vehicle at a location." }, { "info": { "name": "Find one Order by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.shopmonkey.cloud/v3/order/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Update one Order by id", "type": "http" }, "http": { "method": "PUT", "url": "https://api.shopmonkey.cloud/v3/order/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Apply a status action to an Order", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.shopmonkey.cloud/v3/order/:id/:action", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." }, { "name": "action", "value": "", "type": "path", "description": "Status transition action (e.g. approve, close, void) applied to the order." } ] }, "docs": "CONFIRMED endpoint (path shape). Applies a workflow action/status transition to an order." }, { "info": { "name": "Move an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.shopmonkey.cloud/v3/order/:id/move", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint. Moves an order between workflow columns/statuses." }, { "info": { "name": "Calculate pricing for an Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.shopmonkey.cloud/v3/order/:id/calculated_pricing", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint. Returns recalculated pricing totals for the order." }, { "info": { "name": "Find Order authorizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.shopmonkey.cloud/v3/order/:id/authorization", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Request an Order authorization", "type": "http" }, "http": { "method": "POST", "url": "https://api.shopmonkey.cloud/v3/order/:id/authorization", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Update an Order authorization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.shopmonkey.cloud/v3/order/:id/authorization/:authorizationId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." }, { "name": "authorizationId", "value": "", "type": "path" } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Attach a file to an Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.shopmonkey.cloud/v3/order/:id/file", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Remove a file from an Order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.shopmonkey.cloud/v3/order/:id/file/:fileId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." }, { "name": "fileId", "value": "", "type": "path" } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Get the Order as a PDF", "type": "http" }, "http": { "method": "GET", "url": "https://api.shopmonkey.cloud/v3/order/:id/pdf", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Find all Services on an Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.shopmonkey.cloud/v3/order/:orderId/service", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Parent order identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Add a Service to an Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.shopmonkey.cloud/v3/order/:orderId/service", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Parent order identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Update a Service on an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.shopmonkey.cloud/v3/order/:orderId/service/:id", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Parent order identifier." }, { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Remove a Service from an Order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.shopmonkey.cloud/v3/order/:orderId/service/:id", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Parent order identifier." }, { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Find all Parts on an Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.shopmonkey.cloud/v3/order/:orderId/part", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Parent order identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Add a Part to a Service on an Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.shopmonkey.cloud/v3/order/:orderId/part", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Parent order identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Update Bulk Parts for an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.shopmonkey.cloud/v3/order/:orderId/part_bulk", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Parent order identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "Retrieve orders associated with a specific customer", "type": "http" }, "http": { "method": "GET", "url": "https://api.shopmonkey.cloud/v3/customer/:id/order", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." }, { "info": { "name": "List service orders for a vehicle", "type": "http" }, "http": { "method": "GET", "url": "https://api.shopmonkey.cloud/v3/vehicle/:id/orders", "params": [ { "name": "id", "value": "", "type": "path", "description": "Resource identifier." } ] }, "docs": "CONFIRMED endpoint." } ] } ], "bundled": true }