{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/bqf.ai" } ], "info": { "name": "AC POS API", "_postman_id": "cdccd530-1338-46be-b86a-1ec1bd098185", "description": "AC POS Connector API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Attendance (HRM)", "description": "", "item": [ { "name": "Latest attendance record", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/get-attendance\/:user_id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/get-attendance\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": "12", "description": "The employee's user id (yourself, or another employee for attendance managers)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The employee's most recent day record and whether they are clocked in now (kept for\napps that used the older Essentials-shaped endpoint)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\"user_id\": 12, \"business_id\": 1, \"attendance_date\": \"2026-09-24\", \"clock_in_time\": \"2026-09-24 09:02:11\", \"clock_out_time\": null,\n \"status\": \"present\", \"late_minutes\": 0, \"worked_minutes\": 0, \"overtime_minutes\": 0, \"state\": {\"in\": true, \"since\": \"2026-09-24 09:02:11\"}}\n}", "name": "" } ] }, { "name": "Clock in", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/clock-in", "query": [], "raw": "{{baseUrl}}\/connector\/api\/clock-in" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"latitude\":24.7136,\"longitude\":46.6753,\"accuracy_m\":12,\"clock_in_note\":\"from the app\",\"user_id\":12}" }, "description": "Records the clock-in at the server's time. With the phone's position the branch geofence\nis applied: in `warn` mode an outside punch is recorded and flagged, in `block` mode it is\nrefused (422 `outside_geofence`), and a punch with no position is refused (422\n`location_required`) unless the phone is on the branch's own network." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true, \"msg\": \"Clocked in at 09:02\", \"type\": \"clock_in\",\n \"punch\": {\"id\": 5, \"type\": \"in\", \"at\": \"2026-09-24 09:02:11\", \"source\": \"mobile\", \"within_geofence\": true, \"distance_m\": 34},\n \"state\": {\"in\": true, \"since\": \"2026-09-24 09:02:11\"}\n}", "name": "" } ] }, { "name": "Clock out", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/clock-out", "query": [], "raw": "{{baseUrl}}\/connector\/api\/clock-out" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"latitude\":24.7136,\"longitude\":46.6753,\"accuracy_m\":12,\"clock_out_note\":\"done\",\"user_id\":12}" }, "description": "Same rules as clock in. The day record (late, early leave, worked and overtime minutes)\nis recomputed from the day's punches and the shift." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true, \"msg\": \"Clocked out at 17:31\", \"type\": \"clock_out\",\n \"punch\": {\"id\": 6, \"type\": \"out\", \"at\": \"2026-09-24 17:31:40\", \"source\": \"mobile\", \"within_geofence\": true, \"distance_m\": 20},\n \"state\": {\"in\": false, \"since\": \"2026-09-24 17:31:40\"},\n \"log\": {\"status\": \"present\", \"clock_in\": \"09:02:11\", \"clock_out\": \"17:31:40\", \"late_minutes\": 0, \"early_leave_minutes\": 0, \"worked_minutes\": 449, \"overtime_minutes\": 31}\n}", "name": "" } ] }, { "name": "My attendance today", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/attendance\/me", "query": [ { "key": "user_id", "value": "12", "description": "Another employee (attendance managers only).", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/attendance\/me?user_id=12" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The employee, their shift for today, whether they are clocked in, today's punches and\nday record, the month so far, and the branch geofence the app should show (mode `off`,\n`warn` or `block`; `lat`\/`lng`\/`radius_m` when the branch has one)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"employee\": {\"user_id\": 12, \"name\": \"Sami\", \"employee_code\": \"E-7\", \"location\": {\"id\": 1, \"name\": \"Main\"}},\n \"state\": {\"in\": true, \"since\": \"2026-09-24 09:02:11\"},\n \"shift\": {\"name\": \"Morning\", \"start\": \"09:00\", \"end\": \"17:00\", \"is_rest_day\": false, \"is_holiday\": false},\n \"today\": {\"punches\": [{\"id\": 5, \"type\": \"in\", \"at\": \"2026-09-24 09:02:11\", \"source\": \"mobile\", \"within_geofence\": true, \"distance_m\": 34}],\n \"log\": {\"status\": \"present\", \"clock_in\": \"09:02:11\", \"clock_out\": null, \"late_minutes\": 0, \"early_leave_minutes\": 0, \"worked_minutes\": 0, \"overtime_minutes\": 0}},\n \"month\": {\"present\": 17, \"late\": 2, \"absent\": 0, \"worked_hours\": 136.5, \"overtime_hours\": 3.5},\n \"geofence\": {\"mode\": \"warn\", \"has_fence\": true, \"lat\": 24.7136, \"lng\": 46.6753, \"radius_m\": 150}\n }\n}", "name": "" } ] }, { "name": "Attendance history", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/attendance\/history", "query": [ { "key": "from", "value": "2026-09-01", "description": "date Start date.", "disabled": false }, { "key": "to", "value": "2026-09-30", "description": "date End date.", "disabled": false }, { "key": "user_id", "value": "12", "description": "Another employee (attendance managers only).", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/attendance\/history?from=2026-09-01&to=2026-09-30&user_id=12" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2026-09-24T21:24:58\",\"to\":\"2026-09-24T21:24:58\",\"user_id\":3}" }, "description": "Day records between two dates (at most 92 days), newest first." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"date\": \"2026-09-24\", \"status\": \"late\", \"clock_in\": \"09:25:00\", \"clock_out\": \"18:15:00\", \"late_minutes\": 15, \"early_leave_minutes\": 0, \"worked_minutes\": 470, \"overtime_minutes\": 75, \"source\": \"mobile\"}]}", "name": "" } ] }, { "name": "My attendance violations", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/attendance\/violations", "query": [ { "key": "user_id", "value": "12", "description": "Another employee (attendance managers only).", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/attendance\/violations?user_id=12" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Open and recently decided violations (lateness, early leave, absence) with their status,\nso the employee can explain from the app." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"id\": 3, \"date\": \"2026-09-22\", \"type\": \"late\", \"minutes\": 20, \"occurrence\": 2, \"penalty_fraction\": 0.15, \"status\": \"justification_requested\", \"justification\": null}]}", "name": "" } ] }, { "name": "Explain a violation", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/attendance\/violations\/:id\/justify", "query": [], "raw": "{{baseUrl}}\/connector\/api\/attendance\/violations\/:id\/justify", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The violation id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"justification\":\"traffic accident on the ring road\"}" }, "description": "The employee's own explanation for one of their violations that is still open." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true, \"msg\": \"Your explanation was sent.\", \"status\": \"justified\"}", "name": "" } ] }, { "name": "Public holidays", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/holidays", "query": [], "raw": "{{baseUrl}}\/connector\/api\/holidays" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The business's public holidays as HRM has them (no lateness or absence on those days;\nwork on them is overtime), for the app's calendar." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"date\": \"2026-03-20\"}, {\"date\": \"2026-03-21\"}, {\"date\": \"2026-09-23\"}]}", "name": "" } ] } ] }, { "name": "Authentication", "description": "", "item": [ { "name": "Log out", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/logout", "query": [], "raw": "{{baseUrl}}\/connector\/api\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revokes the access token used for this request and its refresh token.\nOther devices of the same user stay logged in." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true}", "name": "" } ] } ] }, { "name": "Brand management", "description": "", "item": [ { "name": "List brands", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/brand", "query": [], "raw": "{{baseUrl}}\/connector\/api\/brand" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"Levis\",\n\"description\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:19:47\",\n\"updated_at\": \"2018-01-03 21:19:47\"\n},\n{\n\"id\": 2,\n\"business_id\": 1,\n\"name\": \"Espirit\",\n\"description\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:19:58\",\n\"updated_at\": \"2018-01-03 21:19:58\"\n}\n]\n}", "name": "" } ] }, { "name": "Get the specified brand", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/brand\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/brand\/:id", "variable": [ { "id": "id", "key": "id", "value": "eius", "description": "The ID of the brand." }, { "id": "brand", "key": "brand", "value": "1", "description": "comma separated ids of the brands" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"Levis\",\n\"description\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:19:47\",\n\"updated_at\": \"2018-01-03 21:19:47\"\n}\n]\n}", "name": "" } ] } ] }, { "name": "Business Location management", "description": "", "item": [ { "name": "List business locations", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/business-location", "query": [], "raw": "{{baseUrl}}\/connector\/api\/business-location" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": null,\n\"name\": \"Awesome Shop\",\n\"landmark\": \"Linking Street\",\n\"country\": \"USA\",\n\"state\": \"Arizona\",\n\"city\": \"Phoenix\",\n\"zip_code\": \"85001\",\n\"invoice_scheme_id\": 1,\n\"invoice_layout_id\": 1,\n\"selling_price_group_id\": null,\n\"print_receipt_on_invoice\": 1,\n\"receipt_printer_type\": \"browser\",\n\"printer_id\": null,\n\"mobile\": null,\n\"alternate_number\": null,\n\"email\": null,\n\"website\": null,\n\"featured_products\": [\n\"5\",\n\"71\"\n],\n\"is_active\": 1,\n\"payment_methods\": [\n{\n\"name\": \"cash\",\n\"label\": \"Cash\",\n\"account_id\": \"1\"\n},\n{\n\"name\": \"card\",\n\"label\": \"Card\",\n\"account_id\": null\n},\n{\n\"name\": \"cheque\",\n\"label\": \"Cheque\",\n\"account_id\": null\n},\n{\n\"name\": \"bank_transfer\",\n\"label\": \"Bank Transfer\",\n\"account_id\": null\n},\n{\n\"name\": \"other\",\n\"label\": \"Other\",\n\"account_id\": null\n},\n{\n\"name\": \"custom_pay_1\",\n\"label\": \"Custom Payment 1\",\n\"account_id\": null\n},\n{\n\"name\": \"custom_pay_2\",\n\"label\": \"Custom Payment 2\",\n\"account_id\": null\n},\n{\n\"name\": \"custom_pay_3\",\n\"label\": \"Custom Payment 3\",\n\"account_id\": null\n}\n],\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:20\",\n\"updated_at\": \"2020-06-05 00:56:54\"\n}\n]\n}", "name": "" } ] }, { "name": "Get the specified business location", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/business-location\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/business-location\/:id", "variable": [ { "id": "id", "key": "id", "value": "sed", "description": "The ID of the business location." }, { "id": "location", "key": "location", "value": "1", "description": "comma separated ids of the business location" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": null,\n\"name\": \"Awesome Shop\",\n\"landmark\": \"Linking Street\",\n\"country\": \"USA\",\n\"state\": \"Arizona\",\n\"city\": \"Phoenix\",\n\"zip_code\": \"85001\",\n\"invoice_scheme_id\": 1,\n\"invoice_layout_id\": 1,\n\"selling_price_group_id\": null,\n\"print_receipt_on_invoice\": 1,\n\"receipt_printer_type\": \"browser\",\n\"printer_id\": null,\n\"mobile\": null,\n\"alternate_number\": null,\n\"email\": null,\n\"website\": null,\n\"featured_products\": [\n\"5\",\n\"71\"\n],\n\"is_active\": 1,\n\"payment_methods\": [\n{\n\"name\": \"cash\",\n\"label\": \"Cash\",\n\"account_id\": \"1\"\n},\n{\n\"name\": \"card\",\n\"label\": \"Card\",\n\"account_id\": null\n},\n{\n\"name\": \"cheque\",\n\"label\": \"Cheque\",\n\"account_id\": null\n},\n{\n\"name\": \"bank_transfer\",\n\"label\": \"Bank Transfer\",\n\"account_id\": null\n},\n{\n\"name\": \"other\",\n\"label\": \"Other\",\n\"account_id\": null\n},\n{\n\"name\": \"custom_pay_1\",\n\"label\": \"Custom Payment 1\",\n\"account_id\": null\n},\n{\n\"name\": \"custom_pay_2\",\n\"label\": \"Custom Payment 2\",\n\"account_id\": null\n},\n{\n\"name\": \"custom_pay_3\",\n\"label\": \"Custom Payment 3\",\n\"account_id\": null\n}\n],\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:20\",\n\"updated_at\": \"2020-06-05 00:56:54\"\n}\n]\n}", "name": "" } ] } ] }, { "name": "CRM", "description": "", "item": [ { "name": "List Follow ups", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/follow-ups", "query": [ { "key": "start_date", "value": "2020-12-16", "description": "format: Y-m-d (Ex: 2020-12-16)", "disabled": false }, { "key": "end_date", "value": "2020-12-16", "description": "format: Y-m-d (Ex: 2020-12-16)", "disabled": false }, { "key": "status", "value": "fuga", "description": "filter the result through status, get status from getFollowUpResources->statuses", "disabled": false }, { "key": "follow_up_type", "value": "atque", "description": "filter the result through follow_up_type, get follow_up_type from getFollowUpResources->follow_up_types", "disabled": false }, { "key": "followup_category_id", "value": "doloremque", "description": "filter the result through followup_category_id", "disabled": false }, { "key": "order_by", "value": "start_datetime", "description": "Column name to sort the result, Column: start_datetime", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction to sort the result, Required if using 'order_by', direction: desc, asc", "disabled": false }, { "key": "per_page", "value": "15", "description": "Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/crm\/follow-ups?start_date=2020-12-16&end_date=2020-12-16&status=fuga&follow_up_type=atque&followup_category_id=doloremque&order_by=start_datetime&direction=desc&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"contact_id\": 50,\n\"title\": \"Test Follow up\",\n\"status\": \"scheduled\",\n\"start_datetime\": \"2020-12-16 15:15:00\",\n\"end_datetime\": \"2020-12-16 15:15:00\",\n\"description\": \"

tst<\/p>\",\n\"schedule_type\": \"call\",\n\"allow_notification\": 0,\n\"notify_via\": {\n\"sms\": 0,\n\"mail\": 1\n},\n\"notify_before\": null,\n\"notify_type\": \"minute\",\n\"created_by\": 1,\n\"followup_additional_info\": null,\n\"created_at\": \"2020-12-16 03:15:23\",\n\"updated_at\": \"2020-12-16 15:46:34\",\n\"customer\": {\n\"id\": 50,\n\"business_id\": 1,\n\"type\": \"lead\",\n\"supplier_business_name\": null,\n\"name\": \" Lead 4 \",\n\"prefix\": null,\n\"first_name\": \"Lead 4\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": null,\n\"contact_id\": \"CO0011\",\n\"contact_status\": \"active\",\n\"tax_number\": null,\n\"city\": null,\n\"state\": null,\n\"country\": null,\n\"address_line_1\": null,\n\"address_line_2\": null,\n\"zip_code\": null,\n\"dob\": null,\n\"mobile\": \"234567\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"credit_limit\": null,\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 0,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": \"55\",\n\"crm_life_stage\": \"62\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"deleted_at\": null,\n\"created_at\": \"2020-12-15 23:14:48\",\n\"updated_at\": \"2021-01-07 15:32:52\",\n\"remember_token\": null,\n\"password\": null\n}\n},\n{\n\"id\": 2,\n\"business_id\": 1,\n\"contact_id\": 50,\n\"title\": \"Test Follow up 1\",\n\"status\": \"completed\",\n\"start_datetime\": \"2020-12-16 15:46:00\",\n\"end_datetime\": \"2020-12-16 15:46:00\",\n\"description\": \"

Test Follow up<\/p>\",\n\"schedule_type\": \"call\",\n\"allow_notification\": 0,\n\"notify_via\": {\n\"sms\": 0,\n\"mail\": 1\n},\n\"notify_before\": null,\n\"notify_type\": \"minute\",\n\"created_by\": 1,\n\"followup_additional_info\": null,\n\"created_at\": \"2020-12-16 15:46:57\",\n\"updated_at\": \"2020-12-17 10:24:11\",\n\"customer\": {\n\"id\": 50,\n\"business_id\": 1,\n\"type\": \"lead\",\n\"supplier_business_name\": null,\n\"name\": \" Lead 4 \",\n\"prefix\": null,\n\"first_name\": \"Lead 4\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": null,\n\"contact_id\": \"CO0011\",\n\"contact_status\": \"active\",\n\"tax_number\": null,\n\"city\": null,\n\"state\": null,\n\"country\": null,\n\"address_line_1\": null,\n\"address_line_2\": null,\n\"zip_code\": null,\n\"dob\": null,\n\"mobile\": \"234567\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"credit_limit\": null,\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 0,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": \"55\",\n\"crm_life_stage\": \"62\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"deleted_at\": null,\n\"created_at\": \"2020-12-15 23:14:48\",\n\"updated_at\": \"2021-01-07 15:32:52\",\n\"remember_token\": null,\n\"password\": null\n}\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/crm\/follow-ups?page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/crm\/follow-ups?page=21\",\n\"prev\": null,\n\"next\": \"https:\/\/bqf.ai\/connector\/api\/crm\/follow-ups?page=2\"\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"last_page\": 21,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/crm\/follow-ups\",\n\"per_page\": \"2\",\n\"to\": 2,\n\"total\": 42\n}\n}", "name": "" } ] }, { "name": "Add follow up", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/follow-ups", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/follow-ups" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Meeting with client\",\"contact_id\":2,\"description\":\"Non ullam excepturi repudiandae.\",\"schedule_type\":\"quo\",\"user_id\":[2,3,5],\"notify_before\":5,\"notify_type\":\"minute\",\"status\":\"open\",\"notify_via\":[\"et\"],\"start_datetime\":\"2021-01-06 13:05:00\",\"end_datetime\":\"2021-01-06 13:05:00\",\"followup_additional_info\":[\"quaerat\"],\"allow_notification\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"title\": \"test\",\n\"contact_id\": \"1\",\n\"description\": null,\n\"schedule_type\": \"call\",\n\"followup_category_id\": \"1\",\n\"notify_before\": null,\n\"status\": null,\n\"start_datetime\": \"2021-01-06 15:27:00\",\n\"end_datetime\": \"2021-01-06 15:27:00\",\n\"allow_notification\": 0,\n\"notify_via\": {\n\"sms\": 1,\n\"mail\": 1\n},\n\"notify_type\": \"hour\",\n\"business_id\": 1,\n\"created_by\": 1,\n\"updated_at\": \"2021-01-06 17:04:54\",\n\"created_at\": \"2021-01-06 17:04:54\",\n\"id\": 20\n}\n}", "name": "" } ] }, { "name": "Get the specified followup", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/follow-ups\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/follow-ups\/:id", "variable": [ { "id": "id", "key": "id", "value": "rerum", "description": "The ID of the follow up." }, { "id": "follow_up", "key": "follow_up", "value": "1%2C2", "description": "comma separated ids of the follow_ups" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 20,\n\"business_id\": 1,\n\"contact_id\": 1,\n\"title\": \"Meeting with client\",\n\"status\": null,\n\"start_datetime\": \"2021-01-06 15:27:00\",\n\"end_datetime\": \"2021-01-06 15:27:00\",\n\"description\": null,\n\"schedule_type\": \"call\",\n\"allow_notification\": 0,\n\"notify_via\": {\n\"sms\": 1,\n\"mail\": 1\n},\n\"notify_before\": null,\n\"notify_type\": \"hour\",\n\"created_by\": 1,\n\"created_at\": \"2021-01-06 17:04:54\",\n\"updated_at\": \"2021-01-06 17:04:54\",\n\"customer\": {\n\"id\": 1,\n\"business_id\": 1,\n\"type\": \"customer\",\n\"supplier_business_name\": null,\n\"name\": \"Walk-In Customer\",\n\"prefix\": null,\n\"first_name\": \"Walk-In Customer\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": null,\n\"contact_id\": \"CO0005\",\n\"contact_status\": \"active\",\n\"tax_number\": null,\n\"city\": \"Phoenix\",\n\"state\": \"Arizona\",\n\"country\": \"USA\",\n\"address_line_1\": \"Linking Street\",\n\"address_line_2\": null,\n\"zip_code\": null,\n\"dob\": null,\n\"mobile\": \"(378) 400-1234\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"credit_limit\": null,\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 1,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 20:45:20\",\n\"updated_at\": \"2018-06-11 22:22:05\",\n\"remember_token\": null,\n\"password\": null\n},\n\"users\": [\n{\n\"id\": 2,\n\"user_type\": \"user\",\n\"surname\": \"Mr\",\n\"first_name\": \"Demo\",\n\"last_name\": \"Cashier\",\n\"username\": \"cashier\",\n\"email\": \"cashier@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:20:58\",\n\"updated_at\": \"2018-01-04 02:20:58\",\n\"pivot\": {\n\"schedule_id\": 20,\n\"user_id\": 2\n}\n}\n]\n}\n]\n}", "name": "" } ] }, { "name": "Update follow up", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/follow-ups\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/follow-ups\/:id", "variable": [ { "id": "id", "key": "id", "value": "quos", "description": "The ID of the follow up." }, { "id": "follow_up", "key": "follow_up", "value": "20", "description": "id of the follow up to be updated" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Meeting with client\",\"contact_id\":2,\"description\":\"Facere id esse est modi quis.\",\"schedule_type\":\"aperiam\",\"user_id\":[2,3,5],\"notify_before\":5,\"notify_type\":\"minute\",\"status\":\"open\",\"notify_via\":[\"non\"],\"followup_additional_info\":[\"deleniti\"],\"start_datetime\":\"2021-01-06 13:05:00\",\"end_datetime\":\"2021-01-06 13:05:00\",\"allow_notification\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"id\": 20,\n\"business_id\": 1,\n\"contact_id\": \"1\",\n\"title\": \"Meeting with client\",\n\"status\": null,\n\"start_datetime\": \"2021-01-06 15:27:00\",\n\"end_datetime\": \"2021-01-06 15:27:00\",\n\"description\": null,\n\"schedule_type\": \"call\",\n\"allow_notification\": 0,\n\"notify_via\": {\n\"sms\": 1,\n\"mail\": 0\n},\n\"notify_before\": null,\n\"notify_type\": \"hour\",\n\"created_by\": 1,\n\"created_at\": \"2021-01-06 17:04:54\",\n\"updated_at\": \"2021-01-06 18:22:21\"\n}\n}", "name": "" } ] }, { "name": "Get follow up resources", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/follow-up-resources", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/follow-up-resources" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"statuses\": {\n\"scheduled\": \"Scheduled\",\n\"open\": \"Open\",\n\"canceled\": \"Cancelled\",\n\"completed\": \"Completed\"\n},\n\"follow_up_types\": {\n\"call\": \"Call\",\n\"sms\": \"Sms\",\n\"meeting\": \"Meeting\",\n\"email\": \"Email\"\n},\n\"notify_type\": {\n\"minute\": \"Minute\",\n\"hour\": \"Hour\",\n\"day\": \"Day\"\n},\n\"notify_via\": {\n\"sms\": \"Sms\",\n\"mail\": \"Email\"\n}\n}\n}", "name": "" } ] }, { "name": "List lead", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/leads", "query": [ { "key": "assigned_to", "value": "1%2C2%2C3", "description": "comma separated ids of users to whom lead is assigned (Ex: 1,2,3)", "disabled": false }, { "key": "name", "value": "et", "description": "Search term for lead name", "disabled": false }, { "key": "biz_name", "value": "autem", "description": "Search term for lead's business name", "disabled": false }, { "key": "mobile_num", "value": "8", "description": "Search term for lead's mobile number", "disabled": false }, { "key": "contact_id", "value": "dolor", "description": "Search term for lead's contact_id. Ex(CO0005)", "disabled": false }, { "key": "order_by", "value": "aut", "description": "Column name to sort the result, Column: name, supplier_business_name", "disabled": false }, { "key": "direction", "value": "desc", "description": "Direction to sort the result, Required if using 'order_by', direction: desc, asc", "disabled": false }, { "key": "per_page", "value": "15", "description": "Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/crm\/leads?assigned_to=1%2C2%2C3&name=et&biz_name=autem&mobile_num=8&contact_id=dolor&order_by=aut&direction=desc&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"contact_id\": \"CO0010\",\n\"name\": \"mr Lead 3 kr kr 2\",\n\"supplier_business_name\": \"POS\",\n\"email\": null,\n\"mobile\": \"9437638555\",\n\"tax_number\": null,\n\"created_at\": \"2020-12-15 23:14:30\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"alternate_number\": null,\n\"landline\": null,\n\"dob\": null,\n\"contact_status\": \"active\",\n\"type\": \"lead\",\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"id\": 49,\n\"business_id\": 1,\n\"crm_source\": \"55\",\n\"crm_life_stage\": \"60\",\n\"address_line_1\": null,\n\"address_line_2\": null,\n\"city\": null,\n\"state\": null,\n\"country\": null,\n\"zip_code\": null,\n\"last_follow_up_id\": 18,\n\"upcoming_follow_up_id\": null,\n\"last_follow_up\": \"2021-01-07 10:26:00\",\n\"upcoming_follow_up\": null,\n\"last_follow_up_additional_info\": \"{\\\"test\\\":\\\"test done\\\",\\\"call_duration\\\":\\\"1.5 Hour\\\",\\\"rand\\\":1}\",\n\"upcoming_follow_up_additional_info\": null,\n\"source\": {\n\"id\": 55,\n\"name\": \"Facebook\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"source\",\n\"description\": \"Facebook\",\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2020-12-15 23:07:53\",\n\"updated_at\": \"2020-12-15 23:07:53\"\n},\n\"life_stage\": {\n\"id\": 60,\n\"name\": \"Open Deal\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"life_stage\",\n\"description\": \"Open Deal\",\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2020-12-15 23:11:05\",\n\"updated_at\": \"2020-12-15 23:11:05\"\n},\n\"lead_users\": [\n{\n\"id\": 10,\n\"user_type\": \"user\",\n\"surname\": \"Mr.\",\n\"first_name\": \"WooCommerce\",\n\"last_name\": \"User\",\n\"username\": \"woocommerce_user\",\n\"email\": \"woo@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-08-02 04:05:55\",\n\"updated_at\": \"2018-08-02 04:05:55\",\n\"pivot\": {\n\"contact_id\": 49,\n\"user_id\": 10\n}\n}\n]\n},\n{\n\"contact_id\": \"CO0011\",\n\"name\": \" Lead 4 \",\n\"supplier_business_name\": null,\n\"email\": null,\n\"mobile\": \"234567\",\n\"tax_number\": null,\n\"created_at\": \"2020-12-15 23:14:48\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"alternate_number\": null,\n\"landline\": null,\n\"dob\": null,\n\"contact_status\": \"active\",\n\"type\": \"lead\",\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"id\": 50,\n\"business_id\": 1,\n\"crm_source\": \"55\",\n\"crm_life_stage\": \"62\",\n\"address_line_1\": null,\n\"address_line_2\": null,\n\"city\": null,\n\"state\": null,\n\"country\": null,\n\"zip_code\": null,\n\"last_follow_up_id\": 32,\n\"upcoming_follow_up_id\": null,\n\"last_follow_up\": \"2021-01-08 16:06:00\",\n\"upcoming_follow_up\": null,\n\"last_follow_up_additional_info\": \"{\\\"call_durartion\\\":\\\"5 hour\\\"}\",\n\"upcoming_follow_up_additional_info\": null,\n\"source\": {\n\"id\": 55,\n\"name\": \"Facebook\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"source\",\n\"description\": \"Facebook\",\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2020-12-15 23:07:53\",\n\"updated_at\": \"2020-12-15 23:07:53\"\n},\n\"life_stage\": {\n\"id\": 62,\n\"name\": \"New\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"life_stage\",\n\"description\": \"New\",\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2020-12-15 23:11:26\",\n\"updated_at\": \"2020-12-15 23:11:26\"\n},\n\"lead_users\": [\n{\n\"id\": 11,\n\"user_type\": \"user\",\n\"surname\": \"Mr\",\n\"first_name\": \"Admin Essential\",\n\"last_name\": null,\n\"username\": \"admin-essentials\",\n\"email\": \"admin_essentials@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:19\",\n\"updated_at\": \"2018-01-04 02:15:19\",\n\"pivot\": {\n\"contact_id\": 50,\n\"user_id\": 11\n}\n}\n]\n},\n{\n\"contact_id\": \"CO0015\",\n\"name\": \" Lead kr \",\n\"supplier_business_name\": null,\n\"email\": null,\n\"mobile\": \"9437638555\",\n\"tax_number\": null,\n\"created_at\": \"2021-01-07 18:31:08\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"alternate_number\": null,\n\"landline\": null,\n\"dob\": \"2021-01-07\",\n\"contact_status\": \"active\",\n\"type\": \"lead\",\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"id\": 82,\n\"business_id\": 1,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"address_line_1\": null,\n\"address_line_2\": null,\n\"city\": null,\n\"state\": null,\n\"country\": null,\n\"zip_code\": null,\n\"last_follow_up_id\": 36,\n\"upcoming_follow_up_id\": null,\n\"last_follow_up\": \"2021-01-07 18:31:08\",\n\"upcoming_follow_up\": null,\n\"last_follow_up_additional_info\": \"{\\\"call duration\\\":\\\"1 hour\\\",\\\"call descr\\\":\\\"talked to him and all okay\\\"}\",\n\"upcoming_follow_up_additional_info\": null,\n\"source\": null,\n\"life_stage\": null,\n\"lead_users\": [\n{\n\"id\": 11,\n\"user_type\": \"user\",\n\"surname\": \"Mr\",\n\"first_name\": \"Admin Essential\",\n\"last_name\": null,\n\"username\": \"admin-essentials\",\n\"email\": \"admin_essentials@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:19\",\n\"updated_at\": \"2018-01-04 02:15:19\",\n\"pivot\": {\n\"contact_id\": 82,\n\"user_id\": 11\n}\n}\n]\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/crm\/leads?page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/crm\/leads?page=1\",\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"last_page\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/crm\/leads\",\n\"per_page\": \"10\",\n\"to\": 3,\n\"total\": 3\n}\n}", "name": "" } ] }, { "name": "Save Call Logs", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/call-logs", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/call-logs" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Entries that cannot be read (no number, no or unreadable times) are skipped\nand counted in `skipped`; the rest are saved. An entry already saved (same\ntype, number and start time in this business) is not saved twice." }, "response": [] } ] }, { "name": "Cash register management", "description": "", "item": [ { "name": "List Cash Registers", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/cash-register", "query": [ { "key": "status", "value": "open", "description": "status of the register (open, close)", "disabled": false }, { "key": "user_id", "value": "10", "description": "id of the user", "disabled": false }, { "key": "start_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "end_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "location_id", "value": "1", "description": "id of the location", "disabled": false }, { "key": "per_page", "value": "15", "description": "Total records per page (up to 500). default: 10, Set -1 for all (up to 1000)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/cash-register?status=open&user_id=10&start_date=2018-06-25&end_date=2018-06-25&location_id=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": 1,\n\"user_id\": 9,\n\"status\": \"open\",\n\"closed_at\": null,\n\"closing_amount\": \"0.0000\",\n\"total_card_slips\": 0,\n\"total_cheques\": 0,\n\"closing_note\": null,\n\"created_at\": \"2020-07-02 12:03:00\",\n\"updated_at\": \"2020-07-02 12:03:19\",\n\"cash_register_transactions\": [\n{\n\"id\": 1,\n\"cash_register_id\": 1,\n\"amount\": \"0.0000\",\n\"pay_method\": \"cash\",\n\"type\": \"credit\",\n\"transaction_type\": \"initial\",\n\"transaction_id\": null,\n\"created_at\": \"2018-07-13 07:39:34\",\n\"updated_at\": \"2018-07-13 07:39:34\"\n},\n{\n\"id\": 2,\n\"cash_register_id\": 1,\n\"amount\": \"42.5000\",\n\"pay_method\": \"cash\",\n\"type\": \"credit\",\n\"transaction_type\": \"sell\",\n\"transaction_id\": 41,\n\"created_at\": \"2018-07-13 07:44:40\",\n\"updated_at\": \"2018-07-13 07:44:40\"\n}\n]\n},\n{\n\"id\": 2,\n\"business_id\": 1,\n\"location_id\": 1,\n\"user_id\": 1,\n\"status\": \"\",\n\"closed_at\": \"2020-07-02 12:03:00\",\n\"closing_amount\": \"0.0000\",\n\"total_card_slips\": 0,\n\"total_cheques\": 0,\n\"closing_note\": null,\n\"created_at\": \"2020-07-06 15:38:23\",\n\"updated_at\": \"2020-07-06 15:38:23\",\n\"cash_register_transactions\": [\n{\n\"id\": 19,\n\"cash_register_id\": 2,\n\"amount\": \"10.0000\",\n\"pay_method\": \"cash\",\n\"type\": \"credit\",\n\"transaction_type\": \"initial\",\n\"transaction_id\": null,\n\"created_at\": \"2020-07-06 15:38:23\",\n\"updated_at\": \"2020-07-06 15:38:23\"\n}\n]\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/cash-register?page=1\",\n\"last\": null,\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/cash-register\",\n\"per_page\": 10,\n\"to\": 2\n}\n}", "name": "" } ] }, { "name": "Create Cash Register", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/cash-register", "query": [], "raw": "{{baseUrl}}\/connector\/api\/cash-register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"location_id\":1,\"status\":\"close\",\"initial_amount\":61887607.11,\"created_at\":\"2020-5-7 15:20:22\",\"closed_at\":\"2020-5-7 15:20:22\",\"closing_amount\":21.618234719,\"total_card_slips\":12,\"total_cheques\":7,\"closing_note\":\"ea\",\"transaction_ids\":\"1,2,3\\n\\nOpening while the user already has an open register answers 200 with that\\nregister when it is at the requested branch, and 409 (error.code\\nregister_open_elsewhere, the open register in data) when it is elsewhere.\\n\\nresponse {\\n\\\"data\\\": {\\n\\\"status\\\": \\\"closed\\\",\\n\\\"location_id\\\": \\\"1\\\",\\n\\\"closed_at\\\": \\\"2020-07-02 12:03:00\\\",\\n\\\"business_id\\\": 1,\\n\\\"user_id\\\": 1,\\n\\\"updated_at\\\": \\\"2020-07-06 16:28:42\\\",\\n\\\"created_at\\\": \\\"2020-07-06 16:28:42\\\",\\n\\\"id\\\": 3\\n}\\n}\"}" }, "description": "" }, "response": [] }, { "name": "Get the specified Register", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/cash-register\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/cash-register\/:id", "variable": [ { "id": "id", "key": "id", "value": "aliquam", "description": "The ID of the cash register." }, { "id": "cash_register", "key": "cash_register", "value": "59", "description": "comma separated ids of the cash registers" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": 1,\n\"user_id\": 9,\n\"status\": \"open\",\n\"closed_at\": null,\n\"closing_amount\": \"0.0000\",\n\"total_card_slips\": 0,\n\"total_cheques\": 0,\n\"closing_note\": null,\n\"created_at\": \"2020-07-02 12:03:00\",\n\"updated_at\": \"2020-07-02 12:03:19\",\n\"cash_register_transactions\": [\n{\n\"id\": 1,\n\"cash_register_id\": 1,\n\"amount\": \"0.0000\",\n\"pay_method\": \"cash\",\n\"type\": \"credit\",\n\"transaction_type\": \"initial\",\n\"transaction_id\": null,\n\"created_at\": \"2018-07-13 07:39:34\",\n\"updated_at\": \"2018-07-13 07:39:34\"\n},\n{\n\"id\": 2,\n\"cash_register_id\": 1,\n\"amount\": \"42.5000\",\n\"pay_method\": \"cash\",\n\"type\": \"credit\",\n\"transaction_type\": \"sell\",\n\"transaction_id\": 41,\n\"created_at\": \"2018-07-13 07:44:40\",\n\"updated_at\": \"2018-07-13 07:44:40\"\n}\n]\n}\n]\n}", "name": "" } ] }, { "name": "Close a cash register", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/cash-register\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/cash-register\/:id", "variable": [ { "id": "id", "key": "id", "value": "eos", "description": "The ID of the cash register." }, { "id": "cash_register", "key": "cash_register", "value": "7", "description": "id of the open register" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"close\",\"closing_amount\":51713676.2769821,\"total_card_slips\":14,\"total_cheques\":2,\"closing_note\":\"dignissimos\",\"denominations\":[]}" }, "description": "Closes an open register as the web \"close register\" does: the counted\namounts are recorded, the cash over\/short is posted to the ledger and the\nclosing reports are sent. Your own register, or \u2014 with the same\npermission \u2014 another user's register at a branch you may act on." }, "response": [] } ] }, { "name": "Contact management", "description": "", "item": [ { "name": "List contact", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/contactapi", "query": [ { "key": "type", "value": "inventore", "description": "Type of contact (supplier, customer)", "disabled": false }, { "key": "name", "value": "placeat", "description": "Search term for contact name", "disabled": false }, { "key": "biz_name", "value": "et", "description": "Search term for contact's business name", "disabled": false }, { "key": "mobile_num", "value": "7", "description": "Search term for contact's mobile number", "disabled": false }, { "key": "contact_id", "value": "aspernatur", "description": "Search term for contact's contact_id. Ex(CO0005)", "disabled": false }, { "key": "order_by", "value": "aut", "description": "Column name to sort the result, Column: name, supplier_business_name", "disabled": false }, { "key": "direction", "value": "laboriosam", "description": "Direction to sort the result, Direction: desc, asc", "disabled": false }, { "key": "per_page", "value": "15", "description": "Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/contactapi?type=inventore&name=placeat&biz_name=et&mobile_num=7&contact_id=aspernatur&order_by=aut&direction=laboriosam&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 2,\n\"business_id\": 1,\n\"type\": \"supplier\",\n\"supplier_business_name\": \"Alpha Clothings\",\n\"name\": \"Michael\",\n\"prefix\": null,\n\"first_name\": \"Michael\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": null,\n\"contact_id\": \"CO0001\",\n\"contact_status\": \"active\",\n\"tax_number\": \"4590091535\",\n\"city\": \"Phoenix\",\n\"state\": \"Arizona\",\n\"country\": \"USA\",\n\"address_line_1\": \"Linking Street\",\n\"address_line_2\": null,\n\"zip_code\": null,\n\"dob\": null,\n\"mobile\": \"(378) 400-1234\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": 15,\n\"pay_term_type\": \"days\",\n\"credit_limit\": null,\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 0,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 20:59:38\",\n\"updated_at\": \"2018-06-11 22:21:03\",\n\"remember_token\": null,\n\"password\": null\n},\n{\n\"id\": 3,\n\"business_id\": 1,\n\"type\": \"supplier\",\n\"supplier_business_name\": \"Manhattan Clothing Ltd.\",\n\"name\": \"Philip\",\n\"prefix\": null,\n\"first_name\": \"Philip\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": null,\n\"contact_id\": \"CO0003\",\n\"contact_status\": \"active\",\n\"tax_number\": \"54869310093\",\n\"city\": \"Phoenix\",\n\"state\": \"Arizona\",\n\"country\": \"USA\",\n\"address_line_1\": \"Linking Street\",\n\"address_line_2\": null,\n\"zip_code\": null,\n\"dob\": null,\n\"mobile\": \"(378) 400-1234\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": 15,\n\"pay_term_type\": \"days\",\n\"credit_limit\": null,\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 0,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:00:55\",\n\"updated_at\": \"2018-06-11 22:21:36\",\n\"remember_token\": null,\n\"password\": null\n},\n{\n\"id\": 5,\n\"business_id\": 1,\n\"type\": \"supplier\",\n\"supplier_business_name\": \"Digital Ocean\",\n\"name\": \"Mike McCubbin\",\n\"prefix\": null,\n\"first_name\": \"Mike McCubbin\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": null,\n\"contact_id\": \"CN0004\",\n\"contact_status\": \"active\",\n\"tax_number\": \"52965489001\",\n\"city\": \"Phoenix\",\n\"state\": \"Arizona\",\n\"country\": \"USA\",\n\"address_line_1\": \"Linking Street\",\n\"address_line_2\": null,\n\"zip_code\": null,\n\"dob\": null,\n\"mobile\": \"(378) 400-1234\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": 30,\n\"pay_term_type\": \"days\",\n\"credit_limit\": null,\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 0,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-06 06:53:22\",\n\"updated_at\": \"2018-06-11 22:21:47\",\n\"remember_token\": null,\n\"password\": null\n},\n{\n\"id\": 6,\n\"business_id\": 1,\n\"type\": \"supplier\",\n\"supplier_business_name\": \"Univer Suppliers\",\n\"name\": \"Jackson Hill\",\n\"prefix\": null,\n\"first_name\": \"Jackson Hill\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": null,\n\"contact_id\": \"CO0002\",\n\"contact_status\": \"active\",\n\"tax_number\": \"5459000655\",\n\"city\": \"Phoenix\",\n\"state\": \"Arizona\",\n\"country\": \"USA\",\n\"address_line_1\": \"Linking Street\",\n\"address_line_2\": null,\n\"zip_code\": null,\n\"dob\": null,\n\"mobile\": \"(378) 400-1234\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": 45,\n\"pay_term_type\": \"days\",\n\"credit_limit\": null,\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 0,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-06 06:55:09\",\n\"updated_at\": \"2018-06-11 22:21:18\",\n\"remember_token\": null,\n\"password\": null\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/contactapi?page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/contactapi?page=1\",\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"last_page\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/contactapi\",\n\"per_page\": \"10\",\n\"to\": 4,\n\"total\": 4\n}\n}", "name": "" } ] }, { "name": "Create contact", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/contactapi", "query": [], "raw": "{{baseUrl}}\/connector\/api\/contactapi" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"customer\",\"supplier_business_name\":\"incidunt\",\"prefix\":\"nihil\",\"first_name\":\"sint\",\"middle_name\":\"ut\",\"last_name\":\"laboriosam\",\"tax_number\":\"8787fefef\",\"pay_term_number\":3,\"pay_term_type\":\"months\",\"mobile\":\"4578691009\",\"landline\":\"5487-8454-4145\",\"alternate_number\":\"841847541222\",\"address_line_1\":\"iste\",\"address_line_2\":\"est\",\"city\":\"fugit\",\"state\":\"laboriosam\",\"country\":\"porro\",\"zip_code\":\"sit\",\"customer_group_id\":\"inventore\",\"contact_id\":\"esse\",\"dob\":\"2000-06-13\",\"custom_field1\":\"commodi\",\"custom_field2\":\"quo\",\"custom_field3\":\"sit\",\"custom_field4\":\"nobis\",\"email\":\"hoyt.howe@example.com\",\"shipping_address\":\"non\",\"position\":\"excepturi\",\"opening_balance\":0,\"source_id\":13,\"life_stage_id\":17,\"assigned_to\":[\"eius\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"type\": \"customer\",\n\"name\": \"test customer\",\n\"tax_number\": \"75879BHF\",\n\"mobile\": \"7878825008\",\n\"business_id\": 1,\n\"created_by\": 9,\n\"credit_limit\": null,\n\"contact_id\": \"CO0007\",\n\"updated_at\": \"2020-06-04 21:59:21\",\n\"created_at\": \"2020-06-04 21:59:21\",\n\"id\": 17\n}\n}", "name": "" } ] }, { "name": "Get the specified contact", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/contactapi\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/contactapi\/:id", "variable": [ { "id": "id", "key": "id", "value": "inventore", "description": "The ID of the contactapi." }, { "id": "contact", "key": "contact", "value": "2", "description": "comma separated ids of contacts" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"type\": \"customer\",\n\"supplier_business_name\": null,\n\"name\": \" Walk-In Customer \",\n\"prefix\": null,\n\"first_name\": \"Walk-In Customer\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": \"walkin@test.com\",\n\"contact_id\": \"CO0005\",\n\"contact_status\": \"active\",\n\"tax_number\": null,\n\"city\": \"Phoenix\",\n\"state\": \"Arizona\",\n\"country\": \"USA\",\n\"address_line_1\": \"Linking Street\",\n\"address_line_2\": null,\n\"zip_code\": \"85001\",\n\"dob\": null,\n\"mobile\": \"(378) 400-1234\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"credit_limit\": \"0.0000\",\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 1,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 20:45:20\",\n\"updated_at\": \"2020-08-10 10:26:45\",\n\"remember_token\": null,\n\"password\": null,\n\"customer_group\": null,\n\"opening_balance\": \"0.0000\",\n\"opening_balance_paid\": \"0.0000\",\n\"total_purchase\": \"0.0000\",\n\"purchase_paid\": \"0.0000\",\n\"total_purchase_return\": \"0.0000\",\n\"purchase_return_paid\": \"0.0000\",\n\"total_invoice\": \"2050.0000\",\n\"invoice_received\": \"1987.5000\",\n\"total_sell_return\": \"0.0000\",\n\"sell_return_paid\": \"0.0000\",\n\"purchase_due\": 0,\n\"sell_due\": 62.5,\n\"purchase_return_due\": 0,\n\"sell_return_due\": 0\n}\n]\n}", "name": "" } ] }, { "name": "Update contact", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/contactapi\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/contactapi\/:id", "variable": [ { "id": "id", "key": "id", "value": "illo", "description": "The ID of the contactapi." }, { "id": "contact", "key": "contact", "value": "17", "description": "id of the contact to be updated" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"customer\",\"supplier_business_name\":\"aut\",\"prefix\":\"autem\",\"first_name\":\"voluptatem\",\"middle_name\":\"voluptas\",\"last_name\":\"rem\",\"tax_number\":\"488744dwd\",\"pay_term_number\":3,\"pay_term_type\":\"months\",\"mobile\":\"8795461009\",\"landline\":\"65484-848-848\",\"alternate_number\":\"9898795220\",\"address_line_1\":\"fugiat\",\"address_line_2\":\"nulla\",\"city\":\"esse\",\"state\":\"labore\",\"country\":\"fuga\",\"zip_code\":\"dolores\",\"customer_group_id\":\"odit\",\"contact_id\":\"iusto\",\"dob\":\"2000-06-13\",\"custom_field1\":\"nihil\",\"custom_field2\":\"error\",\"custom_field3\":\"asperiores\",\"custom_field4\":\"repellendus\",\"email\":\"lila.hettinger@example.net\",\"shipping_address\":\"et\",\"position\":\"soluta\",\"opening_balance\":2764.841,\"source_id\":14,\"life_stage_id\":1,\"assigned_to\":[\"nisi\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"id\": 21,\n\"business_id\": 1,\n\"type\": \"customer\",\n\"supplier_business_name\": null,\n\"name\": \"created from api\",\n\"prefix\": null,\n\"first_name\": \"created from api\",\n\"middle_name\": null,\n\"last_name\": null,\n\"email\": null,\n\"contact_id\": \"CO0009\",\n\"contact_status\": \"active\",\n\"tax_number\": null,\n\"city\": null,\n\"state\": null,\n\"country\": null,\n\"address_line_1\": \"test address\",\n\"address_line_2\": null,\n\"zip_code\": \"54878787\",\n\"dob\": \"2000-06-13\",\n\"mobile\": \"8754154872154\",\n\"landline\": null,\n\"alternate_number\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"credit_limit\": null,\n\"created_by\": 1,\n\"balance\": \"0.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"is_default\": 0,\n\"shipping_address\": null,\n\"position\": null,\n\"customer_group_id\": null,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2020-08-10 10:41:42\",\n\"updated_at\": \"2020-08-10 10:41:42\",\n\"remember_token\": null,\n\"password\": null\n}\n}", "name": "" } ] }, { "name": "Contact payment", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/contactapi-payment", "query": [], "raw": "{{baseUrl}}\/connector\/api\/contactapi-payment" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":17,\"amount\":453.13,\"method\":\"cash\",\"due_payment_type\":\"sell\",\"paid_on\":\"2020-07-22 15:48:29\",\"account_id\":8,\"chart_of_account_id\":17,\"card_number\":\"1234\",\"card_holder_name\":\"earum\",\"card_transaction_number\":\"nostrum\",\"card_type\":\"nisi\",\"card_month\":\"dignissimos\",\"card_year\":\"impedit\",\"transaction_no_1\":\"quis\",\"transaction_no_2\":\"excepturi\",\"transaction_no_3\":\"similique\",\"cheque_number\":\"blanditiis\",\"bank_account_number\":\"rerum\",\"note\":\"sint\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"amount\": \"20\",\n\"method\": \"cash\",\n\"paid_on\": \"2020-07-22 15:48:29\",\n\"created_by\": 1,\n\"payment_for\": \"19\",\n\"business_id\": 1,\n\"is_advance\": 1,\n\"payment_ref_no\": \"SP2020\/0127\",\n\"document\": null,\n\"updated_at\": \"2020-07-22 15:48:29\",\n\"created_at\": \"2020-07-22 15:48:29\",\n\"id\": 215\n}\n}", "name": "" } ] } ] }, { "name": "Expense management", "description": "", "item": [ { "name": "List expenses", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/expense", "query": [ { "key": "location_id", "value": "1", "description": "id of the location", "disabled": false }, { "key": "payment_status", "value": "paid", "description": "payment status", "disabled": false }, { "key": "start_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "end_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "expense_for", "value": "laborum", "description": "id of the user for which expense is created", "disabled": false }, { "key": "per_page", "value": "15", "description": "Total records per page (up to 500). default: 15, Set -1 for all (up to 1000)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/expense?location_id=1&payment_status=paid&start_date=2018-06-25&end_date=2018-06-25&expense_for=laborum&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 59,\n\"business_id\": 1,\n\"location_id\": 1,\n\"payment_status\": \"due\",\n\"ref_no\": \"EP2020\/0001\",\n\"transaction_date\": \"2020-07-03 12:58:00\",\n\"total_before_tax\": \"50.0000\",\n\"tax_id\": null,\n\"tax_amount\": \"0.0000\",\n\"final_total\": \"50.0000\",\n\"expense_category_id\": null,\n\"document\": null,\n\"created_by\": 9,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": null,\n\"recur_repetitions\": null,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"created_at\": \"2020-07-03 12:58:23\",\n\"updated_at\": \"2020-07-03 12:58:24\",\n\"transaction_for\": {\n\"id\": 1,\n\"user_type\": \"user\",\n\"surname\": \"Mr\",\n\"first_name\": \"Admin\",\n\"last_name\": null,\n\"username\": \"admin\",\n\"email\": \"admin@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:19\",\n\"updated_at\": \"2018-01-04 02:15:19\"\n}\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/expense?page=1\",\n\"last\": null,\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/expense\",\n\"per_page\": 10,\n\"to\": 1\n}\n}", "name": "" } ] }, { "name": "Create expense \/ expense refund", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/expense", "query": [], "raw": "{{baseUrl}}\/connector\/api\/expense" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"location_id\":1,\"final_total\":225922.479344,\"transaction_date\":\"2020-5-7 15:20:22\",\"tax_rate_id\":12,\"expense_for\":4,\"contact_id\":20,\"expense_category_id\":1,\"expense_sub_category_id\":2,\"additional_notes\":\"maxime\",\"is_refund\":0,\"is_recurring\":0,\"recur_interval\":14,\"recur_interval_type\":\"months\",\"subscription_repeat_on\":15,\"subscription_no\":\"unde\",\"recur_repetitions\":16,\"payment\":[\"est\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"id\": 75,\n\"business_id\": 1,\n\"location_id\": \"1\",\n\"payment_status\": \"due\",\n\"ref_no\": \"EP2020\/0013\",\n\"transaction_date\": \"2020-07-06T05:31:29.480975Z\",\n\"total_before_tax\": \"43\",\n\"tax_id\": null,\n\"tax_amount\": 0,\n\"final_total\": \"43\",\n\"expense_category_id\": null,\n\"document\": null,\n\"created_by\": 1,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": null,\n\"recur_repetitions\": null,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"created_at\": \"2020-07-06 11:01:29\",\n\"updated_at\": \"2020-07-06 11:01:29\",\n\"expense_for\": []\n}\n}", "name": "" } ] }, { "name": "Get the specified expense \/ expense refund", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/expense\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/expense\/:id", "variable": [ { "id": "id", "key": "id", "value": "illum", "description": "The ID of the expense." }, { "id": "expense", "key": "expense", "value": "59", "description": "comma separated ids of the expenses" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 59,\n\"business_id\": 1,\n\"location_id\": 1,\n\"payment_status\": \"due\",\n\"ref_no\": \"EP2020\/0001\",\n\"transaction_date\": \"2020-07-03 12:58:00\",\n\"total_before_tax\": \"50.0000\",\n\"tax_id\": null,\n\"tax_amount\": \"0.0000\",\n\"final_total\": \"50.0000\",\n\"expense_category_id\": null,\n\"document\": null,\n\"created_by\": 9,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": null,\n\"recur_repetitions\": null,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"created_at\": \"2020-07-03 12:58:23\",\n\"updated_at\": \"2020-07-03 12:58:24\",\n\"transaction_for\": {\n\"id\": 1,\n\"user_type\": \"user\",\n\"surname\": \"Mr\",\n\"first_name\": \"Admin\",\n\"last_name\": null,\n\"username\": \"admin\",\n\"email\": \"admin@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:19\",\n\"updated_at\": \"2018-01-04 02:15:19\"\n}\n}\n]\n}", "name": "" } ] }, { "name": "Update expense \/ expense refund", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/expense\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/expense\/:id", "variable": [ { "id": "id", "key": "id", "value": "velit", "description": "The ID of the expense." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"final_total\":39.71398,\"transaction_date\":\"2020-5-7 15:20:22\",\"tax_rate_id\":20,\"expense_for\":9,\"contact_id\":15,\"expense_category_id\":6,\"expense_sub_category_id\":4,\"additional_notes\":\"ea\",\"is_recurring\":0,\"recur_interval\":8,\"recur_interval_type\":\"months\",\"subscription_repeat_on\":15,\"subscription_no\":\"sit\",\"recur_repetitions\":18,\"payment\":[\"molestiae\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"id\": 75,\n\"business_id\": 1,\n\"location_id\": \"1\",\n\"payment_status\": \"due\",\n\"ref_no\": \"EP2020\/0013\",\n\"transaction_date\": \"2020-07-06T05:31:29.480975Z\",\n\"total_before_tax\": \"43\",\n\"tax_id\": null,\n\"tax_amount\": 0,\n\"final_total\": \"43\",\n\"expense_category_id\": null,\n\"document\": null,\n\"created_by\": 1,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": null,\n\"recur_repetitions\": null,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"created_at\": \"2020-07-06 11:01:29\",\n\"updated_at\": \"2020-07-06 11:01:29\",\n\"expense_for\": []\n}\n}", "name": "" } ] }, { "name": "List expense refunds", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/expense-refund", "query": [ { "key": "location_id", "value": "1", "description": "id of the location", "disabled": false }, { "key": "payment_status", "value": "paid", "description": "payment status", "disabled": false }, { "key": "start_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "end_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "expense_for", "value": "beatae", "description": "id of the user for which expense is created", "disabled": false }, { "key": "per_page", "value": "15", "description": "Total records per page (up to 500). default: 15, Set -1 for all (up to 1000)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/expense-refund?location_id=1&payment_status=paid&start_date=2018-06-25&end_date=2018-06-25&expense_for=beatae&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 230,\n\"business_id\": 1,\n\"location_id\": 1,\n\"payment_status\": \"partial\",\n\"ref_no\": \"refund\",\n\"transaction_date\": \"2020-12-15 11:16:00\",\n\"total_before_tax\": \"65.0000\",\n\"tax_id\": null,\n\"tax_amount\": \"0.0000\",\n\"final_total\": \"65.0000\",\n\"expense_category_id\": null,\n\"document\": null,\n\"created_by\": 9,\n\"created_at\": \"2020-12-15 11:46:56\",\n\"updated_at\": \"2020-12-15 12:47:30\",\n\"expense_for\": []\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/expense-refund?page=1\",\n\"last\": null,\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/expense-refund\",\n\"per_page\": 15,\n\"to\": 1\n}\n}", "name": "" } ] }, { "name": "List expense categories", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/expense-categories", "query": [], "raw": "{{baseUrl}}\/connector\/api\/expense-categories" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"cat 1\",\n\"business_id\": 1,\n\"code\": null,\n\"parent_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2021-12-16 17:54:40\",\n\"updated_at\": \"2021-12-16 17:54:40\",\n\"sub_categories\": [\n{\n\"id\": 3,\n\"name\": \"sub cat 1\",\n\"business_id\": 1,\n\"code\": null,\n\"parent_id\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2021-12-16 18:12:07\",\n\"updated_at\": \"2021-12-16 18:12:07\"\n}\n]\n},\n{\n\"id\": 7,\n\"name\": \"cat 2\",\n\"business_id\": 1,\n\"code\": null,\n\"parent_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2021-12-17 10:36:13\",\n\"updated_at\": \"2021-12-17 10:36:13\",\n\"sub_categories\": [\n{\n\"id\": 8,\n\"name\": \"sub cat 2\",\n\"business_id\": 1,\n\"code\": null,\n\"parent_id\": 7,\n\"deleted_at\": null,\n\"created_at\": \"2021-12-17 10:36:44\",\n\"updated_at\": \"2021-12-17 10:36:44\"\n}\n]\n}\n]\n}", "name": "" } ] } ] }, { "name": "Field Force", "description": "", "item": [ { "name": "List visits", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/field-force", "query": [ { "key": "contact_id", "value": "dicta", "description": "id of the contact", "disabled": false }, { "key": "assigned_to", "value": "non", "description": "id of the assigned user", "disabled": false }, { "key": "status", "value": "repellat", "description": "status of the visit (assigned, finished)", "disabled": false }, { "key": "start_date", "value": "2018-06-25", "description": "Start date filter for visit on format:Y-m-d", "disabled": false }, { "key": "end_date", "value": "2018-06-25", "description": "End date filter for visit on format:Y-m-d", "disabled": false }, { "key": "per_page", "value": "15", "description": "Total records per page. default: 10, Set -1 for no pagination", "disabled": false }, { "key": "order_by_date", "value": "", "description": "Sort visit by visit on date ('asc', 'desc')", "disabled": true } ], "raw": "{{baseUrl}}\/connector\/api\/field-force?contact_id=dicta&assigned_to=non&status=repellat&start_date=2018-06-25&end_date=2018-06-25&per_page=15&order_by_date=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Create Visit", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/field-force\/create", "query": [], "raw": "{{baseUrl}}\/connector\/api\/field-force\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":10,\"visit_to\":\"omnis\",\"visit_address\":\"est\",\"assigned_to\":1,\"visit_on\":\"2021-12-28 17:23:00\",\"visit_for\":\"aut\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"contact_id\": \"6\",\n\"assigned_to\": \"9\",\n\"visit_on\": \"2022-01-15 17:23:00\",\n\"visit_for\": \"\",\n\"meet_with\": \"\",\n\"meet_with2\": \"\",\n\"meet_with3\": \"\",\n\"meet_with_mobileno\": \"\",\n\"meet_with_mobileno2\": \"\",\n\"meet_with_mobileno3\": \"\",\n\"meet_with_designation\": \"\",\n\"meet_with_designation2\": \"\",\n\"meet_with_designation3\": \"\",\n\"visit_id\": \"2021\/0031\",\n\"status\": \"assigned\",\n\"business_id\": 1,\n\"updated_at\": \"2021-12-30 11:00:47\",\n\"created_at\": \"2021-12-30 11:00:47\",\n\"id\": 3\n}\n}", "name": "" } ] }, { "name": "Update Visit status", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/field-force\/update-visit-status\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/field-force\/update-visit-status\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "id of the visit to be updated" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "finished", "type": "text", "description": "Current status of the visit (assigned, finished, met_contact, did_not_meet_contact)" }, { "key": "reason_to_not_meet_contact", "value": "expedita", "type": "text", "description": "Reason if status is did_not_meet_contact" }, { "key": "visited_on", "value": "2021-12-28 17:23:00", "type": "text", "description": "H:i:s" }, { "key": "visited_address", "value": "Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India", "type": "text", "description": "Full address of the contact" }, { "key": "latitude", "value": "41.40338", "type": "text", "description": "Lattitude of the user location if full address is not given" }, { "key": "longitude", "value": "2.17403", "type": "text", "description": "Longitude of the user location if full address is not given" }, { "key": "comments", "value": "quas", "type": "text", "description": "Extra comments" }, { "key": "meet_with", "value": "maxime", "type": "text", "description": "name of person field force meet with" }, { "key": "meet_with_mobileno", "value": "tempore", "type": "text", "description": "mobile number of the person field force meet with" }, { "key": "photo", "src": [], "type": "file" } ] }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"id\": 10,\n\"business_id\": 1,\n\"contact_id\": 6,\n\"assigned_to\": 9,\n\"latitude\" : \"23.6101808\",\n\"longitude\" : \"85.2799354\",\n\"visited_address\": \"New address\",\n\"status\": \"finished\",\n\"visit_on\": \"2021-12-28 17:23:00\",\n\"visit_for\": \"assigned from api\",\n\"meet_with\": \"Name\",\n\"meet_with2\": \"Name\",\n\"meet_with3\": \"Name\",\n\"meet_with_mobileno\": \"123456789\",\n\"meet_with_mobileno2\": \"123456789\",\n\"meet_with_mobileno3\": \"123456789\",\n\"meet_with_designation\": \"dr\",\n\"meet_with_designation2\": \"dr\",\n\"meet_with_designation3\": \"dr\",\n\"comments\": \"Users comment\",\n\"created_at\": \"2021-12-28 17:35:13\",\n\"updated_at\": \"2021-12-28 18:06:03\"\n}\n}", "name": "" } ] } ] }, { "name": "New end points", "description": "", "item": [ { "name": "New List products", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/new_product", "query": [ { "key": "order_by", "value": "consequuntur", "description": "Values: product_name or newest", "disabled": false }, { "key": "order_direction", "value": "libero", "description": "Values: asc or desc", "disabled": false }, { "key": "location_custom_field_1", "value": "eos", "description": "Custom field 1 of the location", "disabled": false }, { "key": "category_id", "value": "amet", "description": "comma separated ids of one or multiple category", "disabled": false }, { "key": "sub_category_id", "value": "vero", "description": "comma separated ids of one or multiple sub-category", "disabled": false }, { "key": "location_id", "value": "1", "description": "", "disabled": false }, { "key": "not_for_sell", "value": "nihil", "description": "(1, 0)", "disabled": false }, { "key": "send_lot_detail", "value": "quas", "description": "Send lot details in each variation location details(1, 0)", "disabled": false }, { "key": "name", "value": "aut", "description": "Search term for product name", "disabled": false }, { "key": "sku", "value": "inventore", "description": "Search term for product sku", "disabled": false }, { "key": "product_ids", "value": "1%2C2", "description": "comma separated ids of products", "disabled": false }, { "key": "per_page", "value": "10", "description": "Total records per page. default: 10, Set -1 for no pagination", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/new_product?order_by=consequuntur&order_direction=libero&location_custom_field_1=eos&category_id=amet&sub_category_id=vero&location_id=1¬_for_sell=nihil&send_lot_detail=quas&name=aut&sku=inventore&product_ids=1%2C2&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 2,\n\"name\": \"Levis Men's Slimmy Fit Jeans\",\n\"business_id\": 1,\n\"type\": \"variable\",\n\"exemption_type_id\": null,\n\"enable_stock\": 1,\n\"sku\": \"AS0002\",\n\"product_custom_field1\": null,\n\"product_custom_field2\": null,\n\"product_custom_field3\": null,\n\"product_custom_field4\": null,\n\"woocommerce_media_id\": null,\n\"product_description\": null,\n\"is_inactive\": 0,\n\"repair_model_id\": null,\n\"not_for_selling\": 0,\n\"ecom_shipping_class_id\": null,\n\"ecom_active_in_store\": 1,\n\"woocommerce_product_id\": 627,\n\"woocommerce_disable_sync\": 0,\n\"image_url\": \"https:\/\/bqf.ai\/uploads\/img\/1528727964_levis_jeans.jpg\",\n\"product_variations\": [\n{\n\"id\": 2,\n\"variation_template_id\": 5,\n\"name\": \"Waist Size\",\n\"product_id\": 2,\n\"is_dummy\": 0,\n\"variations\": [\n{\n\"id\": 2,\n\"name\": \"28\",\n\"product_id\": 2,\n\"sub_sku\": \"AS0002-1\",\n\"product_variation_id\": 2,\n\"woocommerce_variation_id\": 658,\n\"default_purchase_price\": \"70.0000\",\n\"dpp_inc_tax\": \"77.0000\",\n\"default_sell_price\": \"70.0000\",\n\"sell_price_inc_tax\": \"77.0000\",\n\"combo_variations\": null,\n\"variation_location_details\": [\n{\n\"id\": 1,\n\"product_id\": 2,\n\"product_variation_id\": 2,\n\"variation_id\": 2,\n\"location_id\": 1,\n\"qty_available\": \"71.0000\"\n}\n],\n\"media\": [],\n\"discounts\": []\n},\n{\n\"id\": 3,\n\"name\": \"30\",\n\"product_id\": 2,\n\"sub_sku\": \"AS0002-2\",\n\"product_variation_id\": 2,\n\"woocommerce_variation_id\": 659,\n\"default_purchase_price\": \"70.0000\",\n\"dpp_inc_tax\": \"77.0000\",\n\"default_sell_price\": \"70.0000\",\n\"sell_price_inc_tax\": \"77.0000\",\n\"combo_variations\": null,\n\"variation_location_details\": [\n{\n\"id\": 2,\n\"product_id\": 2,\n\"product_variation_id\": 2,\n\"variation_id\": 3,\n\"location_id\": 1,\n\"qty_available\": \"89.0000\"\n}\n],\n\"media\": [],\n\"discounts\": []\n},\n{\n\"id\": 4,\n\"name\": \"32\",\n\"product_id\": 2,\n\"sub_sku\": \"AS0002-3\",\n\"product_variation_id\": 2,\n\"woocommerce_variation_id\": 660,\n\"default_purchase_price\": \"70.0000\",\n\"dpp_inc_tax\": \"77.0000\",\n\"default_sell_price\": \"70.0000\",\n\"sell_price_inc_tax\": \"77.0000\",\n\"combo_variations\": null,\n\"variation_location_details\": [\n{\n\"id\": 3,\n\"product_id\": 2,\n\"product_variation_id\": 2,\n\"variation_id\": 4,\n\"location_id\": 1,\n\"qty_available\": \"127.0000\"\n},\n{\n\"id\": 1371,\n\"product_id\": 2,\n\"product_variation_id\": 2,\n\"variation_id\": 4,\n\"location_id\": 7,\n\"qty_available\": \"-1.0000\"\n}\n],\n\"media\": [],\n\"discounts\": []\n},\n{\n\"id\": 5,\n\"name\": \"34\",\n\"product_id\": 2,\n\"sub_sku\": \"AS0002-4\",\n\"product_variation_id\": 2,\n\"woocommerce_variation_id\": 661,\n\"default_purchase_price\": \"72.0000\",\n\"dpp_inc_tax\": \"79.2000\",\n\"default_sell_price\": \"72.0000\",\n\"sell_price_inc_tax\": \"79.2000\",\n\"combo_variations\": null,\n\"variation_location_details\": [\n{\n\"id\": 4,\n\"product_id\": 2,\n\"product_variation_id\": 2,\n\"variation_id\": 5,\n\"location_id\": 1,\n\"qty_available\": \"128.0000\"\n}\n],\n\"media\": [],\n\"discounts\": []\n},\n{\n\"id\": 6,\n\"name\": \"36\",\n\"product_id\": 2,\n\"sub_sku\": \"AS0002-5\",\n\"product_variation_id\": 2,\n\"woocommerce_variation_id\": 662,\n\"default_purchase_price\": \"72.0000\",\n\"dpp_inc_tax\": \"79.2000\",\n\"default_sell_price\": \"72.0000\",\n\"sell_price_inc_tax\": \"79.2000\",\n\"combo_variations\": null,\n\"variation_location_details\": [\n{\n\"id\": 5,\n\"product_id\": 2,\n\"product_variation_id\": 2,\n\"variation_id\": 6,\n\"location_id\": 1,\n\"qty_available\": \"99.0000\"\n}\n],\n\"media\": [],\n\"discounts\": []\n}\n]\n}\n],\n\"brand\": {\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"Levis\",\n\"description\": null,\n\"created_by\": 1,\n\"use_for_repair\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:19:47\",\n\"updated_at\": \"2018-01-03 21:19:47\"\n},\n\"unit\": {\n\"id\": 1,\n\"business_id\": 1,\n\"actual_name\": \"Pieces\",\n\"short_name\": \"Pc(s)\",\n\"allow_decimal\": 0,\n\"base_unit_id\": null,\n\"base_unit_multiplier\": null\n},\n\"category\": {\n\"id\": 1,\n\"name\": \"Men's\",\n\"business_id\": 1,\n\"short_code\": \"sfefef\",\n\"parent_id\": 0,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null\n},\n\"sub_category\": {\n\"id\": 4,\n\"name\": \"Jeans\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null\n},\n\"product_tax\": {\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"VAT@10%\",\n\"amount\": 10,\n\"is_tax_group\": 0,\n\"for_tax_group\": 0,\n\"created_by\": 1,\n\"woocommerce_tax_rate_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:40:07\",\n\"updated_at\": \"2018-01-04 02:40:07\"\n},\n\"product_locations\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"Location 1\",\n\"custom_field1\": \"gdgdgd88\",\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null\n}\n]\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/new_product?per_page=1&page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/new_product?per_page=1&page=1088\",\n\"prev\": null,\n\"next\": \"https:\/\/bqf.ai\/connector\/api\/new_product?per_page=1&page=2\"\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"last_page\": 1088,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/new_product\",\n\"per_page\": \"1\",\n\"to\": 1,\n\"total\": 1088\n}\n}", "name": "" } ] }, { "name": "New List sells", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/new_sell", "query": [ { "key": "location_id", "value": "1", "description": "id of the location", "disabled": false }, { "key": "contact_id", "value": "dolorem", "description": "id of the customer", "disabled": false }, { "key": "payment_status", "value": "due%2Cpartial", "description": "Comma separated values of payment statuses. Available values due, partial, paid, overdue", "disabled": false }, { "key": "start_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "end_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "user_id", "value": "maxime", "description": "id of the user who created the sale", "disabled": false }, { "key": "service_staff_id", "value": "architecto", "description": "id of the service staff assigned with the sale", "disabled": false }, { "key": "shipping_status", "value": "ordered", "description": "Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')", "disabled": false }, { "key": "source", "value": "provident", "description": "Source of the sale", "disabled": false }, { "key": "customer_group_id", "value": "molestiae", "description": "id of the customer group", "disabled": false }, { "key": "product_name", "value": "non", "description": "name of the product", "disabled": false }, { "key": "product_sku", "value": "iure", "description": "sku of the product or variation", "disabled": false }, { "key": "product_custom_field_1", "value": "ea", "description": "custome field 1 of the product", "disabled": false }, { "key": "location_custom_field_1", "value": "alias", "description": "custome field 1 of the location", "disabled": false }, { "key": "location_invoice_scheme_prefix", "value": "earum", "description": "Invoice scheme prefix of the location", "disabled": false }, { "key": "product_category_id", "value": "est", "description": "category id of the product", "disabled": false }, { "key": "product_sub_category_id", "value": "sint", "description": "Sub category id of the product", "disabled": false }, { "key": "sell_ids", "value": "55%2C64", "description": "comma separated ids of the sells", "disabled": false }, { "key": "only_subscriptions", "value": "recusandae", "description": "Filter only subcription invoices (1, 0)", "disabled": false }, { "key": "send_purchase_details", "value": "necessitatibus", "description": "Get purchase details of each sell line (1, 0)", "disabled": false }, { "key": "order_by_date", "value": "desc", "description": "Sort sell list by date ('asc', 'desc')", "disabled": false }, { "key": "per_page", "value": "10", "description": "Total records per page. default: 10, Set -1 for no pagination", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/new_sell?location_id=1&contact_id=dolorem&payment_status=due%2Cpartial&start_date=2018-06-25&end_date=2018-06-25&user_id=maxime&service_staff_id=architecto&shipping_status=ordered&source=provident&customer_group_id=molestiae&product_name=non&product_sku=iure&product_custom_field_1=ea&location_custom_field_1=alias&location_invoice_scheme_prefix=earum&product_category_id=est&product_sub_category_id=sint&sell_ids=55%2C64&only_subscriptions=recusandae&send_purchase_details=necessitatibus&order_by_date=desc&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 6,\n\"business_id\": 1,\n\"location_id\": 1,\n\"res_table_id\": null,\n\"type\": \"sell\",\n\"status\": \"final\",\n\"is_quotation\": 0,\n\"payment_status\": \"paid\",\n\"contact_id\": 4,\n\"customer_group_id\": null,\n\"invoice_no\": \"AS0001\",\n\"ref_no\": \"\",\n\"source\": null,\n\"unique_hash\": null,\n\"hash_control\": null,\n\"subscription_no\": null,\n\"subscription_repeat_on\": null,\n\"transaction_date\": \"2018-04-10 13:23:21\",\n\"total_before_tax\": \"770.0000\",\n\"tax_id\": null,\n\"tax_amount\": \"0.0000\",\n\"discount_type\": \"percentage\",\n\"discount_amount\": \"0.0000\",\n\"rp_redeemed\": 0,\n\"rp_redeemed_amount\": \"0.0000\",\n\"shipping_details\": null,\n\"shipping_address\": null,\n\"shipping_status\": null,\n\"delivered_to\": null,\n\"additional_notes\": null,\n\"staff_note\": null,\n\"round_off_amount\": \"0.0000\",\n\"final_total\": \"770.0000\",\n\"expense_sub_category_id\": null,\n\"is_direct_sale\": 0,\n\"is_suspend\": 0,\n\"total_amount_recovered\": null,\n\"crm_is_order_request\": 0,\n\"mfg_production_cost\": \"0.0000\",\n\"mfg_production_cost_type\": \"percentage\",\n\"mfg_is_final\": 0,\n\"is_created_from_api\": 0,\n\"essentials_duration\": \"0.00\",\n\"essentials_duration_unit\": null,\n\"essentials_amount_per_unit_duration\": \"0.0000\",\n\"essentials_allowances\": null,\n\"essentials_deductions\": null,\n\"repair_completed_on\": null,\n\"repair_warranty_id\": null,\n\"repair_brand_id\": null,\n\"repair_status_id\": null,\n\"repair_model_id\": null,\n\"repair_job_sheet_id\": null,\n\"repair_defects\": null,\n\"repair_serial_no\": null,\n\"repair_checklist\": null,\n\"repair_security_pwd\": null,\n\"repair_security_pattern\": null,\n\"repair_due_date\": null,\n\"repair_device_id\": null,\n\"repair_updates_notif\": 0,\n\"invoice_token\": \"00f79f7fd292225e8c303a6bf8626d06\",\n\"pjt_project_id\": null,\n\"pjt_title\": null,\n\"woocommerce_order_id\": null,\n\"selling_price_group_id\": null,\n\"created_at\": \"2018-01-06 07:06:11\",\n\"updated_at\": \"2021-10-23 11:42:13\",\n\"location_name\": \"Location 1\",\n\"location_custom_field1\": \"gdgdgd88\",\n\"location_invoice_scheme_prefix\": \"AS\",\n\"table_name\": null,\n\"table_description\": null,\n\"contact\": \"Harry\",\n\"customer_group_name\": \"grp 2\",\n\"sell_lines\": [\n{\n\"id\": 1,\n\"transaction_id\": 6,\n\"product_id\": 2,\n\"quantity\": 10,\n\"quantity_returned\": \"0.0000\",\n\"unit_price_before_discount\": \"70.0000\",\n\"unit_price\": \"70.0000\",\n\"line_discount_type\": null,\n\"line_discount_amount\": \"0.0000\",\n\"unit_price_inc_tax\": \"77.0000\",\n\"item_tax\": \"7.0000\",\n\"tax_id\": 1,\n\"discount_id\": null,\n\"lot_no_line_id\": null,\n\"sell_line_note\": null,\n\"woocommerce_line_items_id\": null,\n\"children_type\": \"\",\n\"created_at\": \"2018-01-06 07:06:11\",\n\"updated_at\": \"2018-01-06 07:06:11\",\n\"product_name\": \"Levis Men's Slimmy Fit Jeans\",\n\"product_custom_field_1\": null,\n\"product_type\": \"variable\",\n\"product_sku\": \"AS0002\",\n\"category\": {\n\"id\": 1,\n\"name\": \"Men's\",\n\"business_id\": 1,\n\"short_code\": \"sfefef\",\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null\n},\n\"sub_category\": {\n\"id\": 4,\n\"name\": \"Jeans\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 1,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null\n},\n\"product_variations\": {\n\"id\": 3,\n\"name\": \"30\",\n\"product_id\": 2,\n\"sub_sku\": \"AS0002-2\",\n\"product_variation_id\": 2,\n\"default_purchase_price\": \"70.0000\",\n\"dpp_inc_tax\": \"77.0000\",\n\"default_sell_price\": \"70.0000\",\n\"sell_price_inc_tax\": \"77.0000\"\n}\n}\n],\n\"payment_lines\": [\n{\n\"id\": 1,\n\"transaction_id\": 6,\n\"business_id\": null,\n\"is_return\": 0,\n\"amount\": \"770.0000\",\n\"method\": \"cash\",\n\"card_type\": \"visa\",\n\"paid_on\": \"2018-01-09 17:30:35\",\n\"payment_ref_no\": null\n}\n],\n\"invoice_url\": \"https:\/\/bqf.ai\/invoice\/00f79f7fd292225e8c303a6bf8626d06\",\n\"payment_link\": \"\"\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/new_sell?per_page=1&page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/new_sell?per_page=1&page=213\",\n\"prev\": null,\n\"next\": \"https:\/\/bqf.ai\/connector\/api\/new_sell?per_page=1&page=2\"\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"last_page\": 213,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/new_sell\",\n\"per_page\": \"1\",\n\"to\": 1,\n\"total\": 213\n}\n}", "name": "" } ] }, { "name": "New List contact", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/new_contactapi", "query": [ { "key": "type", "value": "non", "description": "Type of contact (supplier, customer)", "disabled": false }, { "key": "customer_group_id", "value": "consequatur", "description": "id of the customer group", "disabled": false }, { "key": "custom_field_1", "value": "eos", "description": "Custom field 1 of the contact", "disabled": false }, { "key": "contact_ids", "value": "2%2C3", "description": "comma separated ids of contacts", "disabled": false }, { "key": "name", "value": "hic", "description": "Search term for contact name", "disabled": false }, { "key": "biz_name", "value": "maxime", "description": "Search term for contact's business name", "disabled": false }, { "key": "mobile_num", "value": "2", "description": "Search term for contact's mobile number", "disabled": false }, { "key": "contact_id", "value": "optio", "description": "Search term for contact's contact_id. Ex(CO0005)", "disabled": false }, { "key": "order_by", "value": "est", "description": "Column name to sort the result, Column: name, supplier_business_name", "disabled": false }, { "key": "direction", "value": "optio", "description": "Direction to sort the result, Direction: desc, asc", "disabled": false }, { "key": "per_page", "value": "10", "description": "Total records per page. default: 10, Set -1 for no pagination", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/new_contactapi?type=non&customer_group_id=consequatur&custom_field_1=eos&contact_ids=2%2C3&name=hic&biz_name=maxime&mobile_num=2&contact_id=optio&order_by=est&direction=optio&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 18,\n\"business_id\": 1,\n\"type\": \"customer\",\n\"name\": \"Mr. Rohit Kumar Agrawalla\",\n\"prefix\": \"Mr.\",\n\"first_name\": \"Rohit\",\n\"middle_name\": \"Kumar\",\n\"last_name\": \"Agrawalla\",\n\"email\": null,\n\"contact_status\": \"active\",\n\"mobile\": \"8596859647\",\n\"credit_limit\": null,\n\"converted_by\": null,\n\"converted_on\": null,\n\"balance\": \"40.0000\",\n\"total_rp\": 0,\n\"total_rp_used\": 0,\n\"total_rp_expired\": 0,\n\"customer_group_id\": 1,\n\"crm_source\": null,\n\"crm_life_stage\": null,\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"custom_field5\": null,\n\"custom_field6\": null,\n\"custom_field7\": null,\n\"custom_field8\": null,\n\"custom_field9\": null,\n\"custom_field10\": null,\n\"remember_token\": null,\n\"password\": null\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/new_contactapi?customer_group_id=1&page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/new_contactapi?customer_group_id=1&page=1\",\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"last_page\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/new_contactapi\",\n\"per_page\": 10,\n\"to\": 1,\n\"total\": 1\n}\n}", "name": "" } ] } ] }, { "name": "Online store (Ecommerce)", "description": "", "item": [ { "name": "Store branches", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/ecommerce\/branches", "query": [], "raw": "{{baseUrl}}\/connector\/api\/ecommerce\/branches" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The branches of the business as the store sees them, limited to the ones the user may\nwork with: which sell online, the default fulfilment branch, and which offer pickup." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"id\": 1, \"name\": \"Riyadh\", \"public_name\": \"Riyadh \u2014 Olaya\", \"city\": \"Riyadh\", \"is_enabled\": true, \"is_default\": true, \"allow_pickup\": true}]}", "name": "" } ] }, { "name": "List online orders", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/ecommerce\/orders", "query": [ { "key": "status", "value": "awaiting_confirmation", "description": "One order status (awaiting_confirmation, confirmed, processing, shipped, delivered, completed, cancelled, refunded, on_hold).", "disabled": false }, { "key": "payment_status", "value": "pending", "description": "pending, paid, partially_refunded or refunded.", "disabled": false }, { "key": "fulfilment_type", "value": "pickup", "description": "delivery or pickup.", "disabled": false }, { "key": "location_id", "value": "1", "description": "One branch (must be permitted).", "disabled": false }, { "key": "from", "value": "2026-09-01", "description": "date Placed on or after (Y-m-d).", "disabled": false }, { "key": "to", "value": "2026-09-30", "description": "date Placed on or before (Y-m-d).", "disabled": false }, { "key": "q", "value": "EC-000123", "description": "Order number, customer name or phone.", "disabled": false }, { "key": "per_page", "value": "25", "description": "1..100, default 25.", "disabled": false }, { "key": "page", "value": "1", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/ecommerce\/orders?status=awaiting_confirmation&payment_status=pending&fulfilment_type=pickup&location_id=1&from=2026-09-01&to=2026-09-30&q=EC-000123&per_page=25&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Newest first, only the branches the user may see. Filters are optional." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [{\"id\": 12, \"number\": \"EC-000012\", \"status\": \"confirmed\", \"status_label\": \"\u0645\u0624\u0643\u0651\u062f\", \"payment_status\": \"pending\", \"payment_gateway\": \"cod\",\n \"fulfilment_type\": \"delivery\", \"branch\": {\"id\": 1, \"name\": \"Riyadh\"}, \"customer\": {\"name\": \"Sara\", \"phone\": \"0551234567\"},\n \"total\": 165.0, \"currency\": \"SAR\", \"items_count\": 2, \"invoiced\": true, \"placed_at\": \"2026-09-24 10:15:00\"}],\n \"meta\": {\"current_page\": 1, \"per_page\": 25, \"total\": 1, \"last_page\": 1}\n}", "name": "" } ] }, { "name": "Order details", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/ecommerce\/orders\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/ecommerce\/orders\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The order with its lines, branch, customer, latest shipment, and status history." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\"id\": 12, \"number\": \"EC-000012\", \"status\": \"processing\", \"status_label\": \"\u0642\u064a\u062f \u0627\u0644\u062a\u062c\u0647\u064a\u0632\", \"fulfilment_type\": \"pickup\", \"branch\": {\"id\": 2, \"name\": \"Jeddah\", \"city\": \"Jeddah\", \"mobile\": \"0126...\"},\n \"customer\": {\"name\": \"Sara\", \"phone\": \"0551234567\", \"email\": null, \"address\": \"\"}, \"totals\": {\"subtotal\": 150.0, \"shipping_fee\": 0.0, \"total\": 150.0, \"currency\": \"SAR\"},\n \"items\": [{\"product_id\": 3, \"variation_id\": 3, \"name\": \"Item\", \"sku\": \"A1\", \"qty\": 2, \"unit_price\": 75.0, \"line_total\": 150.0}],\n \"shipment\": null, \"next_statuses\": [\"shipped\", \"cancelled\", \"refunded\", \"on_hold\"], \"history\": [{\"to\": \"confirmed\", \"at\": \"2026-09-24 10:20:00\", \"note\": \"admin confirmed\"}]}\n}", "name": "" } ] }, { "name": "Change an order's status", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/ecommerce\/orders\/:id\/transition", "query": [], "raw": "{{baseUrl}}\/connector\/api\/ecommerce\/orders\/:id\/transition", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"to\":\"confirmed\"}" }, "description": "Moves the order along its lifecycle exactly as the back office does (the Core sale is\ncreated at the configured stage, stock returns on cancel). Only the transitions the\nstate machine allows from the current status are accepted (422 `transition_failed`)." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true, \"data\": {\"id\": 12, \"status\": \"confirmed\", \"status_label\": \"\u0645\u0624\u0643\u0651\u062f\", \"next_statuses\": [\"processing\", \"cancelled\", \"refunded\"]}}", "name": "" } ] } ] }, { "name": "Other endpoints \u00b7 \u0648\u0627\u062c\u0647\u0627\u062a \u0623\u062e\u0631\u0649", "description": "", "item": [ { "name": "List payment accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/payment-accounts", "query": [ { "key": "include_closed", "value": "1", "description": "optional 1 to include closed accounts (needs account.access)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/payment-accounts?include_closed=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Open accounts. Without the account.access permission the account number\nis masked to its last four digits and account_details is null." }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"Test Account\",\n\"account_number\": \"8746888847455\",\n\"account_type_id\": 0,\n\"note\": null,\n\"created_by\": 9,\n\"is_closed\": 0,\n\"deleted_at\": null,\n\"created_at\": \"2020-06-04 21:34:21\",\n\"updated_at\": \"2020-06-04 21:34:21\"\n}\n]\n}", "name": "" } ] }, { "name": "List payment methods", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/payment-methods", "query": [ { "key": "location_id", "value": "1", "description": "optional id of a branch: only the methods enabled for it", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/payment-methods?location_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "With the business's own labels for the custom methods." }, "response": [ { "header": [], "code": 200, "body": "{\n\"cash\": \"Cash\",\n\"card\": \"Card\",\n\"cheque\": \"Cheque\",\n\"bank_transfer\": \"Bank Transfer\",\n\"other\": \"Other\",\n\"custom_pay_1\": \"Custom Payment 1\",\n\"custom_pay_2\": \"Custom Payment 2\",\n\"custom_pay_3\": \"Custom Payment 3\"\n}", "name": "" } ] }, { "name": "Get business details", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/business-details", "query": [], "raw": "{{baseUrl}}\/connector\/api\/business-details" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"id\": 1,\n\"name\": \"Awesome Shop\",\n\"currency_id\": 2,\n\"start_date\": \"2018-01-01\",\n\"tax_number_1\": \"3412569900\",\n\"tax_label_1\": \"GSTIN\",\n\"tax_number_2\": null,\n\"tax_label_2\": null,\n\"default_sales_tax\": null,\n\"default_profit_percent\": 25,\n\"owner_id\": 1,\n\"time_zone\": \"America\/Phoenix\",\n\"fy_start_month\": 1,\n\"accounting_method\": \"fifo\",\n\"default_sales_discount\": \"10.00\",\n\"sell_price_tax\": \"includes\",\n\"logo\": null,\n\"sku_prefix\": \"AS\",\n\"enable_product_expiry\": 0,\n\"expiry_type\": \"add_expiry\",\n\"on_product_expiry\": \"keep_selling\",\n\"stop_selling_before\": 0,\n\"enable_tooltip\": 1,\n\"purchase_in_diff_currency\": 0,\n\"purchase_currency_id\": null,\n\"p_exchange_rate\": \"1.000\",\n\"transaction_edit_days\": 30,\n\"stock_expiry_alert_days\": 30,\n\"keyboard_shortcuts\": {\n\"pos\": {\n\"express_checkout\": \"shift+e\",\n\"pay_n_ckeckout\": \"shift+p\",\n\"draft\": \"shift+d\",\n\"cancel\": \"shift+c\",\n\"recent_product_quantity\": \"f2\",\n\"weighing_scale\": null,\n\"edit_discount\": \"shift+i\",\n\"edit_order_tax\": \"shift+t\",\n\"add_payment_row\": \"shift+r\",\n\"finalize_payment\": \"shift+f\",\n\"add_new_product\": \"f4\"\n}\n},\n\"pos_settings\": {\n\"amount_rounding_method\": null,\n\"disable_pay_checkout\": 0,\n\"disable_draft\": 0,\n\"disable_express_checkout\": 0,\n\"hide_product_suggestion\": 0,\n\"hide_recent_trans\": 0,\n\"disable_discount\": 0,\n\"disable_order_tax\": 0,\n\"is_pos_subtotal_editable\": 0\n},\n\"weighing_scale_setting\": {\n\"label_prefix\": null,\n\"product_sku_length\": \"4\",\n\"qty_length\": \"3\",\n\"qty_length_decimal\": \"2\"\n},\n\"manufacturing_settings\": null,\n\"essentials_settings\": null,\n\"ecom_settings\": null,\n\"woocommerce_wh_oc_secret\": null,\n\"woocommerce_wh_ou_secret\": null,\n\"woocommerce_wh_od_secret\": null,\n\"woocommerce_wh_or_secret\": null,\n\"enable_brand\": 1,\n\"enable_category\": 1,\n\"enable_sub_category\": 1,\n\"enable_price_tax\": 1,\n\"enable_purchase_status\": 1,\n\"enable_lot_number\": 0,\n\"default_unit\": null,\n\"enable_sub_units\": 0,\n\"enable_racks\": 0,\n\"enable_row\": 0,\n\"enable_position\": 0,\n\"enable_editing_product_from_purchase\": 1,\n\"sales_cmsn_agnt\": null,\n\"item_addition_method\": 1,\n\"enable_inline_tax\": 1,\n\"currency_symbol_placement\": \"before\",\n\"enabled_modules\": [\n\"purchases\",\n\"add_sale\",\n\"pos_sale\",\n\"stock_transfers\",\n\"stock_adjustment\",\n\"expenses\",\n\"account\",\n\"tables\",\n\"modifiers\",\n\"service_staff\",\n\"booking\",\n\"kitchen\",\n\"subscription\",\n\"types_of_service\"\n],\n\"date_format\": \"m\/d\/Y\",\n\"time_format\": \"24\",\n\"ref_no_prefixes\": {\n\"purchase\": \"PO\",\n\"purchase_return\": null,\n\"stock_transfer\": \"ST\",\n\"stock_adjustment\": \"SA\",\n\"sell_return\": \"CN\",\n\"expense\": \"EP\",\n\"contacts\": \"CO\",\n\"purchase_payment\": \"PP\",\n\"sell_payment\": \"SP\",\n\"expense_payment\": null,\n\"business_location\": \"BL\",\n\"username\": null,\n\"subscription\": null\n},\n\"theme_color\": null,\n\"created_by\": null,\n\"enable_rp\": 0,\n\"rp_name\": null,\n\"amount_for_unit_rp\": \"1.0000\",\n\"min_order_total_for_rp\": \"1.0000\",\n\"max_rp_per_order\": null,\n\"redeem_amount_per_unit_rp\": \"1.0000\",\n\"min_order_total_for_redeem\": \"1.0000\",\n\"min_redeem_point\": null,\n\"max_redeem_point\": null,\n\"rp_expiry_period\": null,\n\"rp_expiry_type\": \"year\",\n\"repair_settings\": null,\n\"email_settings\": {\n\"mail_driver\": \"smtp\",\n\"mail_host\": null,\n\"mail_port\": null,\n\"mail_username\": null,\n\"mail_password\": null,\n\"mail_encryption\": null,\n\"mail_from_address\": null,\n\"mail_from_name\": null\n},\n\"sms_settings\": {\n\"url\": null,\n\"send_to_param_name\": \"to\",\n\"msg_param_name\": \"text\",\n\"request_method\": \"post\",\n\"param_1\": null,\n\"param_val_1\": null,\n\"param_2\": null,\n\"param_val_2\": null,\n\"param_3\": null,\n\"param_val_3\": null,\n\"param_4\": null,\n\"param_val_4\": null,\n\"param_5\": null,\n\"param_val_5\": null,\n\"param_6\": null,\n\"param_val_6\": null,\n\"param_7\": null,\n\"param_val_7\": null,\n\"param_8\": null,\n\"param_val_8\": null,\n\"param_9\": null,\n\"param_val_9\": null,\n\"param_10\": null,\n\"param_val_10\": null\n},\n\"custom_labels\": {\n\"payments\": {\n\"custom_pay_1\": null,\n\"custom_pay_2\": null,\n\"custom_pay_3\": null\n},\n\"contact\": {\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null\n},\n\"product\": {\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null\n},\n\"location\": {\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null\n},\n\"user\": {\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null\n},\n\"purchase\": {\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null\n},\n\"sell\": {\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null\n},\n\"types_of_service\": {\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null\n}\n},\n\"common_settings\": {\n\"default_datatable_page_entries\": \"25\"\n},\n\"is_active\": 1,\n\"created_at\": \"2018-01-04 02:15:19\",\n\"updated_at\": \"2020-06-04 22:33:01\",\n\"locations\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": null,\n\"name\": \"Awesome Shop\",\n\"landmark\": \"Linking Street\",\n\"country\": \"USA\",\n\"state\": \"Arizona\",\n\"city\": \"Phoenix\",\n\"zip_code\": \"85001\",\n\"invoice_scheme_id\": 1,\n\"invoice_layout_id\": 1,\n\"selling_price_group_id\": null,\n\"print_receipt_on_invoice\": 1,\n\"receipt_printer_type\": \"browser\",\n\"printer_id\": null,\n\"mobile\": null,\n\"alternate_number\": null,\n\"email\": null,\n\"website\": null,\n\"featured_products\": [\n\"5\",\n\"71\"\n],\n\"is_active\": 1,\n\"default_payment_accounts\": {\n\"cash\": {\n\"is_enabled\": \"1\",\n\"account\": null\n},\n\"card\": {\n\"is_enabled\": \"1\",\n\"account\": null\n},\n\"cheque\": {\n\"is_enabled\": \"1\",\n\"account\": null\n},\n\"bank_transfer\": {\n\"is_enabled\": \"1\",\n\"account\": null\n},\n\"other\": {\n\"is_enabled\": \"1\",\n\"account\": null\n},\n\"custom_pay_1\": {\n\"is_enabled\": \"1\",\n\"account\": null\n},\n\"custom_pay_2\": {\n\"is_enabled\": \"1\",\n\"account\": null\n},\n\"custom_pay_3\": {\n\"is_enabled\": \"1\",\n\"account\": null\n}\n},\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:20\",\n\"updated_at\": \"2020-06-05 00:56:54\"\n}\n],\n\"currency\": {\n\"id\": 2,\n\"country\": \"America\",\n\"currency\": \"Dollars\",\n\"code\": \"USD\",\n\"symbol\": \"$\",\n\"thousand_separator\": \",\",\n\"decimal_separator\": \".\",\n\"created_at\": null,\n\"updated_at\": null\n},\n\"printers\": [],\n\"currency_precision\": 2,\n\"quantity_precision\": 2\n}\n}", "name": "" } ] }, { "name": "Get profit and loss report", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/profit-loss-report", "query": [ { "key": "location_id", "value": "1", "description": "optional id of the location", "disabled": false }, { "key": "start_date", "value": "2018-06-25", "description": "optional format:Y-m-d", "disabled": false }, { "key": "end_date", "value": "2018-06-25", "description": "optional format:Y-m-d", "disabled": false }, { "key": "user_id", "value": "1", "description": "optional id of the user", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/profit-loss-report?location_id=1&start_date=2018-06-25&end_date=2018-06-25&user_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"total_purchase_shipping_charge\": 0,\n\"total_sell_shipping_charge\": 0,\n\"total_transfer_shipping_charges\": \"0.0000\",\n\"opening_stock\": 0,\n\"closing_stock\": \"386859.00000000\",\n\"total_purchase\": 386936,\n\"total_purchase_discount\": \"0.000000000000\",\n\"total_purchase_return\": \"0.0000\",\n\"total_sell\": 9764.5,\n\"total_sell_discount\": \"11.550000000000\",\n\"total_sell_return\": \"0.0000\",\n\"total_sell_round_off\": \"0.0000\",\n\"total_expense\": \"0.0000\",\n\"total_adjustment\": \"0.0000\",\n\"total_recovered\": \"0.0000\",\n\"total_reward_amount\": \"0.0000\",\n\"left_side_module_data\": [\n{\n\"value\": \"0.0000\",\n\"label\": \"Total Payroll\",\n\"add_to_net_profit\": true\n},\n{\n\"value\": 0,\n\"label\": \"Total Production Cost\",\n\"add_to_net_profit\": true\n}\n],\n\"right_side_module_data\": [],\n\"net_profit\": 9675.95,\n\"gross_profit\": -11.55,\n\"total_sell_by_subtype\": []\n}\n}", "name": "" } ] }, { "name": "Aggregated POS home stats (one SQL round-trip, not a full sell list).", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/pos-dashboard-stats", "query": [], "raw": "{{baseUrl}}\/connector\/api\/pos-dashboard-stats" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Search customers at the till", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/pos-customer-search", "query": [ { "key": "search", "value": "55", "description": "optional name, mobile or customer number (part of)", "disabled": false }, { "key": "per_page", "value": "20", "description": "optional Most rows to return (1-30). default: 20", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/pos-customer-search?search=55&per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Active customers the user may pick, as the web POS customer picker lists\nthem. A customer.view_own user finds only their own customers. A\nbranch-limited user finds another branch's customer only by the full mobile\nnumber (to sell to it, send that number as the sale's customer_mobile).\n\ndue: what the customer owes (final sales net of payments, ledger discounts and\nreturns, plus the unpaid opening balance). advance_balance: the customer's credit\n(advance paid). Until 2026-09 'due' carried the advance balance." }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 12,\n\"name\": \"Walk-In Customer\",\n\"mobile\": \"0550000000\",\n\"customer_no\": \"CO0001\",\n\"due\": 150.5,\n\"advance_balance\": 20,\n\"invoices\": 7,\n\"last_sale\": \"2026-09-01 10:15:00\"\n}\n]\n}", "name": "" } ] }, { "name": "Get product current stock", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/product-stock-report", "query": [ { "key": "location_id", "value": "1", "description": "optional id of the location", "disabled": false }, { "key": "per_page", "value": "15", "description": "optional Total records per page (up to 500). default: 15, -1 for the largest page", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/product-stock-report?location_id=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Needs the stock_report.view permission." }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"total_sold\": null,\n\"total_transfered\": null,\n\"total_adjusted\": null,\n\"stock_price\": null,\n\"stock\": null,\n\"sku\": \"AS0001\",\n\"product\": \"Men's Reverse Fleece Crew\",\n\"type\": \"single\",\n\"product_id\": 1,\n\"unit\": \"Pc(s)\",\n\"enable_stock\": 1,\n\"unit_price\": \"143.0000\",\n\"product_variation\": \"DUMMY\",\n\"variation_name\": \"DUMMY\",\n\"location_name\": null,\n\"location_id\": null,\n\"variation_id\": 1\n},\n{\n\"total_sold\": \"50.0000\",\n\"total_transfered\": null,\n\"total_adjusted\": null,\n\"stock_price\": \"3850.00000000\",\n\"stock\": \"50.0000\",\n\"sku\": \"AS0002-1\",\n\"product\": \"Levis Men's Slimmy Fit Jeans\",\n\"type\": \"variable\",\n\"product_id\": 2,\n\"unit\": \"Pc(s)\",\n\"enable_stock\": 1,\n\"unit_price\": \"77.0000\",\n\"product_variation\": \"Waist Size\",\n\"variation_name\": \"28\",\n\"location_name\": \"Awesome Shop\",\n\"location_id\": 1,\n\"variation_id\": 2\n},\n{\n\"total_sold\": \"60.0000\",\n\"total_transfered\": null,\n\"total_adjusted\": null,\n\"stock_price\": \"6930.00000000\",\n\"stock\": \"90.0000\",\n\"sku\": \"AS0002-2\",\n\"product\": \"Levis Men's Slimmy Fit Jeans\",\n\"type\": \"variable\",\n\"product_id\": 2,\n\"unit\": \"Pc(s)\",\n\"enable_stock\": 1,\n\"unit_price\": \"77.0000\",\n\"product_variation\": \"Waist Size\",\n\"variation_name\": \"30\",\n\"location_name\": \"Awesome Shop\",\n\"location_id\": 1,\n\"variation_id\": 3\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/product-stock-report?page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/product-stock-report?page=22\",\n\"prev\": null,\n\"next\": \"https:\/\/bqf.ai\/connector\/api\/product-stock-report?page=2\"\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"last_page\": 22,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/product-stock-report\",\n\"per_page\": 3,\n\"to\": 3,\n\"total\": 66\n}\n}", "name": "" } ] }, { "name": "Get notifications", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/notifications", "query": [ { "key": "limit", "value": "50", "description": "optional Most notifications to return (1-500). default: 500", "disabled": false }, { "key": "unread_only", "value": "1", "description": "optional 1 for unread notifications only", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/notifications?limit=50&unread_only=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Newest first." }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"msg\": \"Payroll for August\/2020 added by Mr. Super Admin. Reference No. 2020\/0002\",\n\"icon_class\": \"fas fa-money-bill-alt bg-green\",\n\"link\": \"https:\/\/bqf.ai\/hrm\/payroll\",\n\"read_at\": null,\n\"created_at\": \"3 hours ago\"\n}\n]\n}", "name": "" } ] }, { "name": "Get location details from coordinates", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/get-location", "query": [], "raw": "{{baseUrl}}\/connector\/api\/get-location" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"lat\":\"41.40338\",\"lon\":\"2.17403\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"address\": \"Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India\"\n}", "name": "" } ] }, { "name": "GET connector\/api\/crm\/pipeline", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/pipeline", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/pipeline" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET connector\/api\/crm\/segments", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/segments", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/segments" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET connector\/api\/crm\/segments\/{segment}\/contacts", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/segments\/:segment\/contacts", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/segments\/:segment\/contacts", "variable": [ { "id": "segment", "key": "segment", "value": "adipisci", "description": "The segment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET connector\/api\/crm\/contacts\/{id}\/metrics", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/contacts\/:id\/metrics", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/contacts\/:id\/metrics", "variable": [ { "id": "id", "key": "id", "value": "magnam", "description": "The ID of the contact." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET connector\/api\/crm\/leads-list", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/leads-list", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/leads-list" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST connector\/api\/crm\/leads", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/leads", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/leads" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"wsqkzqiknzharef\",\"last_name\":\"buzsoskhsonwswse\",\"prefix\":\"sb\",\"business_name\":\"wd\",\"mobile\":\"hrrvqw\",\"email\":\"sam56@example.org\",\"contact_id\":\"ugqt\",\"source_id\":20,\"life_stage_id\":3,\"city\":\"vmhxmykauxobkczwnxkoftoe\",\"address\":\"ztydbiaugkbdgnulfzfmooo\",\"expected_value\":58,\"probability\":3,\"expected_close_date\":\"2026-09-24T21:24:58\",\"assigned_user_ids\":[4]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET connector\/api\/crm\/leads\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/leads\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/leads\/:id", "variable": [ { "id": "id", "key": "id", "value": "molestiae", "description": "The ID of the lead." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT connector\/api\/crm\/leads\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/leads\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/leads\/:id", "variable": [ { "id": "id", "key": "id", "value": "quia", "description": "The ID of the lead." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"meheewfhniiayvbwsusps\",\"last_name\":\"yxet\",\"business_name\":\"vlwsbyqpolvbos\",\"mobile\":\"mepdnvafjjljx\",\"email\":\"johnpaul.eichmann@example.com\",\"source_id\":14,\"life_stage_id\":3,\"city\":\"mmcrzbcfvqmrpfco\",\"expected_value\":23,\"probability\":15,\"expected_close_date\":\"2026-09-24T21:24:58\",\"assigned_user_ids\":[6]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST connector\/api\/crm\/leads\/{id}\/convert", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/leads\/:id\/convert", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/leads\/:id\/convert", "variable": [ { "id": "id", "key": "id", "value": "illum", "description": "The ID of the lead." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET connector\/api\/crm\/webhook-events", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/crm\/webhook-events", "query": [], "raw": "{{baseUrl}}\/connector\/api\/crm\/webhook-events" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Product management", "description": "", "item": [ { "name": "List products", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/product", "query": [ { "key": "order_by", "value": "beatae", "description": "Values: product_name or newest", "disabled": false }, { "key": "order_direction", "value": "earum", "description": "Values: asc or desc", "disabled": false }, { "key": "brand_id", "value": "quia", "description": "comma separated ids of one or multiple brands", "disabled": false }, { "key": "category_id", "value": "quis", "description": "comma separated ids of one or multiple category", "disabled": false }, { "key": "sub_category_id", "value": "et", "description": "comma separated ids of one or multiple sub-category", "disabled": false }, { "key": "location_id", "value": "1", "description": "", "disabled": false }, { "key": "selling_price_group", "value": "in", "description": "(1, 0)", "disabled": false }, { "key": "send_lot_detail", "value": "tempore", "description": "Send lot details in each variation location details(1, 0)", "disabled": false }, { "key": "name", "value": "nobis", "description": "Search term for product name", "disabled": false }, { "key": "sku", "value": "quia", "description": "Search term for product sku", "disabled": false }, { "key": "per_page", "value": "10", "description": "Total records per page. default: 10, Set -1 for no pagination", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/product?order_by=beatae&order_direction=earum&brand_id=quia&category_id=quis&sub_category_id=et&location_id=1&selling_price_group=in&send_lot_detail=tempore&name=nobis&sku=quia&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Men's Reverse Fleece Crew\",\n\"business_id\": 1,\n\"type\": \"single\",\n\"sub_unit_ids\": null,\n\"enable_stock\": 1,\n\"alert_quantity\": \"5.0000\",\n\"sku\": \"AS0001\",\n\"barcode_type\": \"C128\",\n\"expiry_period\": null,\n\"expiry_period_type\": null,\n\"enable_sr_no\": 0,\n\"weight\": null,\n\"product_custom_field1\": null,\n\"product_custom_field2\": null,\n\"product_custom_field3\": null,\n\"product_custom_field4\": null,\n\"image\": null,\n\"woocommerce_media_id\": null,\n\"product_description\": null,\n\"created_by\": 1,\n\"warranty_id\": null,\n\"is_inactive\": 0,\n\"repair_model_id\": null,\n\"not_for_selling\": 0,\n\"ecom_shipping_class_id\": null,\n\"ecom_active_in_store\": 1,\n\"woocommerce_product_id\": 356,\n\"woocommerce_disable_sync\": 0,\n\"image_url\": \"https:\/\/bqf.ai\/img\/default.png\",\n\"product_variations\": [\n{\n\"id\": 1,\n\"variation_template_id\": null,\n\"name\": \"DUMMY\",\n\"product_id\": 1,\n\"is_dummy\": 1,\n\"created_at\": \"2018-01-03 21:29:08\",\n\"updated_at\": \"2018-01-03 21:29:08\",\n\"variations\": [\n{\n\"id\": 1,\n\"name\": \"DUMMY\",\n\"product_id\": 1,\n\"sub_sku\": \"AS0001\",\n\"product_variation_id\": 1,\n\"woocommerce_variation_id\": null,\n\"variation_value_id\": null,\n\"default_purchase_price\": \"130.0000\",\n\"dpp_inc_tax\": \"143.0000\",\n\"profit_percent\": \"0.0000\",\n\"default_sell_price\": \"130.0000\",\n\"sell_price_inc_tax\": \"143.0000\",\n\"created_at\": \"2018-01-03 21:29:08\",\n\"updated_at\": \"2020-06-09 00:23:22\",\n\"deleted_at\": null,\n\"combo_variations\": null,\n\"variation_location_details\": [\n{\n\"id\": 56,\n\"product_id\": 1,\n\"product_variation_id\": 1,\n\"variation_id\": 1,\n\"location_id\": 1,\n\"qty_available\": \"20.0000\",\n\"created_at\": \"2020-06-08 23:46:40\",\n\"updated_at\": \"2020-06-08 23:46:40\"\n}\n],\n\"media\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"file_name\": \"1591686466_978227300_nn.jpeg\",\n\"description\": null,\n\"uploaded_by\": 9,\n\"model_type\": \"App\\\\Variation\",\n\"woocommerce_media_id\": null,\n\"model_id\": 1,\n\"created_at\": \"2020-06-09 00:07:46\",\n\"updated_at\": \"2020-06-09 00:07:46\",\n\"display_name\": \"nn.jpeg\",\n\"display_url\": \"https:\/\/bqf.ai\/uploads\/media\/1591686466_978227300_nn.jpeg\"\n}\n],\n\"discounts\": [\n{\n\"id\": 2,\n\"name\": \"FLAT 10%\",\n\"business_id\": 1,\n\"brand_id\": null,\n\"category_id\": null,\n\"location_id\": 1,\n\"priority\": 2,\n\"discount_type\": \"fixed\",\n\"discount_amount\": \"5.0000\",\n\"starts_at\": \"2021-09-01 11:45:00\",\n\"ends_at\": \"2021-09-30 11:45:00\",\n\"is_active\": 1,\n\"spg\": null,\n\"applicable_in_cg\": 1,\n\"created_at\": \"2021-09-01 11:46:00\",\n\"updated_at\": \"2021-09-01 12:12:55\",\n\"formated_starts_at\": \" 11:45\",\n\"formated_ends_at\": \" 11:45\"\n}\n],\n\"selling_price_group\": [\n{\n\"id\": 2,\n\"variation_id\": 1,\n\"price_group_id\": 1,\n\"price_inc_tax\": \"140.0000\",\n\"created_at\": \"2020-06-09 00:23:31\",\n\"updated_at\": \"2020-06-09 00:23:31\"\n}\n]\n}\n]\n}\n],\n\"brand\": {\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"Levis\",\n\"description\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:19:47\",\n\"updated_at\": \"2018-01-03 21:19:47\"\n},\n\"unit\": {\n\"id\": 1,\n\"business_id\": 1,\n\"actual_name\": \"Pieces\",\n\"short_name\": \"Pc(s)\",\n\"allow_decimal\": 0,\n\"base_unit_id\": null,\n\"base_unit_multiplier\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 15:15:20\",\n\"updated_at\": \"2018-01-03 15:15:20\"\n},\n\"category\": {\n\"id\": 1,\n\"name\": \"Men's\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:06:34\",\n\"updated_at\": \"2018-01-03 21:06:34\"\n},\n\"sub_category\": {\n\"id\": 5,\n\"name\": \"Shirts\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 1,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:08:18\",\n\"updated_at\": \"2018-01-03 21:08:18\"\n},\n\"product_tax\": {\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"VAT@10%\",\n\"amount\": 10,\n\"is_tax_group\": 0,\n\"created_by\": 1,\n\"woocommerce_tax_rate_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:40:07\",\n\"updated_at\": \"2018-01-04 02:40:07\"\n},\n\"product_locations\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": null,\n\"name\": \"Awesome Shop\",\n\"landmark\": \"Linking Street\",\n\"country\": \"USA\",\n\"state\": \"Arizona\",\n\"city\": \"Phoenix\",\n\"zip_code\": \"85001\",\n\"invoice_scheme_id\": 1,\n\"invoice_layout_id\": 1,\n\"selling_price_group_id\": null,\n\"print_receipt_on_invoice\": 1,\n\"receipt_printer_type\": \"browser\",\n\"printer_id\": null,\n\"mobile\": null,\n\"alternate_number\": null,\n\"email\": null,\n\"website\": null,\n\"featured_products\": [\n\"5\",\n\"71\"\n],\n\"is_active\": 1,\n\"default_payment_accounts\": \"{\\\"cash\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"1\\\"},\\\"card\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"3\\\"},\\\"cheque\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"2\\\"},\\\"bank_transfer\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"1\\\"},\\\"other\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"3\\\"},\\\"custom_pay_1\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"1\\\"},\\\"custom_pay_2\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"2\\\"},\\\"custom_pay_3\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"3\\\"}}\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:20\",\n\"updated_at\": \"2020-06-09 01:07:05\",\n\"pivot\": {\n\"product_id\": 2,\n\"location_id\": 1\n}\n}]\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/product?page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/product?page=32\",\n\"prev\": null,\n\"next\": \"https:\/\/bqf.ai\/connector\/api\/product?page=2\"\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/product\",\n\"per_page\": 10,\n\"to\": 10\n}\n}", "name": "" } ] }, { "name": "Get the specified product", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/product\/:id", "query": [ { "key": "selling_price_group", "value": "quo", "description": "(1, 0)", "disabled": false }, { "key": "send_lot_detail", "value": "quibusdam", "description": "Send lot details in each variation location details(1, 0)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/product\/:id?selling_price_group=quo&send_lot_detail=quibusdam", "variable": [ { "id": "id", "key": "id", "value": "quae", "description": "The ID of the product." }, { "id": "product", "key": "product", "value": "1", "description": "comma separated ids of products" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Men's Reverse Fleece Crew\",\n\"business_id\": 1,\n\"type\": \"single\",\n\"sub_unit_ids\": null,\n\"enable_stock\": 1,\n\"alert_quantity\": \"5.0000\",\n\"sku\": \"AS0001\",\n\"barcode_type\": \"C128\",\n\"expiry_period\": null,\n\"expiry_period_type\": null,\n\"enable_sr_no\": 0,\n\"weight\": null,\n\"product_custom_field1\": null,\n\"product_custom_field2\": null,\n\"product_custom_field3\": null,\n\"product_custom_field4\": null,\n\"image\": null,\n\"woocommerce_media_id\": null,\n\"product_description\": null,\n\"created_by\": 1,\n\"warranty_id\": null,\n\"is_inactive\": 0,\n\"repair_model_id\": null,\n\"not_for_selling\": 0,\n\"ecom_shipping_class_id\": null,\n\"ecom_active_in_store\": 1,\n\"woocommerce_product_id\": 356,\n\"woocommerce_disable_sync\": 0,\n\"image_url\": \"https:\/\/bqf.ai\/img\/default.png\",\n\"product_variations\": [\n{\n\"id\": 1,\n\"variation_template_id\": null,\n\"name\": \"DUMMY\",\n\"product_id\": 1,\n\"is_dummy\": 1,\n\"created_at\": \"2018-01-03 21:29:08\",\n\"updated_at\": \"2018-01-03 21:29:08\",\n\"variations\": [\n{\n\"id\": 1,\n\"name\": \"DUMMY\",\n\"product_id\": 1,\n\"sub_sku\": \"AS0001\",\n\"product_variation_id\": 1,\n\"woocommerce_variation_id\": null,\n\"variation_value_id\": null,\n\"default_purchase_price\": \"130.0000\",\n\"dpp_inc_tax\": \"143.0000\",\n\"profit_percent\": \"0.0000\",\n\"default_sell_price\": \"130.0000\",\n\"sell_price_inc_tax\": \"143.0000\",\n\"created_at\": \"2018-01-03 21:29:08\",\n\"updated_at\": \"2020-06-09 00:23:22\",\n\"deleted_at\": null,\n\"combo_variations\": null,\n\"variation_location_details\": [\n{\n\"id\": 56,\n\"product_id\": 1,\n\"product_variation_id\": 1,\n\"variation_id\": 1,\n\"location_id\": 1,\n\"qty_available\": \"20.0000\",\n\"created_at\": \"2020-06-08 23:46:40\",\n\"updated_at\": \"2020-06-08 23:46:40\"\n}\n],\n\"media\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"file_name\": \"1591686466_978227300_nn.jpeg\",\n\"description\": null,\n\"uploaded_by\": 9,\n\"model_type\": \"App\\\\Variation\",\n\"woocommerce_media_id\": null,\n\"model_id\": 1,\n\"created_at\": \"2020-06-09 00:07:46\",\n\"updated_at\": \"2020-06-09 00:07:46\",\n\"display_name\": \"nn.jpeg\",\n\"display_url\": \"https:\/\/bqf.ai\/uploads\/media\/1591686466_978227300_nn.jpeg\"\n}\n],\n\"discounts\": [\n{\n\"id\": 2,\n\"name\": \"FLAT 10%\",\n\"business_id\": 1,\n\"brand_id\": null,\n\"category_id\": null,\n\"location_id\": 1,\n\"priority\": 2,\n\"discount_type\": \"fixed\",\n\"discount_amount\": \"5.0000\",\n\"starts_at\": \"2021-09-01 11:45:00\",\n\"ends_at\": \"2021-09-30 11:45:00\",\n\"is_active\": 1,\n\"spg\": null,\n\"applicable_in_cg\": 1,\n\"created_at\": \"2021-09-01 11:46:00\",\n\"updated_at\": \"2021-09-01 12:12:55\",\n\"formated_starts_at\": \" 11:45\",\n\"formated_ends_at\": \" 11:45\"\n}\n],\n\"selling_price_group\": [\n{\n\"id\": 2,\n\"variation_id\": 1,\n\"price_group_id\": 1,\n\"price_inc_tax\": \"140.0000\",\n\"created_at\": \"2020-06-09 00:23:31\",\n\"updated_at\": \"2020-06-09 00:23:31\"\n}\n]\n}\n]\n}\n],\n\"brand\": {\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"Levis\",\n\"description\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:19:47\",\n\"updated_at\": \"2018-01-03 21:19:47\"\n},\n\"unit\": {\n\"id\": 1,\n\"business_id\": 1,\n\"actual_name\": \"Pieces\",\n\"short_name\": \"Pc(s)\",\n\"allow_decimal\": 0,\n\"base_unit_id\": null,\n\"base_unit_multiplier\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 15:15:20\",\n\"updated_at\": \"2018-01-03 15:15:20\"\n},\n\"category\": {\n\"id\": 1,\n\"name\": \"Men's\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:06:34\",\n\"updated_at\": \"2018-01-03 21:06:34\"\n},\n\"sub_category\": {\n\"id\": 5,\n\"name\": \"Shirts\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 1,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:08:18\",\n\"updated_at\": \"2018-01-03 21:08:18\"\n},\n\"product_tax\": {\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"VAT@10%\",\n\"amount\": 10,\n\"is_tax_group\": 0,\n\"created_by\": 1,\n\"woocommerce_tax_rate_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:40:07\",\n\"updated_at\": \"2018-01-04 02:40:07\"\n},\n\"product_locations\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": null,\n\"name\": \"Awesome Shop\",\n\"landmark\": \"Linking Street\",\n\"country\": \"USA\",\n\"state\": \"Arizona\",\n\"city\": \"Phoenix\",\n\"zip_code\": \"85001\",\n\"invoice_scheme_id\": 1,\n\"invoice_layout_id\": 1,\n\"selling_price_group_id\": null,\n\"print_receipt_on_invoice\": 1,\n\"receipt_printer_type\": \"browser\",\n\"printer_id\": null,\n\"mobile\": null,\n\"alternate_number\": null,\n\"email\": null,\n\"website\": null,\n\"featured_products\": [\n\"5\",\n\"71\"\n],\n\"is_active\": 1,\n\"default_payment_accounts\": \"{\\\"cash\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"1\\\"},\\\"card\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"3\\\"},\\\"cheque\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"2\\\"},\\\"bank_transfer\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"1\\\"},\\\"other\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"3\\\"},\\\"custom_pay_1\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"1\\\"},\\\"custom_pay_2\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"2\\\"},\\\"custom_pay_3\\\":{\\\"is_enabled\\\":\\\"1\\\",\\\"account\\\":\\\"3\\\"}}\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:20\",\n\"updated_at\": \"2020-06-09 01:07:05\",\n\"pivot\": {\n\"product_id\": 2,\n\"location_id\": 1\n}\n}]\n}\n]\n}", "name": "" } ] }, { "name": "List Selling Price Group", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/selling-price-group", "query": [], "raw": "{{baseUrl}}\/connector\/api\/selling-price-group" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Retail\",\n\"description\": null,\n\"business_id\": 1,\n\"is_active\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2020-10-21 04:30:06\",\n\"updated_at\": \"2020-11-16 18:23:15\"\n},\n{\n\"id\": 2,\n\"name\": \"Wholesale\",\n\"description\": null,\n\"business_id\": 1,\n\"is_active\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2020-10-21 04:30:21\",\n\"updated_at\": \"2020-11-16 18:23:00\"\n}\n]\n}", "name": "" } ] }, { "name": "List Variations", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/variation\/:id", "query": [ { "key": "product_id", "value": "porro", "description": "Filter by comma separated products ids", "disabled": false }, { "key": "location_id", "value": "1", "description": "", "disabled": false }, { "key": "brand_id", "value": "nostrum", "description": "", "disabled": false }, { "key": "category_id", "value": "provident", "description": "", "disabled": false }, { "key": "sub_category_id", "value": "voluptates", "description": "", "disabled": false }, { "key": "not_for_selling", "value": "id", "description": "Values: 0 or 1", "disabled": false }, { "key": "name", "value": "est", "description": "Search term for product name", "disabled": false }, { "key": "sku", "value": "voluptatem", "description": "Search term for product sku", "disabled": false }, { "key": "per_page", "value": "10", "description": "Total records per page. default: 10, Set -1 for no pagination", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/variation\/:id?product_id=porro&location_id=1&brand_id=nostrum&category_id=provident&sub_category_id=voluptates¬_for_selling=id&name=est&sku=voluptatem&per_page=10", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "comma separated ids of variations" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"variation_id\": 1,\n\"variation_name\": \"\",\n\"sub_sku\": \"AS0001\",\n\"product_id\": 1,\n\"product_name\": \"Men's Reverse Fleece Crew\",\n\"sku\": \"AS0001\",\n\"type\": \"single\",\n\"business_id\": 1,\n\"barcode_type\": \"C128\",\n\"expiry_period\": null,\n\"expiry_period_type\": null,\n\"enable_sr_no\": 0,\n\"weight\": null,\n\"product_custom_field1\": null,\n\"product_custom_field2\": null,\n\"product_custom_field3\": null,\n\"product_custom_field4\": null,\n\"product_image\": \"1528728059_fleece_crew.jpg\",\n\"product_description\": null,\n\"warranty_id\": null,\n\"brand_id\": 1,\n\"brand_name\": \"Levis\",\n\"unit_id\": 1,\n\"enable_stock\": 1,\n\"not_for_selling\": 0,\n\"unit_name\": \"Pc(s)\",\n\"unit_allow_decimal\": 0,\n\"category_id\": 1,\n\"category\": \"Men's\",\n\"sub_category_id\": 5,\n\"sub_category\": \"Shirts\",\n\"tax_id\": 1,\n\"tax_type\": \"exclusive\",\n\"tax_name\": \"VAT@10%\",\n\"tax_amount\": 10,\n\"product_variation_id\": 1,\n\"default_purchase_price\": \"130.0000\",\n\"dpp_inc_tax\": \"143.0000\",\n\"profit_percent\": \"0.0000\",\n\"default_sell_price\": \"130.0000\",\n\"sell_price_inc_tax\": \"143.0000\",\n\"product_variation_name\": \"\",\n\"variation_location_details\": [],\n\"media\": [],\n\"selling_price_group\": [],\n\"product_image_url\": \"https:\/\/bqf.ai\/uploads\/img\/1528728059_fleece_crew.jpg\",\n\"product_locations\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": null,\n\"name\": \"Awesome Shop\",\n\"landmark\": \"Linking Street\",\n\"country\": \"USA\",\n\"state\": \"Arizona\",\n\"city\": \"Phoenix\",\n\"zip_code\": \"85001\",\n\"invoice_scheme_id\": 1,\n\"invoice_layout_id\": 1,\n\"selling_price_group_id\": null,\n\"print_receipt_on_invoice\": 1,\n\"receipt_printer_type\": \"browser\",\n\"printer_id\": null,\n\"mobile\": null,\n\"alternate_number\": null,\n\"email\": null,\n\"website\": null,\n\"featured_products\": null,\n\"is_active\": 1,\n\"default_payment_accounts\": \"\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:20\",\n\"updated_at\": \"2019-12-11 04:53:39\",\n\"pivot\": {\n\"product_id\": 1,\n\"location_id\": 1\n}\n}\n]\n},\n{\n\"variation_id\": 2,\n\"variation_name\": \"28\",\n\"sub_sku\": \"AS0002-1\",\n\"product_id\": 2,\n\"product_name\": \"Levis Men's Slimmy Fit Jeans\",\n\"sku\": \"AS0002\",\n\"type\": \"variable\",\n\"business_id\": 1,\n\"barcode_type\": \"C128\",\n\"expiry_period\": null,\n\"expiry_period_type\": null,\n\"enable_sr_no\": 0,\n\"weight\": null,\n\"product_custom_field1\": null,\n\"product_custom_field2\": null,\n\"product_custom_field3\": null,\n\"product_custom_field4\": null,\n\"product_image\": \"1528727964_levis_jeans.jpg\",\n\"product_description\": null,\n\"warranty_id\": null,\n\"brand_id\": 1,\n\"brand_name\": \"Levis\",\n\"unit_id\": 1,\n\"enable_stock\": 1,\n\"not_for_selling\": 0,\n\"unit_name\": \"Pc(s)\",\n\"unit_allow_decimal\": 0,\n\"category_id\": 1,\n\"category\": \"Men's\",\n\"sub_category_id\": 4,\n\"sub_category\": \"Jeans\",\n\"tax_id\": 1,\n\"tax_type\": \"exclusive\",\n\"tax_name\": \"VAT@10%\",\n\"tax_amount\": 10,\n\"product_variation_id\": 2,\n\"default_purchase_price\": \"70.0000\",\n\"dpp_inc_tax\": \"77.0000\",\n\"profit_percent\": \"0.0000\",\n\"default_sell_price\": \"70.0000\",\n\"sell_price_inc_tax\": \"77.0000\",\n\"product_variation_name\": \"Waist Size\",\n\"variation_location_details\": [\n{\n\"id\": 1,\n\"product_id\": 2,\n\"product_variation_id\": 2,\n\"variation_id\": 2,\n\"location_id\": 1,\n\"qty_available\": \"50.0000\",\n\"created_at\": \"2018-01-06 06:57:11\",\n\"updated_at\": \"2020-08-04 04:11:27\"\n}\n],\n\"media\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"file_name\": \"1596701997_743693452_test.jpg\",\n\"description\": null,\n\"uploaded_by\": 9,\n\"model_type\": \"App\\\\Variation\",\n\"woocommerce_media_id\": null,\n\"model_id\": 2,\n\"created_at\": \"2020-08-06 13:49:57\",\n\"updated_at\": \"2020-08-06 13:49:57\",\n\"display_name\": \"test.jpg\",\n\"display_url\": \"https:\/\/bqf.ai\/uploads\/media\/1596701997_743693452_test.jpg\"\n}\n],\n\"selling_price_group\": [],\n\"product_image_url\": \"https:\/\/bqf.ai\/uploads\/img\/1528727964_levis_jeans.jpg\",\n\"product_locations\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"location_id\": null,\n\"name\": \"Awesome Shop\",\n\"landmark\": \"Linking Street\",\n\"country\": \"USA\",\n\"state\": \"Arizona\",\n\"city\": \"Phoenix\",\n\"zip_code\": \"85001\",\n\"invoice_scheme_id\": 1,\n\"invoice_layout_id\": 1,\n\"selling_price_group_id\": null,\n\"print_receipt_on_invoice\": 1,\n\"receipt_printer_type\": \"browser\",\n\"printer_id\": null,\n\"mobile\": null,\n\"alternate_number\": null,\n\"email\": null,\n\"website\": null,\n\"featured_products\": null,\n\"is_active\": 1,\n\"default_payment_accounts\": \"\",\n\"custom_field1\": null,\n\"custom_field2\": null,\n\"custom_field3\": null,\n\"custom_field4\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:20\",\n\"updated_at\": \"2019-12-11 04:53:39\",\n\"pivot\": {\n\"product_id\": 2,\n\"location_id\": 1\n}\n}\n],\n\"discounts\": [\n{\n\"id\": 2,\n\"name\": \"FLAT 10%\",\n\"business_id\": 1,\n\"brand_id\": null,\n\"category_id\": null,\n\"location_id\": 1,\n\"priority\": 2,\n\"discount_type\": \"fixed\",\n\"discount_amount\": \"5.0000\",\n\"starts_at\": \"2021-09-01 11:45:00\",\n\"ends_at\": \"2021-09-30 11:45:00\",\n\"is_active\": 1,\n\"spg\": null,\n\"applicable_in_cg\": 1,\n\"created_at\": \"2021-09-01 11:46:00\",\n\"updated_at\": \"2021-09-01 12:12:55\",\n\"formated_starts_at\": \" 11:45\",\n\"formated_ends_at\": \" 11:45\"\n}\n]\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/variation?page=1\",\n\"last\": null,\n\"prev\": null,\n\"next\": \"https:\/\/bqf.ai\/connector\/api\/variation?page=2\"\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/variation\",\n\"per_page\": \"2\",\n\"to\": 2\n}\n}", "name": "" } ] } ] }, { "name": "Sales management", "description": "", "item": [ { "name": "List sells", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/sell", "query": [ { "key": "location_id", "value": "1", "description": "id of the location", "disabled": false }, { "key": "contact_id", "value": "architecto", "description": "id of the customer", "disabled": false }, { "key": "status", "value": "final", "description": "Sell status. Available values final, draft, quotation, proforma", "disabled": false }, { "key": "payment_status", "value": "due%2Cpartial", "description": "Comma separated values of payment statuses. Available values due, partial, paid, overdue", "disabled": false }, { "key": "start_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "end_date", "value": "2018-06-25", "description": "format:Y-m-d", "disabled": false }, { "key": "user_id", "value": "quo", "description": "id of the user who created the sale", "disabled": false }, { "key": "service_staff_id", "value": "quo", "description": "id of the service staff assigned with the sale", "disabled": false }, { "key": "shipping_status", "value": "ordered", "description": "Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')", "disabled": false }, { "key": "source", "value": "sit", "description": "Source of the sale", "disabled": false }, { "key": "only_subscriptions", "value": "ut", "description": "Filter only subcription invoices (1, 0)", "disabled": false }, { "key": "send_purchase_details", "value": "ut", "description": "Get purchase details of each sell line (1, 0)", "disabled": false }, { "key": "order_by_date", "value": "desc", "description": "Sort sell list by date ('asc', 'desc')", "disabled": false }, { "key": "per_page", "value": "10", "description": "Total records per page. default: 10, Set -1 for no pagination", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/sell?location_id=1&contact_id=architecto&status=final&payment_status=due%2Cpartial&start_date=2018-06-25&end_date=2018-06-25&user_id=quo&service_staff_id=quo&shipping_status=ordered&source=sit&only_subscriptions=ut&send_purchase_details=ut&order_by_date=desc&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 6,\n\"business_id\": 1,\n\"location_id\": 1,\n\"res_table_id\": null,\n\"res_waiter_id\": null,\n\"res_order_status\": null,\n\"type\": \"sell\",\n\"sub_type\": null,\n\"status\": \"final\",\n\"is_quotation\": 0,\n\"payment_status\": \"paid\",\n\"adjustment_type\": null,\n\"contact_id\": 4,\n\"customer_group_id\": null,\n\"invoice_no\": \"AS0001\",\n\"ref_no\": \"\",\n\"source\": null,\n\"subscription_no\": null,\n\"subscription_repeat_on\": null,\n\"transaction_date\": \"2018-04-10 13:23:21\",\n\"total_before_tax\": \"770.0000\",\n\"tax_id\": null,\n\"tax_amount\": \"0.0000\",\n\"discount_type\": \"percentage\",\n\"discount_amount\": \"0.0000\",\n\"rp_redeemed\": 0,\n\"rp_redeemed_amount\": \"0.0000\",\n\"shipping_details\": null,\n\"shipping_address\": null,\n\"shipping_status\": null,\n\"delivered_to\": null,\n\"shipping_charges\": \"0.0000\",\n\"additional_notes\": null,\n\"staff_note\": null,\n\"round_off_amount\": \"0.0000\",\n\"final_total\": \"770.0000\",\n\"expense_category_id\": null,\n\"expense_for\": null,\n\"commission_agent\": null,\n\"document\": null,\n\"is_direct_sale\": 0,\n\"is_suspend\": 0,\n\"exchange_rate\": \"1.000\",\n\"total_amount_recovered\": null,\n\"transfer_parent_id\": null,\n\"return_parent_id\": null,\n\"opening_stock_product_id\": null,\n\"created_by\": 1,\n\"import_batch\": null,\n\"import_time\": null,\n\"types_of_service_id\": null,\n\"packing_charge\": null,\n\"packing_charge_type\": null,\n\"service_custom_field_1\": null,\n\"service_custom_field_2\": null,\n\"service_custom_field_3\": null,\n\"service_custom_field_4\": null,\n\"mfg_parent_production_purchase_id\": null,\n\"mfg_wasted_units\": null,\n\"mfg_production_cost\": \"0.0000\",\n\"mfg_is_final\": 0,\n\"is_created_from_api\": 0,\n\"essentials_duration\": \"0.00\",\n\"essentials_duration_unit\": null,\n\"essentials_amount_per_unit_duration\": \"0.0000\",\n\"essentials_allowances\": null,\n\"essentials_deductions\": null,\n\"rp_earned\": 0,\n\"repair_completed_on\": null,\n\"repair_warranty_id\": null,\n\"repair_brand_id\": null,\n\"repair_status_id\": null,\n\"repair_model_id\": null,\n\"repair_defects\": null,\n\"repair_serial_no\": null,\n\"repair_updates_email\": 0,\n\"repair_updates_sms\": 0,\n\"repair_checklist\": null,\n\"repair_security_pwd\": null,\n\"repair_security_pattern\": null,\n\"repair_due_date\": null,\n\"repair_device_id\": null,\n\"order_addresses\": null,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": null,\n\"recur_repetitions\": null,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"invoice_token\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"pjt_project_id\": null,\n\"pjt_title\": null,\n\"woocommerce_order_id\": null,\n\"selling_price_group_id\": null,\n\"created_at\": \"2018-01-06 07:06:11\",\n\"updated_at\": \"2018-01-06 07:06:11\",\n\"sell_lines\": [\n{\n\"id\": 1,\n\"transaction_id\": 6,\n\"product_id\": 2,\n\"variation_id\": 3,\n\"quantity\": 10,\n\"mfg_waste_percent\": \"0.0000\",\n\"quantity_returned\": \"0.0000\",\n\"unit_price_before_discount\": \"70.0000\",\n\"unit_price\": \"70.0000\",\n\"line_discount_type\": null,\n\"line_discount_amount\": \"0.0000\",\n\"unit_price_inc_tax\": \"77.0000\",\n\"item_tax\": \"7.0000\",\n\"tax_id\": 1,\n\"discount_id\": null,\n\"lot_no_line_id\": null,\n\"sell_line_note\": null,\n\"res_service_staff_id\": null,\n\"res_line_order_status\": null,\n\"woocommerce_line_items_id\": null,\n\"parent_sell_line_id\": null,\n\"children_type\": \"\",\n\"sub_unit_id\": null,\n\"created_at\": \"2018-01-06 07:06:11\",\n\"updated_at\": \"2018-01-06 07:06:11\"\n}\n],\n\"payment_lines\": [\n{\n\"id\": 1,\n\"transaction_id\": 6,\n\"business_id\": null,\n\"is_return\": 0,\n\"amount\": \"770.0000\",\n\"method\": \"cash\",\n\"transaction_no\": null,\n\"card_transaction_number\": null,\n\"card_number\": null,\n\"card_type\": \"visa\",\n\"card_holder_name\": null,\n\"card_month\": null,\n\"card_year\": null,\n\"card_security\": null,\n\"cheque_number\": null,\n\"bank_account_number\": null,\n\"paid_on\": \"2018-01-09 17:30:35\",\n\"created_by\": 1,\n\"payment_for\": null,\n\"parent_id\": null,\n\"note\": null,\n\"document\": null,\n\"payment_ref_no\": null,\n\"account_id\": null,\n\"created_at\": \"2018-01-06 01:36:11\",\n\"updated_at\": \"2018-01-06 01:36:11\"\n}\n],\n\"invoice_url\": \"https:\/\/bqf.ai\/invoice\/6dfd77eb80f4976b456128e7f1311c9f\",\n\"payment_link\": \"https:\/\/bqf.ai\/pay\/6dfd77eb80f4976b456128e7f1311c9f\"\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/sell?page=1\",\n\"last\": \"https:\/\/bqf.ai\/connector\/api\/sell?page=6\",\n\"prev\": null,\n\"next\": \"https:\/\/bqf.ai\/connector\/api\/sell?page=2\"\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/sell\",\n\"per_page\": 10,\n\"to\": 10\n}\n}", "name": "" } ] }, { "name": "Create sell", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/sell", "query": [], "raw": "{{baseUrl}}\/connector\/api\/sell" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 6,\n\"business_id\": 1,\n\"location_id\": 1,\n\"res_table_id\": null,\n\"res_waiter_id\": null,\n\"res_order_status\": null,\n\"type\": \"sell\",\n\"sub_type\": null,\n\"status\": \"final\",\n\"is_quotation\": 0,\n\"payment_status\": \"paid\",\n\"adjustment_type\": null,\n\"contact_id\": 4,\n\"customer_group_id\": null,\n\"invoice_no\": \"AS0001\",\n\"ref_no\": \"\",\n\"source\": null,\n\"subscription_no\": null,\n\"subscription_repeat_on\": null,\n\"transaction_date\": \"2018-04-10 13:23:21\",\n\"total_before_tax\": \"770.0000\",\n\"tax_id\": null,\n\"tax_amount\": \"0.0000\",\n\"discount_type\": \"percentage\",\n\"discount_amount\": \"0.0000\",\n\"rp_redeemed\": 0,\n\"rp_redeemed_amount\": \"0.0000\",\n\"shipping_details\": null,\n\"shipping_address\": null,\n\"shipping_status\": null,\n\"delivered_to\": null,\n\"shipping_charges\": \"0.0000\",\n\"additional_notes\": null,\n\"staff_note\": null,\n\"round_off_amount\": \"0.0000\",\n\"final_total\": \"770.0000\",\n\"expense_category_id\": null,\n\"expense_for\": null,\n\"commission_agent\": null,\n\"document\": null,\n\"is_direct_sale\": 0,\n\"is_suspend\": 0,\n\"exchange_rate\": \"1.000\",\n\"total_amount_recovered\": null,\n\"transfer_parent_id\": null,\n\"return_parent_id\": null,\n\"opening_stock_product_id\": null,\n\"created_by\": 1,\n\"import_batch\": null,\n\"import_time\": null,\n\"types_of_service_id\": null,\n\"packing_charge\": null,\n\"packing_charge_type\": null,\n\"service_custom_field_1\": null,\n\"service_custom_field_2\": null,\n\"service_custom_field_3\": null,\n\"service_custom_field_4\": null,\n\"mfg_parent_production_purchase_id\": null,\n\"mfg_wasted_units\": null,\n\"mfg_production_cost\": \"0.0000\",\n\"mfg_is_final\": 0,\n\"is_created_from_api\": 0,\n\"essentials_duration\": \"0.00\",\n\"essentials_duration_unit\": null,\n\"essentials_amount_per_unit_duration\": \"0.0000\",\n\"essentials_allowances\": null,\n\"essentials_deductions\": null,\n\"rp_earned\": 0,\n\"repair_completed_on\": null,\n\"repair_warranty_id\": null,\n\"repair_brand_id\": null,\n\"repair_status_id\": null,\n\"repair_model_id\": null,\n\"repair_defects\": null,\n\"repair_serial_no\": null,\n\"repair_updates_email\": 0,\n\"repair_updates_sms\": 0,\n\"repair_checklist\": null,\n\"repair_security_pwd\": null,\n\"repair_security_pattern\": null,\n\"repair_due_date\": null,\n\"repair_device_id\": null,\n\"order_addresses\": null,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": null,\n\"recur_repetitions\": null,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"invoice_token\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"pjt_project_id\": null,\n\"pjt_title\": null,\n\"woocommerce_order_id\": null,\n\"selling_price_group_id\": null,\n\"created_at\": \"2018-01-06 07:06:11\",\n\"updated_at\": \"2018-01-06 07:06:11\",\n\"invoice_url\": \"https:\/\/bqf.ai\/invoice\/6dfd77eb80f4976b456128e7f1311c9f\",\n\"payment_link\": \"https:\/\/bqf.ai\/pay\/6dfd77eb80f4976b456128e7f1311c9f\",\n\"sell_lines\": [\n{\n\"id\": 1,\n\"transaction_id\": 6,\n\"product_id\": 2,\n\"variation_id\": 3,\n\"quantity\": 10,\n\"mfg_waste_percent\": \"0.0000\",\n\"quantity_returned\": \"0.0000\",\n\"unit_price_before_discount\": \"70.0000\",\n\"unit_price\": \"70.0000\",\n\"line_discount_type\": null,\n\"line_discount_amount\": \"0.0000\",\n\"unit_price_inc_tax\": \"77.0000\",\n\"item_tax\": \"7.0000\",\n\"tax_id\": 1,\n\"discount_id\": null,\n\"lot_no_line_id\": null,\n\"sell_line_note\": null,\n\"res_service_staff_id\": null,\n\"res_line_order_status\": null,\n\"woocommerce_line_items_id\": null,\n\"parent_sell_line_id\": null,\n\"children_type\": \"\",\n\"sub_unit_id\": null,\n\"created_at\": \"2018-01-06 07:06:11\",\n\"updated_at\": \"2018-01-06 07:06:11\"\n}\n],\n\"payment_lines\": [\n{\n\"id\": 1,\n\"transaction_id\": 6,\n\"business_id\": null,\n\"is_return\": 0,\n\"amount\": \"770.0000\",\n\"method\": \"cash\",\n\"transaction_no\": null,\n\"card_transaction_number\": null,\n\"card_number\": null,\n\"card_type\": \"visa\",\n\"card_holder_name\": null,\n\"card_month\": null,\n\"card_year\": null,\n\"card_security\": null,\n\"cheque_number\": null,\n\"bank_account_number\": null,\n\"paid_on\": \"2018-01-09 17:30:35\",\n\"created_by\": 1,\n\"payment_for\": null,\n\"parent_id\": null,\n\"note\": null,\n\"document\": null,\n\"payment_ref_no\": null,\n\"account_id\": null,\n\"created_at\": \"2018-01-06 01:36:11\",\n\"updated_at\": \"2018-01-06 01:36:11\"\n}\n]\n}\n]\n}", "name": "" } ] }, { "name": "Get the specified sell", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/sell\/:id", "query": [ { "key": "send_purchase_details", "value": "consectetur", "description": "Get purchase details of each sell line (1, 0)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/sell\/:id?send_purchase_details=consectetur", "variable": [ { "id": "id", "key": "id", "value": "similique", "description": "The ID of the sell." }, { "id": "sell", "key": "sell", "value": "55", "description": "comma separated ids of the sells" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 55,\n\"business_id\": 1,\n\"location_id\": 1,\n\"res_table_id\": 5,\n\"res_waiter_id\": null,\n\"res_order_status\": null,\n\"type\": \"sell\",\n\"sub_type\": null,\n\"status\": \"final\",\n\"is_quotation\": 0,\n\"payment_status\": \"paid\",\n\"adjustment_type\": null,\n\"contact_id\": 1,\n\"customer_group_id\": null,\n\"invoice_no\": \"AS0007\",\n\"ref_no\": \"\",\n\"source\": null,\n\"subscription_no\": null,\n\"subscription_repeat_on\": null,\n\"transaction_date\": \"2020-06-04 23:29:36\",\n\"total_before_tax\": \"437.5000\",\n\"tax_id\": 1,\n\"tax_amount\": \"39.3750\",\n\"discount_type\": \"percentage\",\n\"discount_amount\": \"10.0000\",\n\"rp_redeemed\": 0,\n\"rp_redeemed_amount\": \"0.0000\",\n\"shipping_details\": \"Express Delivery\",\n\"shipping_address\": null,\n\"shipping_status\": \"ordered\",\n\"delivered_to\": \"Mr Robin\",\n\"shipping_charges\": \"10.0000\",\n\"additional_notes\": null,\n\"staff_note\": null,\n\"round_off_amount\": \"0.0000\",\n\"final_total\": \"453.1300\",\n\"expense_category_id\": null,\n\"expense_for\": null,\n\"commission_agent\": null,\n\"document\": null,\n\"is_direct_sale\": 0,\n\"is_suspend\": 0,\n\"exchange_rate\": \"1.000\",\n\"total_amount_recovered\": null,\n\"transfer_parent_id\": null,\n\"return_parent_id\": null,\n\"opening_stock_product_id\": null,\n\"created_by\": 9,\n\"import_batch\": null,\n\"import_time\": null,\n\"types_of_service_id\": 1,\n\"packing_charge\": \"10.0000\",\n\"packing_charge_type\": \"fixed\",\n\"service_custom_field_1\": null,\n\"service_custom_field_2\": null,\n\"service_custom_field_3\": null,\n\"service_custom_field_4\": null,\n\"mfg_parent_production_purchase_id\": null,\n\"mfg_wasted_units\": null,\n\"mfg_production_cost\": \"0.0000\",\n\"mfg_is_final\": 0,\n\"is_created_from_api\": 0,\n\"essentials_duration\": \"0.00\",\n\"essentials_duration_unit\": null,\n\"essentials_amount_per_unit_duration\": \"0.0000\",\n\"essentials_allowances\": null,\n\"essentials_deductions\": null,\n\"rp_earned\": 0,\n\"repair_completed_on\": null,\n\"repair_warranty_id\": null,\n\"repair_brand_id\": null,\n\"repair_status_id\": null,\n\"repair_model_id\": null,\n\"repair_defects\": null,\n\"repair_serial_no\": null,\n\"repair_updates_email\": 0,\n\"repair_updates_sms\": 0,\n\"repair_checklist\": null,\n\"repair_security_pwd\": null,\n\"repair_security_pattern\": null,\n\"repair_due_date\": null,\n\"repair_device_id\": null,\n\"order_addresses\": null,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": \"days\",\n\"recur_repetitions\": 0,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"invoice_token\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"pjt_project_id\": null,\n\"pjt_title\": null,\n\"woocommerce_order_id\": null,\n\"selling_price_group_id\": 0,\n\"created_at\": \"2020-06-04 23:29:36\",\n\"updated_at\": \"2020-06-04 23:29:36\",\n\"sell_lines\": [\n{\n\"id\": 38,\n\"transaction_id\": 55,\n\"product_id\": 17,\n\"variation_id\": 58,\n\"quantity\": 1,\n\"mfg_waste_percent\": \"0.0000\",\n\"quantity_returned\": \"0.0000\",\n\"unit_price_before_discount\": \"437.5000\",\n\"unit_price\": \"437.5000\",\n\"line_discount_type\": \"fixed\",\n\"line_discount_amount\": \"0.0000\",\n\"unit_price_inc_tax\": \"437.5000\",\n\"item_tax\": \"0.0000\",\n\"tax_id\": null,\n\"discount_id\": null,\n\"lot_no_line_id\": null,\n\"sell_line_note\": \"\",\n\"res_service_staff_id\": null,\n\"res_line_order_status\": null,\n\"woocommerce_line_items_id\": null,\n\"parent_sell_line_id\": null,\n\"children_type\": \"\",\n\"sub_unit_id\": null,\n\"created_at\": \"2020-06-04 23:29:36\",\n\"updated_at\": \"2020-06-04 23:29:36\"\n}\n],\n\"payment_lines\": [\n{\n\"id\": 37,\n\"transaction_id\": 55,\n\"business_id\": 1,\n\"is_return\": 0,\n\"amount\": \"453.1300\",\n\"method\": \"cash\",\n\"transaction_no\": null,\n\"card_transaction_number\": null,\n\"card_number\": null,\n\"card_type\": \"credit\",\n\"card_holder_name\": null,\n\"card_month\": null,\n\"card_year\": null,\n\"card_security\": null,\n\"cheque_number\": null,\n\"bank_account_number\": null,\n\"paid_on\": \"2020-06-04 23:29:36\",\n\"created_by\": 9,\n\"payment_for\": 1,\n\"parent_id\": null,\n\"note\": null,\n\"document\": null,\n\"payment_ref_no\": \"SP2020\/0002\",\n\"account_id\": null,\n\"created_at\": \"2020-06-04 23:29:36\",\n\"updated_at\": \"2020-06-04 23:29:36\"\n}\n],\n\n\"invoice_url\": \"https:\/\/bqf.ai\/invoice\/6dfd77eb80f4976b456128e7f1311c9f\",\n\"payment_link\": \"https:\/\/bqf.ai\/pay\/6dfd77eb80f4976b456128e7f1311c9f\"\n}\n]\n}", "name": "" } ] }, { "name": "Update sell", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/sell\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/sell\/:id", "variable": [ { "id": "id", "key": "id", "value": "ea", "description": "The ID of the sell." }, { "id": "sell", "key": "sell", "value": "6", "description": "id of sell to update" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":18,\"customer_mobile\":\"odio\",\"transaction_date\":\"2020-5-7 15:20:22\",\"status\":\"final\",\"sub_status\":\"null\",\"is_quotation\":true,\"tax_rate_id\":16,\"discount_amount\":10,\"discount_type\":\"fixed\",\"sale_note\":\"rerum\",\"source\":\"inventore\",\"staff_note\":\"ut\",\"is_suspend\":false,\"commission_agent\":17,\"shipping_details\":\"Express Delivery\",\"shipping_address\":\"illo\",\"shipping_status\":\"ordered\",\"delivered_to\":\"Mr Robin\",\"shipping_charges\":10,\"packing_charge\":10,\"exchange_rate\":1,\"selling_price_group_id\":2,\"pay_term_number\":14,\"pay_term_type\":\"months\",\"is_recurring\":0,\"recur_interval\":15,\"recur_interval_type\":\"days\",\"subscription_repeat_on\":7,\"subscription_no\":\"autem\",\"recur_repetitions\":11,\"rp_redeemed\":9,\"rp_redeemed_amount\":13.5,\"types_of_service_id\":15,\"service_custom_field_1\":\"cumque\",\"service_custom_field_2\":\"explicabo\",\"service_custom_field_3\":\"occaecati\",\"service_custom_field_4\":\"corrupti\",\"service_custom_field_5\":\"voluptatem\",\"service_custom_field_6\":\"molestiae\",\"round_off_amount\":10811027.1,\"table_id\":8,\"service_staff_id\":9,\"change_return\":0,\"change_return_id\":3,\"products\":[\"rerum\"],\"payments\":[\"sunt\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"id\": 91,\n\"business_id\": 1,\n\"location_id\": 1,\n\"res_table_id\": null,\n\"res_waiter_id\": null,\n\"res_order_status\": null,\n\"type\": \"sell\",\n\"sub_type\": null,\n\"status\": \"final\",\n\"is_quotation\": 0,\n\"payment_status\": \"paid\",\n\"adjustment_type\": null,\n\"contact_id\": 1,\n\"customer_group_id\": 1,\n\"invoice_no\": \"AS0020\",\n\"ref_no\": \"\",\n\"source\": null,\n\"subscription_no\": null,\n\"subscription_repeat_on\": null,\n\"transaction_date\": \"25-09-2020 15:22\",\n\"total_before_tax\": 962.5,\n\"tax_id\": null,\n\"tax_amount\": 0,\n\"discount_type\": \"fixed\",\n\"discount_amount\": \"19.5000\",\n\"rp_redeemed\": 0,\n\"rp_redeemed_amount\": \"0.0000\",\n\"shipping_details\": null,\n\"shipping_address\": null,\n\"shipping_status\": null,\n\"delivered_to\": null,\n\"shipping_charges\": \"0.0000\",\n\"additional_notes\": null,\n\"staff_note\": null,\n\"round_off_amount\": \"0.0000\",\n\"final_total\": 943,\n\"expense_category_id\": null,\n\"expense_for\": null,\n\"commission_agent\": null,\n\"document\": null,\n\"is_direct_sale\": 0,\n\"is_suspend\": 0,\n\"exchange_rate\": \"1.000\",\n\"total_amount_recovered\": null,\n\"transfer_parent_id\": null,\n\"return_parent_id\": null,\n\"opening_stock_product_id\": null,\n\"created_by\": 9,\n\"import_batch\": null,\n\"import_time\": null,\n\"types_of_service_id\": null,\n\"packing_charge\": \"0.0000\",\n\"packing_charge_type\": null,\n\"service_custom_field_1\": null,\n\"service_custom_field_2\": null,\n\"service_custom_field_3\": null,\n\"service_custom_field_4\": null,\n\"mfg_parent_production_purchase_id\": null,\n\"mfg_wasted_units\": null,\n\"mfg_production_cost\": \"0.0000\",\n\"mfg_production_cost_type\": \"percentage\",\n\"mfg_is_final\": 0,\n\"is_created_from_api\": 0,\n\"essentials_duration\": \"0.00\",\n\"essentials_duration_unit\": null,\n\"essentials_amount_per_unit_duration\": \"0.0000\",\n\"essentials_allowances\": null,\n\"essentials_deductions\": null,\n\"rp_earned\": 0,\n\"repair_completed_on\": null,\n\"repair_warranty_id\": null,\n\"repair_brand_id\": null,\n\"repair_status_id\": null,\n\"repair_model_id\": null,\n\"repair_job_sheet_id\": null,\n\"repair_defects\": null,\n\"repair_serial_no\": null,\n\"repair_checklist\": null,\n\"repair_security_pwd\": null,\n\"repair_security_pattern\": null,\n\"repair_due_date\": null,\n\"repair_device_id\": null,\n\"repair_updates_notif\": 0,\n\"order_addresses\": null,\n\"is_recurring\": 0,\n\"recur_interval\": 1,\n\"recur_interval_type\": \"days\",\n\"recur_repetitions\": 0,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"invoice_token\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"pjt_project_id\": null,\n\"pjt_title\": null,\n\"woocommerce_order_id\": null,\n\"selling_price_group_id\": 0,\n\"created_at\": \"2020-09-23 20:16:19\",\n\"updated_at\": \"2020-09-25 17:57:08\",\n\"payment_lines\": [\n{\n\"id\": 55,\n\"transaction_id\": 91,\n\"business_id\": 1,\n\"is_return\": 0,\n\"amount\": \"461.7500\",\n\"method\": \"cash\",\n\"transaction_no\": null,\n\"card_transaction_number\": null,\n\"card_number\": null,\n\"card_type\": \"credit\",\n\"card_holder_name\": null,\n\"card_month\": null,\n\"card_year\": null,\n\"card_security\": null,\n\"cheque_number\": null,\n\"bank_account_number\": null,\n\"paid_on\": \"2020-09-23 20:16:19\",\n\"created_by\": 9,\n\"is_advance\": 0,\n\"payment_for\": 1,\n\"parent_id\": null,\n\"note\": null,\n\"document\": null,\n\"payment_ref_no\": \"SP2020\/0018\",\n\"account_id\": null,\n\"created_at\": \"2020-09-23 20:16:19\",\n\"updated_at\": \"2020-09-23 20:16:19\"\n}\n],\n\"invoice_url\": \"https:\/\/bqf.ai\/invoice\/6dfd77eb80f4976b456128e7f1311c9f\",\n\"payment_link\": \"https:\/\/bqf.ai\/pay\/6dfd77eb80f4976b456128e7f1311c9f\"\n}", "name": "" } ] }, { "name": "Delete Sell", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/sell\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/sell\/:id", "variable": [ { "id": "id", "key": "id", "value": "provident", "description": "The ID of the sell." }, { "id": "sell", "key": "sell", "value": "dolorem", "description": "id of the sell to be deleted" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add Sell Return", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/sell-return", "query": [], "raw": "{{baseUrl}}\/connector\/api\/sell-return" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"transaction_id\":13,\"transaction_date\":\"2020-5-7 15:20:22\",\"invoice_no\":\"possimus\",\"discount_type\":\"fixed\",\"discount_amount\":10,\"tax_id\":8,\"return_settlement\":\"perferendis\",\"products\":[\"et\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"id\": 159,\n\"business_id\": 1,\n\"location_id\": 1,\n\"res_table_id\": null,\n\"res_waiter_id\": null,\n\"res_order_status\": null,\n\"type\": \"sell_return\",\n\"sub_type\": null,\n\"status\": \"final\",\n\"is_quotation\": 0,\n\"payment_status\": \"paid\",\n\"adjustment_type\": null,\n\"contact_id\": 1,\n\"customer_group_id\": null,\n\"invoice_no\": \"CN2020\/0005\",\n\"ref_no\": null,\n\"subscription_no\": null,\n\"subscription_repeat_on\": null,\n\"transaction_date\": \"2020-11-17 00:00:00\",\n\"total_before_tax\": 3,\n\"tax_id\": null,\n\"tax_amount\": 0,\n\"discount_type\": \"percentage\",\n\"discount_amount\": 12,\n\"rp_redeemed\": 0,\n\"rp_redeemed_amount\": \"0.0000\",\n\"shipping_details\": null,\n\"shipping_address\": null,\n\"shipping_status\": null,\n\"delivered_to\": null,\n\"shipping_charges\": \"0.0000\",\n\"additional_notes\": null,\n\"staff_note\": null,\n\"round_off_amount\": \"0.0000\",\n\"final_total\": 2.64,\n\"expense_category_id\": null,\n\"expense_for\": null,\n\"commission_agent\": null,\n\"document\": null,\n\"is_direct_sale\": 0,\n\"is_suspend\": 0,\n\"exchange_rate\": \"1.000\",\n\"total_amount_recovered\": null,\n\"transfer_parent_id\": null,\n\"return_parent_id\": 157,\n\"opening_stock_product_id\": null,\n\"created_by\": 9,\n\"import_batch\": null,\n\"import_time\": null,\n\"types_of_service_id\": null,\n\"packing_charge\": null,\n\"packing_charge_type\": null,\n\"service_custom_field_1\": null,\n\"service_custom_field_2\": null,\n\"service_custom_field_3\": null,\n\"service_custom_field_4\": null,\n\"mfg_parent_production_purchase_id\": null,\n\"mfg_wasted_units\": null,\n\"mfg_production_cost\": \"0.0000\",\n\"mfg_production_cost_type\": \"percentage\",\n\"mfg_is_final\": 0,\n\"is_created_from_api\": 0,\n\"essentials_duration\": \"0.00\",\n\"essentials_duration_unit\": null,\n\"essentials_amount_per_unit_duration\": \"0.0000\",\n\"essentials_allowances\": null,\n\"essentials_deductions\": null,\n\"rp_earned\": 0,\n\"repair_completed_on\": null,\n\"repair_warranty_id\": null,\n\"repair_brand_id\": null,\n\"repair_status_id\": null,\n\"repair_model_id\": null,\n\"repair_job_sheet_id\": null,\n\"repair_defects\": null,\n\"repair_serial_no\": null,\n\"repair_checklist\": null,\n\"repair_security_pwd\": null,\n\"repair_security_pattern\": null,\n\"repair_due_date\": null,\n\"repair_device_id\": null,\n\"repair_updates_notif\": 0,\n\"order_addresses\": null,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": null,\n\"recur_repetitions\": null,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"invoice_token\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"pjt_project_id\": null,\n\"pjt_title\": null,\n\"woocommerce_order_id\": null,\n\"selling_price_group_id\": null,\n\"created_at\": \"2020-11-17 12:05:11\",\n\"updated_at\": \"2020-11-17 13:22:09\"\n}", "name": "" } ] }, { "name": "List Sell Return", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/list-sell-return", "query": [], "raw": "{{baseUrl}}\/connector\/api\/list-sell-return", "variable": [ { "id": "sell_id", "key": "sell_id", "value": "ullam", "description": "Id of the sell for which return is added" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 159,\n\"business_id\": 1,\n\"location_id\": 1,\n\"res_table_id\": null,\n\"res_waiter_id\": null,\n\"res_order_status\": null,\n\"type\": \"sell_return\",\n\"sub_type\": null,\n\"status\": \"final\",\n\"is_quotation\": 0,\n\"payment_status\": \"partial\",\n\"adjustment_type\": null,\n\"contact_id\": 1,\n\"customer_group_id\": null,\n\"invoice_no\": \"CN2020\/0005\",\n\"ref_no\": null,\n\"subscription_no\": null,\n\"subscription_repeat_on\": null,\n\"transaction_date\": \"2020-11-17 00:00:00\",\n\"total_before_tax\": \"3.0000\",\n\"tax_id\": null,\n\"tax_amount\": \"0.0000\",\n\"discount_type\": \"percentage\",\n\"discount_amount\": \"12.0000\",\n\"rp_redeemed\": 0,\n\"rp_redeemed_amount\": \"0.0000\",\n\"shipping_details\": null,\n\"shipping_address\": null,\n\"shipping_status\": null,\n\"delivered_to\": null,\n\"shipping_charges\": \"0.0000\",\n\"additional_notes\": null,\n\"staff_note\": null,\n\"round_off_amount\": \"0.0000\",\n\"final_total\": \"2.6400\",\n\"expense_category_id\": null,\n\"expense_for\": null,\n\"commission_agent\": null,\n\"document\": null,\n\"is_direct_sale\": 0,\n\"is_suspend\": 0,\n\"exchange_rate\": \"1.000\",\n\"total_amount_recovered\": null,\n\"transfer_parent_id\": null,\n\"return_parent_id\": 157,\n\"opening_stock_product_id\": null,\n\"created_by\": 9,\n\"import_batch\": null,\n\"import_time\": null,\n\"types_of_service_id\": null,\n\"packing_charge\": null,\n\"packing_charge_type\": null,\n\"service_custom_field_1\": null,\n\"service_custom_field_2\": null,\n\"service_custom_field_3\": null,\n\"service_custom_field_4\": null,\n\"mfg_parent_production_purchase_id\": null,\n\"mfg_wasted_units\": null,\n\"mfg_production_cost\": \"0.0000\",\n\"mfg_production_cost_type\": \"percentage\",\n\"mfg_is_final\": 0,\n\"is_created_from_api\": 0,\n\"essentials_duration\": \"0.00\",\n\"essentials_duration_unit\": null,\n\"essentials_amount_per_unit_duration\": \"0.0000\",\n\"essentials_allowances\": null,\n\"essentials_deductions\": null,\n\"rp_earned\": 0,\n\"repair_completed_on\": null,\n\"repair_warranty_id\": null,\n\"repair_brand_id\": null,\n\"repair_status_id\": null,\n\"repair_model_id\": null,\n\"repair_job_sheet_id\": null,\n\"repair_defects\": null,\n\"repair_serial_no\": null,\n\"repair_checklist\": null,\n\"repair_security_pwd\": null,\n\"repair_security_pattern\": null,\n\"repair_due_date\": null,\n\"repair_device_id\": null,\n\"repair_updates_notif\": 0,\n\"order_addresses\": null,\n\"is_recurring\": 0,\n\"recur_interval\": null,\n\"recur_interval_type\": null,\n\"recur_repetitions\": null,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"invoice_token\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"pjt_project_id\": null,\n\"pjt_title\": null,\n\"woocommerce_order_id\": null,\n\"selling_price_group_id\": null,\n\"created_at\": \"2020-11-17 12:05:11\",\n\"updated_at\": \"2020-11-17 13:22:09\",\n\"payment_lines\": [\n{\n\"id\": 126,\n\"transaction_id\": 159,\n\"business_id\": 1,\n\"is_return\": 0,\n\"amount\": \"1.8000\",\n\"method\": \"cash\",\n\"transaction_no\": null,\n\"card_transaction_number\": null,\n\"card_number\": null,\n\"card_type\": \"credit\",\n\"card_holder_name\": null,\n\"card_month\": null,\n\"card_year\": null,\n\"card_security\": null,\n\"cheque_number\": null,\n\"bank_account_number\": null,\n\"paid_on\": \"2020-11-17 12:05:00\",\n\"created_by\": 9,\n\"is_advance\": 0,\n\"payment_for\": 1,\n\"parent_id\": null,\n\"note\": null,\n\"document\": null,\n\"payment_ref_no\": \"SP2020\/0078\",\n\"account_id\": null,\n\"created_at\": \"2020-11-17 12:05:58\",\n\"updated_at\": \"2020-11-17 12:05:58\"\n}\n],\n\"return_parent_sell\": {\n\"id\": 157,\n\"business_id\": 1,\n\"location_id\": 1,\n\"res_table_id\": null,\n\"res_waiter_id\": null,\n\"res_order_status\": null,\n\"type\": \"sell\",\n\"sub_type\": null,\n\"status\": \"final\",\n\"is_quotation\": 0,\n\"payment_status\": \"paid\",\n\"adjustment_type\": null,\n\"contact_id\": 1,\n\"customer_group_id\": null,\n\"invoice_no\": \"AS0073\",\n\"ref_no\": \"\",\n\"subscription_no\": null,\n\"subscription_repeat_on\": null,\n\"transaction_date\": \"2020-11-13 12:42:17\",\n\"total_before_tax\": \"6.2500\",\n\"tax_id\": null,\n\"tax_amount\": \"0.0000\",\n\"discount_type\": \"percentage\",\n\"discount_amount\": \"10.0000\",\n\"rp_redeemed\": 0,\n\"rp_redeemed_amount\": \"0.0000\",\n\"shipping_details\": null,\n\"shipping_address\": null,\n\"shipping_status\": null,\n\"delivered_to\": null,\n\"shipping_charges\": \"0.0000\",\n\"additional_notes\": null,\n\"staff_note\": null,\n\"round_off_amount\": \"0.0000\",\n\"final_total\": \"5.6300\",\n\"expense_category_id\": null,\n\"expense_for\": null,\n\"commission_agent\": null,\n\"document\": null,\n\"is_direct_sale\": 0,\n\"is_suspend\": 0,\n\"exchange_rate\": \"1.000\",\n\"total_amount_recovered\": null,\n\"transfer_parent_id\": null,\n\"return_parent_id\": null,\n\"opening_stock_product_id\": null,\n\"created_by\": 9,\n\"import_batch\": null,\n\"import_time\": null,\n\"types_of_service_id\": null,\n\"packing_charge\": \"0.0000\",\n\"packing_charge_type\": null,\n\"service_custom_field_1\": null,\n\"service_custom_field_2\": null,\n\"service_custom_field_3\": null,\n\"service_custom_field_4\": null,\n\"mfg_parent_production_purchase_id\": null,\n\"mfg_wasted_units\": null,\n\"mfg_production_cost\": \"0.0000\",\n\"mfg_production_cost_type\": \"percentage\",\n\"mfg_is_final\": 0,\n\"is_created_from_api\": 0,\n\"essentials_duration\": \"0.00\",\n\"essentials_duration_unit\": null,\n\"essentials_amount_per_unit_duration\": \"0.0000\",\n\"essentials_allowances\": null,\n\"essentials_deductions\": null,\n\"rp_earned\": 0,\n\"repair_completed_on\": null,\n\"repair_warranty_id\": null,\n\"repair_brand_id\": null,\n\"repair_status_id\": null,\n\"repair_model_id\": null,\n\"repair_job_sheet_id\": null,\n\"repair_defects\": null,\n\"repair_serial_no\": null,\n\"repair_checklist\": null,\n\"repair_security_pwd\": null,\n\"repair_security_pattern\": null,\n\"repair_due_date\": null,\n\"repair_device_id\": null,\n\"repair_updates_notif\": 0,\n\"order_addresses\": null,\n\"is_recurring\": 0,\n\"recur_interval\": 1,\n\"recur_interval_type\": \"days\",\n\"recur_repetitions\": 0,\n\"recur_stopped_on\": null,\n\"recur_parent_id\": null,\n\"invoice_token\": null,\n\"pay_term_number\": null,\n\"pay_term_type\": null,\n\"pjt_project_id\": null,\n\"pjt_title\": null,\n\"woocommerce_order_id\": null,\n\"selling_price_group_id\": 0,\n\"created_at\": \"2020-11-13 12:42:17\",\n\"updated_at\": \"2020-11-13 12:42:18\",\n\"sell_lines\": [\n{\n\"id\": 139,\n\"transaction_id\": 157,\n\"product_id\": 157,\n\"variation_id\": 205,\n\"quantity\": 5,\n\"mfg_waste_percent\": \"0.0000\",\n\"quantity_returned\": \"3.0000\",\n\"unit_price_before_discount\": \"1.2500\",\n\"unit_price\": \"1.2500\",\n\"line_discount_type\": \"fixed\",\n\"line_discount_amount\": \"0.0000\",\n\"unit_price_inc_tax\": \"1.2500\",\n\"item_tax\": \"0.0000\",\n\"tax_id\": null,\n\"discount_id\": null,\n\"lot_no_line_id\": null,\n\"sell_line_note\": \"\",\n\"res_service_staff_id\": null,\n\"res_line_order_status\": null,\n\"woocommerce_line_items_id\": null,\n\"parent_sell_line_id\": null,\n\"children_type\": \"\",\n\"sub_unit_id\": null,\n\"created_at\": \"2020-11-13 12:42:17\",\n\"updated_at\": \"2020-11-17 13:22:09\"\n}\n]\n}\n}\n],\n\"links\": {\n\"first\": \"https:\/\/bqf.ai\/connector\/api\/list-sell-return?sell_id=157&page=1\",\n\"last\": null,\n\"prev\": null,\n\"next\": null\n},\n\"meta\": {\n\"current_page\": 1,\n\"from\": 1,\n\"path\": \"https:\/\/bqf.ai\/connector\/api\/list-sell-return\",\n\"per_page\": 10,\n\"to\": 1\n}\n}", "name": "" } ] }, { "name": "Update shipping status", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/update-shipping-status", "query": [], "raw": "{{baseUrl}}\/connector\/api\/update-shipping-status" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":11,\"shipping_status\":\"ordered\",\"delivered_to\":\"quidem\"}" }, "description": "" }, "response": [] } ] }, { "name": "Superadmin", "description": "", "item": [ { "name": "If SaaS installed get active subscription details, else return the enabled modules details in package_details", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/active-subscription", "query": [], "raw": "{{baseUrl}}\/connector\/api\/active-subscription" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": {\n\"id\": 1,\n\"business_id\": 1,\n\"package_id\": 3,\n\"start_date\": \"2020-09-05 00:00:00\",\n\"trial_end_date\": \"2020-09-15\",\n\"end_date\": \"2020-10-05 00:00:00\",\n\"package_price\": \"599.9900\",\n\"package_details\": {\n\"location_count\": 0,\n\"user_count\": 0,\n\"product_count\": 0,\n\"invoice_count\": 0,\n\"name\": \"Unlimited\",\n\"woocommerce_module\": 1,\n\"essentials_module\": 1\n},\n\"created_id\": 1,\n\"paid_via\": \"stripe\",\n\"payment_transaction_id\": \"ch_1CuLdQAhokBpT93LVZNg2At6\",\n\"status\": \"approved\",\n\"deleted_at\": null,\n\"created_at\": \"2018-08-01 07:49:09\",\n\"updated_at\": \"2018-08-01 07:49:09\",\n\"locations_created\": 1,\n\"users_created\": 6,\n\"products_created\": 2,\n\"invoices_created\": 1\n}\n}", "name": "" } ] }, { "name": "Get Superadmin Package List", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/packages", "query": [], "raw": "{{baseUrl}}\/connector\/api\/packages" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Starter - Free\",\n\"description\": \"Give it a test drive...\",\n\"location_count\": 0,\n\"user_count\": 0,\n\"product_count\": 0,\n\"bookings\": 0,\n\"kitchen\": 0,\n\"order_screen\": 0,\n\"tables\": 0,\n\"invoice_count\": 0,\n\"interval\": \"months\",\n\"interval_count\": 1,\n\"trial_days\": 10,\n\"price\": \"0.0000\",\n\"custom_permissions\": {\n\"assetmanagement_module\": \"1\",\n\"connector_module\": \"1\",\n\"crm_module\": \"1\",\n\"essentials_module\": \"1\",\n\"manufacturing_module\": \"1\",\n\"productcatalogue_module\": \"1\",\n\"project_module\": \"1\",\n\"repair_module\": \"1\",\n\"woocommerce_module\": \"1\"\n},\n\"created_by\": 1,\n\"sort_order\": 0,\n\"is_active\": 1,\n\"is_private\": 0,\n\"is_one_time\": 0,\n\"enable_custom_link\": 0,\n\"custom_link\": \"\",\n\"custom_link_text\": \"\",\n\"deleted_at\": null,\n\"created_at\": \"2020-10-09 16:38:02\",\n\"updated_at\": \"2020-11-11 12:19:17\"\n},\n{\n\"id\": 2,\n\"name\": \"Regular\",\n\"description\": \"For Small Shops\",\n\"location_count\": 0,\n\"user_count\": 0,\n\"product_count\": 0,\n\"bookings\": 0,\n\"kitchen\": 0,\n\"order_screen\": 0,\n\"tables\": 0,\n\"invoice_count\": 0,\n\"interval\": \"months\",\n\"interval_count\": 1,\n\"trial_days\": 10,\n\"price\": \"199.9900\",\n\"custom_permissions\": {\n\"repair_module\": \"1\"\n},\n\"created_by\": 1,\n\"sort_order\": 1,\n\"is_active\": 1,\n\"is_private\": 0,\n\"is_one_time\": 0,\n\"enable_custom_link\": 0,\n\"custom_link\": null,\n\"custom_link_text\": null,\n\"deleted_at\": null,\n\"created_at\": \"2020-10-09 16:38:02\",\n\"updated_at\": \"2020-10-09 16:38:02\"\n},\n{\n\"id\": 3,\n\"name\": \"Unlimited\",\n\"description\": \"For Large Business\",\n\"location_count\": 0,\n\"user_count\": 0,\n\"product_count\": 0,\n\"bookings\": 0,\n\"kitchen\": 0,\n\"order_screen\": 0,\n\"tables\": 0,\n\"invoice_count\": 0,\n\"interval\": \"months\",\n\"interval_count\": 1,\n\"trial_days\": 10,\n\"price\": \"599.9900\",\n\"custom_permissions\": {\n\"assetmanagement_module\": \"1\",\n\"connector_module\": \"1\",\n\"crm_module\": \"1\",\n\"essentials_module\": \"1\",\n\"manufacturing_module\": \"1\",\n\"productcatalogue_module\": \"1\",\n\"project_module\": \"1\",\n\"repair_module\": \"1\",\n\"woocommerce_module\": \"1\"\n},\n\"created_by\": 1,\n\"sort_order\": 1,\n\"is_active\": 1,\n\"is_private\": 0,\n\"is_one_time\": 0,\n\"enable_custom_link\": 0,\n\"custom_link\": \"\",\n\"custom_link_text\": \"\",\n\"deleted_at\": null,\n\"created_at\": \"2020-10-09 16:38:02\",\n\"updated_at\": \"2020-11-02 12:09:19\"\n}\n]\n}", "name": "" } ] } ] }, { "name": "Table management", "description": "", "item": [ { "name": "List tables", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/table", "query": [ { "key": "location_id", "value": "1", "description": "id of the location", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/table?location_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 5,\n\"business_id\": 1,\n\"location_id\": 1,\n\"name\": \"Table 1\",\n\"description\": null,\n\"created_by\": 9,\n\"deleted_at\": null,\n\"created_at\": \"2020-06-04 22:36:37\",\n\"updated_at\": \"2020-06-04 22:36:37\"\n}\n]\n}", "name": "" } ] }, { "name": "Show the specified table", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/table\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/table\/:id", "variable": [ { "id": "id", "key": "id", "value": "odio", "description": "The ID of the table." }, { "id": "table", "key": "table", "value": "5", "description": "comma separated ids of required tables" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 5,\n\"business_id\": 1,\n\"location_id\": 1,\n\"name\": \"Table 1\",\n\"description\": null,\n\"created_by\": 9,\n\"deleted_at\": null,\n\"created_at\": \"2020-06-04 22:36:37\",\n\"updated_at\": \"2020-06-04 22:36:37\"\n}\n]\n}", "name": "" } ] } ] }, { "name": "Tax management", "description": "", "item": [ { "name": "List taxes", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/tax", "query": [], "raw": "{{baseUrl}}\/connector\/api\/tax" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"VAT@10%\",\n\"amount\": 10,\n\"is_tax_group\": 0,\n\"created_by\": 1,\n\"woocommerce_tax_rate_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:40:07\",\n\"updated_at\": \"2018-01-04 02:40:07\"\n},\n{\n\"id\": 2,\n\"business_id\": 1,\n\"name\": \"CGST@10%\",\n\"amount\": 10,\n\"is_tax_group\": 0,\n\"created_by\": 1,\n\"woocommerce_tax_rate_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:40:55\",\n\"updated_at\": \"2018-01-04 02:40:55\"\n},\n{\n\"id\": 3,\n\"business_id\": 1,\n\"name\": \"SGST@8%\",\n\"amount\": 8,\n\"is_tax_group\": 0,\n\"created_by\": 1,\n\"woocommerce_tax_rate_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:41:13\",\n\"updated_at\": \"2018-01-04 02:41:13\"\n},\n{\n\"id\": 4,\n\"business_id\": 1,\n\"name\": \"GST@18%\",\n\"amount\": 18,\n\"is_tax_group\": 1,\n\"created_by\": 1,\n\"woocommerce_tax_rate_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:42:19\",\n\"updated_at\": \"2018-01-04 02:42:19\"\n}\n]\n}", "name": "" } ] }, { "name": "Get the specified tax", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/tax\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/tax\/:id", "variable": [ { "id": "id", "key": "id", "value": "vel", "description": "The ID of the tax." }, { "id": "tax", "key": "tax", "value": "1", "description": "comma separated ids of required taxes" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"name\": \"VAT@10%\",\n\"amount\": 10,\n\"is_tax_group\": 0,\n\"created_by\": 1,\n\"woocommerce_tax_rate_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:40:07\",\n\"updated_at\": \"2018-01-04 02:40:07\"\n}\n]\n}", "name": "" } ] } ] }, { "name": "Taxonomy management", "description": "", "item": [ { "name": "List taxonomy", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/taxonomy", "query": [ { "key": "type", "value": "nisi", "description": "Type of taxonomy (product, device, hrm_department)", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/taxonomy?type=nisi" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Men's\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:06:34\",\n\"updated_at\": \"2018-01-03 21:06:34\",\n\"sub_categories\": [\n{\n\"id\": 4,\n\"name\": \"Jeans\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 1,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:07:34\",\n\"updated_at\": \"2018-01-03 21:07:34\"\n},\n{\n\"id\": 5,\n\"name\": \"Shirts\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 1,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:08:18\",\n\"updated_at\": \"2018-01-03 21:08:18\"\n}\n]\n},\n{\n\"id\": 21,\n\"name\": \"Food & Grocery\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-06 05:31:35\",\n\"updated_at\": \"2018-01-06 05:31:35\",\n\"sub_categories\": []\n}\n]\n}", "name": "" } ] }, { "name": "Get the specified taxonomy", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/taxonomy\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/taxonomy\/:id", "variable": [ { "id": "id", "key": "id", "value": "molestiae", "description": "The ID of the taxonomy." }, { "id": "taxonomy", "key": "taxonomy", "value": "1", "description": "comma separated ids of product categories" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Men's\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 0,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:06:34\",\n\"updated_at\": \"2018-01-03 21:06:34\",\n\"sub_categories\": [\n{\n\"id\": 4,\n\"name\": \"Jeans\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 1,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:07:34\",\n\"updated_at\": \"2018-01-03 21:07:34\"\n},\n{\n\"id\": 5,\n\"name\": \"Shirts\",\n\"business_id\": 1,\n\"short_code\": null,\n\"parent_id\": 1,\n\"created_by\": 1,\n\"category_type\": \"product\",\n\"description\": null,\n\"slug\": null,\n\"woocommerce_cat_id\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 21:08:18\",\n\"updated_at\": \"2018-01-03 21:08:18\"\n}\n]\n}\n]\n}", "name": "" } ] } ] }, { "name": "Types of service management", "description": "", "item": [ { "name": "List types of service", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/types-of-service", "query": [], "raw": "{{baseUrl}}\/connector\/api\/types-of-service" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Home Delivery\",\n\"description\": null,\n\"business_id\": 1,\n\"location_price_group\": {\n\"1\": \"0\"\n},\n\"packing_charge\": \"10.0000\",\n\"packing_charge_type\": \"fixed\",\n\"enable_custom_fields\": 0,\n\"created_at\": \"2020-06-04 22:41:13\",\n\"updated_at\": \"2020-06-04 22:41:13\"\n}\n]\n}", "name": "" } ] }, { "name": "Get the specified types of service", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/types-of-service\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/types-of-service\/:id", "variable": [ { "id": "id", "key": "id", "value": "illum", "description": "The ID of the types of service." }, { "id": "types_of_service", "key": "types_of_service", "value": "1", "description": "comma separated ids of required types of services" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"name\": \"Home Delivery\",\n\"description\": null,\n\"business_id\": 1,\n\"location_price_group\": {\n\"1\": \"0\"\n},\n\"packing_charge\": \"10.0000\",\n\"packing_charge_type\": \"fixed\",\n\"enable_custom_fields\": 0,\n\"created_at\": \"2020-06-04 22:41:13\",\n\"updated_at\": \"2020-06-04 22:41:13\"\n}\n]\n}", "name": "" } ] } ] }, { "name": "Unit management", "description": "", "item": [ { "name": "List units", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/unit", "query": [], "raw": "{{baseUrl}}\/connector\/api\/unit" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"actual_name\": \"Pieces\",\n\"short_name\": \"Pc(s)\",\n\"allow_decimal\": 0,\n\"base_unit_id\": null,\n\"base_unit_multiplier\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 15:15:20\",\n\"updated_at\": \"2018-01-03 15:15:20\",\n\"base_unit\": null\n},\n{\n\"id\": 2,\n\"business_id\": 1,\n\"actual_name\": \"Packets\",\n\"short_name\": \"packets\",\n\"allow_decimal\": 0,\n\"base_unit_id\": null,\n\"base_unit_multiplier\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-06 01:07:01\",\n\"updated_at\": \"2018-01-06 01:08:36\",\n\"base_unit\": null\n},\n{\n\"id\": 15,\n\"business_id\": 1,\n\"actual_name\": \"Dozen\",\n\"short_name\": \"dz\",\n\"allow_decimal\": 0,\n\"base_unit_id\": 1,\n\"base_unit_multiplier\": \"12.0000\",\n\"created_by\": 9,\n\"deleted_at\": null,\n\"created_at\": \"2020-07-20 13:11:09\",\n\"updated_at\": \"2020-07-20 13:11:09\",\n\"base_unit\": {\n\"id\": 1,\n\"business_id\": 1,\n\"actual_name\": \"Pieces\",\n\"short_name\": \"Pc(s)\",\n\"allow_decimal\": 0,\n\"base_unit_id\": null,\n\"base_unit_multiplier\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 15:15:20\",\n\"updated_at\": \"2018-01-03 15:15:20\"\n}\n}\n]\n}", "name": "" } ] }, { "name": "Get the specified unit", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/unit\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/unit\/:id", "variable": [ { "id": "id", "key": "id", "value": "illo", "description": "The ID of the unit." }, { "id": "unit", "key": "unit", "value": "1", "description": "comma separated ids of the units" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"business_id\": 1,\n\"actual_name\": \"Pieces\",\n\"short_name\": \"Pc(s)\",\n\"allow_decimal\": 0,\n\"base_unit_id\": null,\n\"base_unit_multiplier\": null,\n\"created_by\": 1,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-03 15:15:20\",\n\"updated_at\": \"2018-01-03 15:15:20\",\n\"base_unit\": null\n}\n]\n}", "name": "" } ] } ] }, { "name": "User management", "description": "", "item": [ { "name": "Get the loggedin user details.", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/user\/loggedin", "query": [], "raw": "{{baseUrl}}\/connector\/api\/user\/loggedin" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\":{\n\"id\": 1,\n\"user_type\": \"user\",\n\"surname\": \"Mr\",\n\"first_name\": \"Admin\",\n\"last_name\": null,\n\"username\": \"admin\",\n\"email\": \"admin@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:19\",\n\"updated_at\": \"2018-01-04 02:15:19\"\n}\n}", "name": "" } ] }, { "name": "Register User", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/user-registration", "query": [], "raw": "{{baseUrl}}\/connector\/api\/user-registration" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"surname\":\"sunt\",\"first_name\":\"quidem\",\"last_name\":\"aut\",\"email\":\"ewilliamson@example.net\",\"is_active\":\"sit\",\"user_type\":\"aliquid\",\"crm_contact_id\":12,\"allow_login\":false,\"username\":\"ullam\",\"password\":\"po~Aj[ZM%,yh\",\"role\":7,\"access_all_locations\":true,\"location_permissions\":[\"et\"],\"cmmsn_percent\":\"itaque\",\"max_sales_discount_percent\":\"pariatur\",\"selected_contacts\":true,\"selected_contact_ids\":[\"facilis\"],\"dob\":\"omnis\",\"gender\":\"voluptatem\",\"marital_status\":\"tempore\",\"blood_group\":\"placeat\",\"contact_number\":\"dolores\",\"alt_number\":\"nulla\",\"family_number\":\"tempora\",\"fb_link\":\"quo\",\"twitter_link\":\"voluptatem\",\"social_media_1\":\"quibusdam\",\"social_media_2\":\"molestiae\",\"custom_field_1\":\"reprehenderit\",\"custom_field_2\":\"et\",\"custom_field_3\":\"nihil\",\"custom_field_4\":\"sequi\",\"guardian_name\":\"cum\",\"id_proof_name\":\"et\",\"id_proof_number\":\"necessitatibus\",\"permanent_address\":\"molestiae\",\"current_address\":\"reprehenderit\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"success\": 1,\n\"msg\": \"User added successfully\",\n\"user\": {\n\"surname\": \"Mr\",\n\"first_name\": \"Test\",\n\"last_name\": \"kumar\",\n\"email\": \"test@example.com\",\n\"user_type\": \"user_customer\",\n\"crm_contact_id\": \"2\",\n\"allow_login\": 1,\n\"username\": \"0017\",\n\"cmmsn_percent\": \"25\",\n\"max_sales_discount_percent\": \"52\",\n\"dob\": \"1997-10-12\",\n\"gender\": \"male\",\n\"marital_status\": \"unmarried\",\n\"blood_group\": \"0+\",\n\"contact_number\": \"4578451245\",\n\"alt_number\": \"7474747474\",\n\"family_number\": \"7474147414\",\n\"fb_link\": \"fb.com\/username\",\n\"twitter_link\": \"twitter.com\/username\",\n\"social_media_1\": \"test\",\n\"social_media_2\": \"test\",\n\"custom_field_1\": \"test\",\n\"custom_field_2\": \"test\",\n\"custom_field_3\": \"test\",\n\"custom_field_4\": \"test\",\n\"guardian_name\": \"test\",\n\"id_proof_name\": \"uid\",\n\"id_proof_number\": \"747845120124\",\n\"permanent_address\": \"test permanent adrress\",\n\"current_address\": \"test current address\",\n\"bank_details\": \"{\\\"account_holder_name\\\":\\\"test\\\",\\\"account_number\\\":\\\"test\\\",\\\"bank_name\\\":\\\"test\\\",\\\"bank_code\\\":\\\"test\\\",\\\"branch\\\":\\\"test\\\",\\\"tax_payer_id\\\":\\\"test\\\"}\",\n\"selected_contacts\": \"1\",\n\"status\": \"active\",\n\"business_id\": 1,\n\"updated_at\": \"2021-08-12 18:03:58\",\n\"created_at\": \"2021-08-12 18:03:58\",\n\"id\": 140\n}\n}", "name": "" } ] }, { "name": "List users", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/user", "query": [ { "key": "service_staff", "value": "", "description": "Filter service staffs from users list (0, 1)", "disabled": true }, { "key": "per_page", "value": "50", "description": "Optional paging (up to 500 per page); without it, or with -1, the whole list", "disabled": false } ], "raw": "{{baseUrl}}\/connector\/api\/user?service_staff=&per_page=50" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"user_type\": \"user\",\n\"surname\": \"Mr\",\n\"first_name\": \"Admin\",\n\"last_name\": null,\n\"username\": \"admin\",\n\"email\": \"admin@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:19\",\n\"updated_at\": \"2018-01-04 02:15:19\"\n}\n]\n}", "name": "" } ] }, { "name": "Get the specified user", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/user\/:id", "query": [], "raw": "{{baseUrl}}\/connector\/api\/user\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." }, { "id": "user", "key": "user", "value": "1", "description": "comma separated ids of the required users" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"data\": [\n{\n\"id\": 1,\n\"user_type\": \"user\",\n\"surname\": \"Mr\",\n\"first_name\": \"Admin\",\n\"last_name\": null,\n\"username\": \"admin\",\n\"email\": \"admin@example.com\",\n\"language\": \"en\",\n\"contact_no\": null,\n\"address\": null,\n\"business_id\": 1,\n\"max_sales_discount_percent\": null,\n\"allow_login\": 1,\n\"essentials_department_id\": null,\n\"essentials_designation_id\": null,\n\"status\": \"active\",\n\"crm_contact_id\": null,\n\"is_cmmsn_agnt\": 0,\n\"cmmsn_percent\": \"0.00\",\n\"selected_contacts\": 0,\n\"dob\": null,\n\"gender\": null,\n\"marital_status\": null,\n\"blood_group\": null,\n\"contact_number\": null,\n\"fb_link\": null,\n\"twitter_link\": null,\n\"social_media_1\": null,\n\"social_media_2\": null,\n\"permanent_address\": null,\n\"current_address\": null,\n\"guardian_name\": null,\n\"custom_field_1\": null,\n\"custom_field_2\": null,\n\"custom_field_3\": null,\n\"custom_field_4\": null,\n\"bank_details\": null,\n\"id_proof_name\": null,\n\"id_proof_number\": null,\n\"deleted_at\": null,\n\"created_at\": \"2018-01-04 02:15:19\",\n\"updated_at\": \"2018-01-04 02:15:19\"\n}\n]\n}", "name": "" } ] }, { "name": "Update user password.", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/update-password", "query": [], "raw": "{{baseUrl}}\/connector\/api\/update-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"current_password\":\"similique\",\"new_password\":\"numquam\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"success\":1,\n\"msg\":\"Password updated successfully\"\n}", "name": "" } ] }, { "name": "Recover forgotten password.", "request": { "url": { "host": "{{baseUrl}}", "path": "connector\/api\/forget-password", "query": [], "raw": "{{baseUrl}}\/connector\/api\/forget-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"wmueller@example.org\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"success\":1,\n\"msg\":\"New password sent to user@example.com successfully\"\n}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "value": null, "type": "string" } ] } }