{ "info": { "_postman_id": "a6f744f5-dfab-4ed6-85d5-3aa99a09ca44", "name": "ArtyChat External API v1", "description": "Set apiKey to a key created in Settings \u2192 API Management. Replace example IDs and values with data from your own account. Never share or commit the API key.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "apiBase", "value": "https://artychat.com/api/v1", "type": "string" }, { "key": "apiKey", "value": "", "type": "string", "description": "Paste your private API key here." }, { "key": "conversationId", "value": "", "type": "string" }, { "key": "bookingId", "value": "", "type": "string" }, { "key": "serviceId", "value": "", "type": "string" }, { "key": "bookingDate", "value": "", "type": "string", "description": "Future date: YYYY-MM-DD" }, { "key": "bookingTime", "value": "10:00", "type": "string" }, { "key": "orderId", "value": "", "type": "string" }, { "key": "customerId", "value": "", "type": "string" }, { "key": "productId", "value": "", "type": "string" } ], "item": [ { "name": "Business and team", "item": [ { "name": "Get business profile", "request": { "method": "GET", "description": "Permission required: business:read. Returns the business profile.", "header": [], "url": "{{apiBase}}/business" } }, { "name": "List locations", "request": { "method": "GET", "description": "Permission required: business:read. Returns business locations.", "header": [], "url": "{{apiBase}}/locations" } }, { "name": "List team members", "request": { "method": "GET", "description": "Permission required: team:read. Returns team members and roles.", "header": [], "url": "{{apiBase}}/team" } } ] }, { "name": "Conversations", "item": [ { "name": "List conversations", "request": { "method": "GET", "description": "Permission required: chats:read. Returns the account's conversations.", "header": [], "url": "{{apiBase}}/conversations" } }, { "name": "Get conversation", "request": { "method": "GET", "description": "Permission required: chats:read. Set conversationId first.", "header": [], "url": "{{apiBase}}/conversations/{{conversationId}}" } }, { "name": "Update conversation status", "request": { "method": "PATCH", "description": "Permission required: chats:write. Reopens a conversation. Set conversationId first.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"Open\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/conversations/{{conversationId}}" } }, { "name": "Send a message", "request": { "method": "POST", "description": "Permission required: chats:write. Sends a text message to an open conversation.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"Hello from an external app.\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/conversations/{{conversationId}}/messages" } } ] }, { "name": "Bookings", "item": [ { "name": "List bookings", "request": { "method": "GET", "description": "Permission required: bookings:read. Returns the account's bookings.", "header": [], "url": "{{apiBase}}/bookings" } }, { "name": "List booking services", "request": { "method": "GET", "description": "Permission required: bookings:read. Returns bookable services.", "header": [], "url": "{{apiBase}}/booking-services" } }, { "name": "Check available slots", "request": { "method": "GET", "description": "Permission required: bookings:read. Set a future bookingDate and valid serviceId first.", "header": [], "url": "{{apiBase}}/bookings/available-slots?date={{bookingDate}}&service_ids%5B%5D={{serviceId}}" } }, { "name": "Get booking", "request": { "method": "GET", "description": "Permission required: bookings:read. Set bookingId first.", "header": [], "url": "{{apiBase}}/bookings/{{bookingId}}" } }, { "name": "Create booking", "request": { "method": "POST", "description": "Permission required: bookings:write. Set serviceId and a future bookingDate valid for the service. client_email is required.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"{{serviceId}}\",\n \"booking_date\": \"{{bookingDate}}\",\n \"booking_time\": \"{{bookingTime}}\",\n \"client_name\": \"Example Client\",\n \"client_email\": \"client@example.com\",\n \"client_phone\": \"+50255555555\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/bookings" } }, { "name": "Update booking", "request": { "method": "PUT", "description": "Permission required: bookings:write. Set bookingId and valid service/date/time values. This changes the selected booking.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"{{serviceId}}\",\n \"booking_date\": \"{{bookingDate}}\",\n \"booking_time\": \"{{bookingTime}}\",\n \"status\": \"confirmed\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/bookings/{{bookingId}}" } }, { "name": "Update booking status", "request": { "method": "PATCH", "description": "Permission required: bookings:write. Set bookingId. Completing a booking also requires completion_paid_amount and completion_payment_method.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"confirmed\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/bookings/{{bookingId}}/status" } } ] }, { "name": "Orders", "item": [ { "name": "List orders", "request": { "method": "GET", "description": "Permission required: orders:read. Returns store orders.", "header": [], "url": "{{apiBase}}/orders" } }, { "name": "Get order", "request": { "method": "GET", "description": "Permission required: orders:read. Set orderId first.", "header": [], "url": "{{apiBase}}/orders/{{orderId}}" } }, { "name": "Update order", "request": { "method": "PATCH", "description": "Permission required: orders:write. Updates order status and notes.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"processing\",\n \"notes\": \"Updated by external app.\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/orders/{{orderId}}" } } ] }, { "name": "Customers", "item": [ { "name": "List customers", "request": { "method": "GET", "description": "Permission required: customers:read. Returns customers.", "header": [], "url": "{{apiBase}}/customers" } }, { "name": "Get customer", "request": { "method": "GET", "description": "Permission required: customers:read. Set customerId first.", "header": [], "url": "{{apiBase}}/customers/{{customerId}}" } }, { "name": "Create customer", "request": { "method": "POST", "description": "Permission required: customers:write. first_name and last_name are required.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Alex\",\n \"last_name\": \"Example\",\n \"email\": \"alex@example.com\",\n \"phone\": \"+50255555555\",\n \"tags\": [\n \"api\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/customers" } }, { "name": "Update customer", "request": { "method": "PUT", "description": "Permission required: customers:write. Set customerId. first_name and last_name are required.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Alex\",\n \"last_name\": \"Example\",\n \"email\": \"alex@example.com\",\n \"phone\": \"+50255555555\",\n \"tags\": [\n \"api\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/customers/{{customerId}}" } } ] }, { "name": "POS", "item": [ { "name": "Get POS catalog", "request": { "method": "GET", "description": "Permission required: pos:read. Returns POS catalog data.", "header": [], "url": "{{apiBase}}/pos/catalog" } }, { "name": "List POS products", "request": { "method": "GET", "description": "Permission required: pos:read. Returns POS products.", "header": [], "url": "{{apiBase}}/pos/products" } }, { "name": "Get POS product", "request": { "method": "GET", "description": "Permission required: pos:read. Set productId first.", "header": [], "url": "{{apiBase}}/pos/products/{{productId}}" } }, { "name": "Create POS sale", "request": { "method": "POST", "description": "Permission required: pos:write. Use a productId from your catalog. A POS order is created on success.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"item_type\": \"product\",\n \"product_id\": \"{{productId}}\",\n \"quantity\": 1\n }\n ],\n \"notes\": \"Created by external app.\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/pos/sales" } } ] }, { "name": "AI settings", "item": [ { "name": "Read AI instructions", "request": { "method": "GET", "description": "Permission required: ai:instructions:read. Returns saved AI instructions.", "header": [], "url": "{{apiBase}}/ai/instructions" } }, { "name": "Replace AI instructions", "request": { "method": "PUT", "description": "Permission required: ai:instructions:write. Send an empty string to clear instructions.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"instructions\": \"Answer customers in a warm, concise tone.\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/ai/instructions" } }, { "name": "Read channel auto-replies", "request": { "method": "GET", "description": "Permission required: auto_replies:read. Returns account-level WhatsApp, Instagram, and Facebook switches.", "header": [], "url": "{{apiBase}}/ai/auto-replies" } }, { "name": "Update channel auto-replies", "request": { "method": "PATCH", "description": "Permission required: auto_replies:write. Update one or more channel switches; per-conversation settings are unaffected.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"whatsapp\": false,\n \"instagram\": true,\n \"facebook\": true\n}", "options": { "raw": { "language": "json" } } }, "url": "{{apiBase}}/ai/auto-replies" } } ] }, { "name": "Expenses", "item": [ { "name": "List Expenses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses", "host": [ "{{apiBase}}" ], "path": [ "expenses" ], "variable": [] }, "description": "List expenses with filtered totals. Filters: from, to, search, category_id, page, per_page. Required scope: expenses:read." } }, { "name": "Export Expenses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/export/:format", "host": [ "{{apiBase}}" ], "path": [ "expenses", "export", ":format" ], "variable": [ { "key": "format", "value": "pdf" } ] }, "description": "Export filtered expenses as PDF or CSV. Required scope: expenses:read." } }, { "name": "Analyze Expense Receipt", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/analyze", "host": [ "{{apiBase}}" ], "path": [ "expenses", "analyze" ], "variable": [] }, "description": "Analyze a receipt without creating an expense. Accepts a file upload. Required scope: expenses:write.", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "disabled": false } ] } } }, { "name": "List Expense Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/categories", "host": [ "{{apiBase}}" ], "path": [ "expenses", "categories" ], "variable": [] }, "description": "List expense categories. Required scope: expenses:read." } }, { "name": "Create Expense Category", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/categories", "host": [ "{{apiBase}}" ], "path": [ "expenses", "categories" ], "variable": [] }, "description": "create expense category. Required scope: expenses:write.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Expense Category", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/categories/:category", "host": [ "{{apiBase}}" ], "path": [ "expenses", "categories", ":category" ], "variable": [ { "key": "category", "value": "1" } ] }, "description": "update expense category. Required scope: expenses:write.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Expense Category", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/categories/:category", "host": [ "{{apiBase}}" ], "path": [ "expenses", "categories", ":category" ], "variable": [ { "key": "category", "value": "1" } ] }, "description": "delete expense category. Required scope: expenses:write." } }, { "name": "List Expense Providers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/providers", "host": [ "{{apiBase}}" ], "path": [ "expenses", "providers" ], "variable": [] }, "description": "list expense providers. Required scope: expenses:read." } }, { "name": "Create Expense Provider", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/providers", "host": [ "{{apiBase}}" ], "path": [ "expenses", "providers" ], "variable": [] }, "description": "create expense provider. Required scope: expenses:write.", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Example", "type": "text" }, { "key": "logo", "type": "file", "src": [], "disabled": true } ] } } }, { "name": "Update Expense Provider", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/providers/:provider", "host": [ "{{apiBase}}" ], "path": [ "expenses", "providers", ":provider" ], "variable": [ { "key": "provider", "value": "1" } ] }, "description": "update expense provider. Required scope: expenses:write.", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Example", "type": "text" }, { "key": "logo", "type": "file", "src": [], "disabled": true } ] } } }, { "name": "Delete Expense Provider", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/providers/:provider", "host": [ "{{apiBase}}" ], "path": [ "expenses", "providers", ":provider" ], "variable": [ { "key": "provider", "value": "1" } ] }, "description": "delete expense provider. Required scope: expenses:write." } }, { "name": "Get Expense Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/settings", "host": [ "{{apiBase}}" ], "path": [ "expenses", "settings" ], "variable": [] }, "description": "Read receipt auto-detection settings. Required scope: expenses:read." } }, { "name": "Update Expense Settings", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/settings", "host": [ "{{apiBase}}" ], "path": [ "expenses", "settings" ], "variable": [] }, "description": "Update receipt auto-detection settings. Required scope: expenses:write.", "body": { "mode": "raw", "raw": "{\n \"ai_auto_detect\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Expense", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses", "host": [ "{{apiBase}}" ], "path": [ "expenses" ], "variable": [] }, "description": "Create an expense. Fields: title, vendor, expense_date, amount, tax_amount, currency, payment_method, expense_category_id, category_name, notes. Required scope: expenses:write.", "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Fuel", "type": "text" }, { "key": "amount", "value": "150", "type": "text" }, { "key": "currency", "value": "GTQ", "type": "text" }, { "key": "expense_date", "value": "2026-10-13", "type": "text" }, { "key": "file", "type": "file", "src": [], "disabled": true } ] } } }, { "name": "Get Expense", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/:expense", "host": [ "{{apiBase}}" ], "path": [ "expenses", ":expense" ], "variable": [ { "key": "expense", "value": "1" } ] }, "description": "Read an expense and its category. Required scope: expenses:read." } }, { "name": "Update Expense", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/:expense", "host": [ "{{apiBase}}" ], "path": [ "expenses", ":expense" ], "variable": [ { "key": "expense", "value": "1" } ] }, "description": "Update expense fields or its receipt. Required scope: expenses:write.", "body": { "mode": "formdata", "formdata": [ { "key": "amount", "value": "160", "type": "text" }, { "key": "file", "type": "file", "src": [], "disabled": true } ] } } }, { "name": "Delete Expense", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/expenses/:expense", "host": [ "{{apiBase}}" ], "path": [ "expenses", ":expense" ], "variable": [ { "key": "expense", "value": "1" } ] }, "description": "Delete an expense and its receipt. Required scope: expenses:write." } } ] }, { "name": "Delivery orders", "item": [ { "name": "List Deliveries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries", "host": [ "{{apiBase}}" ], "path": [ "deliveries" ], "variable": [] }, "description": "List active deliveries with their POS orders. Required scope: deliveries:read." } }, { "name": "List Delivery Ready Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/ready-orders", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "ready-orders" ], "variable": [] }, "description": "List ready POS orders without a delivery. Required scope: deliveries:read." } }, { "name": "List Delivery History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/history", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "history" ], "variable": [] }, "description": "List up to 100 finished deliveries. Required scope: deliveries:read." } }, { "name": "Get Delivery Live Tracking", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/live-tracking", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "live-tracking" ], "variable": [] }, "description": "Read live delivery and driver coordinates. Required scope: deliveries:read." } }, { "name": "Get Delivery Tracking Link", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/:id/tracking-link", "host": [ "{{apiBase}}" ], "path": [ "deliveries", ":id", "tracking-link" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Get a signed customer tracking URL valid for 48 hours. Required scope: deliveries:read." } }, { "name": "Get Delivery Proof", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/:id/proof/:kind", "host": [ "{{apiBase}}" ], "path": [ "deliveries", ":id", "proof", ":kind" ], "variable": [ { "key": "id", "value": "1" }, { "key": "kind", "value": "signature" } ] }, "description": "Read private signature or photo proof. Required scope: deliveries:read." } }, { "name": "Get Delivery", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/:id", "host": [ "{{apiBase}}" ], "path": [ "deliveries", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Read one delivery and its events. Required scope: deliveries:read." } }, { "name": "Configure Order Delivery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/configure/:orderId", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "configure", ":orderId" ], "variable": [ { "key": "orderId", "value": "1" } ] }, "description": "Configure delivery coordinates before the POS order is ready. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"pickup_address\": \"Business address\",\n \"dropoff_address\": \"Customer address\",\n \"pickup_latitude\": 14.63,\n \"pickup_longitude\": -90.5,\n \"dropoff_latitude\": 14.64,\n \"dropoff_longitude\": -90.51\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Delivery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/from-ready/:orderId", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "from-ready", ":orderId" ], "variable": [ { "key": "orderId", "value": "1" } ] }, "description": "Create delivery from a ready POS order. Optional fleet_id, driver_id, postal_code. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"pickup_address\": \"Business address\",\n \"dropoff_address\": \"Customer address\",\n \"pickup_latitude\": 14.63,\n \"pickup_longitude\": -90.5,\n \"dropoff_latitude\": 14.64,\n \"dropoff_longitude\": -90.51\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Assign Delivery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/:id/assign", "host": [ "{{apiBase}}" ], "path": [ "deliveries", ":id", "assign" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Assign a pending delivery to a business driver. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"driver_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Accept Delivery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/:id/accept", "host": [ "{{apiBase}}" ], "path": [ "deliveries", ":id", "accept" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Accept a pending delivery that has an assigned driver. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pickup Delivery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/:id/pickup", "host": [ "{{apiBase}}" ], "path": [ "deliveries", ":id", "pickup" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Mark an accepted delivery as picked up. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Complete Delivery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/:id/complete", "host": [ "{{apiBase}}" ], "path": [ "deliveries", ":id", "complete" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Complete a picked-up delivery. Requires actual completion coordinates and a PNG signature data URI; optional JPEG proof_photo and cash_received covering cash_due. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"latitude\": 14.64,\n \"longitude\": -90.51,\n \"signature\": \"data:image/png;base64,\",\n \"cash_received\": 150\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Delivery Fleets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/fleets", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "fleets" ], "variable": [] }, "description": "List business fleets. Required scope: deliveries:read." } }, { "name": "Create Delivery Fleet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/fleets", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "fleets" ], "variable": [] }, "description": "Create a business delivery fleet. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Main fleet\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Delivery Vehicles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/vehicles", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "vehicles" ], "variable": [] }, "description": "List business vehicles. Required scope: deliveries:read." } }, { "name": "Create Delivery Vehicle", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/vehicles", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "vehicles" ], "variable": [] }, "description": "Create a business delivery vehicle. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"fleet_id\": 1,\n \"type\": \"motorbike\",\n \"name\": \"Bike 1\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Delivery Drivers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/drivers", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "drivers" ], "variable": [] }, "description": "List business drivers. Required scope: deliveries:read." } }, { "name": "Create Delivery Driver", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/drivers", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "drivers" ], "variable": [] }, "description": "Create a business delivery driver. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"fleet_id\": 1,\n \"team_member_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Delivery Zones", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/zones", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "zones" ], "variable": [] }, "description": "List business zones. Required scope: deliveries:read." } }, { "name": "Create Delivery Zone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/deliveries/zones", "host": [ "{{apiBase}}" ], "path": [ "deliveries", "zones" ], "variable": [] }, "description": "Create a business delivery zone. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Zone 1\",\n \"postal_codes\": [\n \"01001\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Dispatch Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/dispatch/orders", "host": [ "{{apiBase}}" ], "path": [ "dispatch", "orders" ], "variable": [] }, "description": "list dispatch orders. Required scope: deliveries:read." } }, { "name": "List Dispatch History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/dispatch/history", "host": [ "{{apiBase}}" ], "path": [ "dispatch", "history" ], "variable": [] }, "description": "list dispatch history. Required scope: deliveries:read." } }, { "name": "Get Dispatch Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/dispatch/orders/:orderId", "host": [ "{{apiBase}}" ], "path": [ "dispatch", "orders", ":orderId" ], "variable": [ { "key": "orderId", "value": "1" } ] }, "description": "get dispatch order. Required scope: deliveries:read." } }, { "name": "Accept Dispatch Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/dispatch/orders/:orderId/accept", "host": [ "{{apiBase}}" ], "path": [ "dispatch", "orders", ":orderId", "accept" ], "variable": [ { "key": "orderId", "value": "1" } ] }, "description": "accept dispatch order. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark Dispatch Order Ready", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/dispatch/orders/:orderId/ready", "host": [ "{{apiBase}}" ], "path": [ "dispatch", "orders", ":orderId", "ready" ], "variable": [ { "key": "orderId", "value": "1" } ] }, "description": "mark dispatch order ready. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Dispatch Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/dispatch/settings", "host": [ "{{apiBase}}" ], "path": [ "dispatch", "settings" ], "variable": [] }, "description": "get dispatch settings. Required scope: deliveries:read." } }, { "name": "Update Dispatch Settings", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{apiBase}}/dispatch/settings", "host": [ "{{apiBase}}" ], "path": [ "dispatch", "settings" ], "variable": [] }, "description": "update dispatch settings. Required scope: deliveries:write.", "body": { "mode": "raw", "raw": "{\n \"notifications_enabled\": true,\n \"print_mode\": \"manual\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }