{ "info": { "name": "Areye Business API: deliveries", "description": "Book and track Areye deliveries from your platform. Authenticate every call with the X-Business-API-Key header. Send a stable external_reference with every booking and reuse it on retries. Times are ISO-8601 with an offset. Build and test in the SANDBOX (https://sandbox.areye.app/api, sk_sandbox_ keys): the same API and webhooks, simulation endpoints to drive each trip, and nothing real is ever reached. Live (https://api.areye.app/api) takes live keys only and refuses test bookings. Every refusal carries a stable code. Full guide: https://areye.app/api-docs#sandbox\n\nSet the apiKey variable to your key (or a partner key). baseUrl starts on the SANDBOX (https://sandbox.areye.app/api) with an sk_sandbox_ key: nothing there reaches a driver or moves money. For live, change baseUrl to https://api.areye.app/api and apiKey to your live key.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": "2026-10-11" }, "variable": [ { "key": "baseUrl", "value": "https://sandbox.areye.app/api" }, { "key": "apiKey", "value": "" }, { "key": "reference", "value": "ARY-XXXXXX", "description": "An Areye trip reference from a booking response" }, { "key": "trip", "value": "ARY-XXXXXX", "description": "A trip id or reference" }, { "key": "chatToken", "value": "", "description": "chat_token from the booking response" } ], "item": [ { "name": "Bus seats", "item": [ { "name": "Seat map for one departure over one stretch of the route", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/bus/departures/{{schedule}}/seat-map?date=&board_stop_id=&alight_stop_id=", "host": [ "{{baseUrl}}" ], "path": [ "business", "bus", "departures", "{{schedule}}", "seat-map" ], "query": [ { "key": "date", "value": "", "disabled": false, "description": "YYYY-MM-DD" }, { "key": "board_stop_id", "value": "", "disabled": false, "description": null }, { "key": "alight_stop_id", "value": "", "disabled": false, "description": null } ] }, "description": "Seat map for one departure over one stretch of the route" } }, { "name": "Sell seats at the door (operator) or at a till (retailer, float debited)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/bus/sell", "host": [ "{{baseUrl}}" ], "path": [ "business", "bus", "sell" ], "query": [] }, "description": "Sell seats at the door (operator) or at a till (retailer, float debited)\n\nBody: schedule_id, date, board_stop_id, alight_stop_id, seats[{seat_no, first_name, last_name, phone}], payment_method cash. Sold at once; each passenger gets an SMS ticket." } }, { "name": "Board a passenger by ticket code or phone", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/bus/checkin", "host": [ "{{baseUrl}}" ], "path": [ "business", "bus", "checkin" ], "query": [] }, "description": "Board a passenger by ticket code or phone" } }, { "name": "Manifest by boarding stop in seat order (format=csv for a file)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/bus/manifest?schedule_id=&date=&stop_id=&format=", "host": [ "{{baseUrl}}" ], "path": [ "business", "bus", "manifest" ], "query": [ { "key": "schedule_id", "value": "", "disabled": false, "description": null }, { "key": "date", "value": "", "disabled": false, "description": null }, { "key": "stop_id", "value": "", "disabled": true, "description": null }, { "key": "format", "value": "", "disabled": true, "description": null } ] }, "description": "Manifest by boarding stop in seat order (format=csv for a file)" } } ] }, { "name": "Reference data", "item": [ { "name": "Vehicle types with live pricing", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/vehicle-types", "host": [ "{{baseUrl}}" ], "path": [ "business", "vehicle-types" ], "query": [] }, "description": "Vehicle types with live pricing" } }, { "name": "Parcel size bands", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/parcel-sizes", "host": [ "{{baseUrl}}" ], "path": [ "business", "parcel-sizes" ], "query": [] }, "description": "Parcel size bands" } }, { "name": "Active service zones", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/zones", "host": [ "{{baseUrl}}" ], "path": [ "business", "zones" ], "query": [] }, "description": "Active service zones" } } ] }, { "name": "Bookings", "item": [ { "name": "Price a trip before booking it", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trip/fare-estimate?pickup_lat=-24.6541&pickup_lng=25.9087&dest_lat=-24.6600&dest_lng=25.9100&vehicle_type_id=", "host": [ "{{baseUrl}}" ], "path": [ "business", "trip", "fare-estimate" ], "query": [ { "key": "pickup_lat", "value": "-24.6541", "disabled": false, "description": null }, { "key": "pickup_lng", "value": "25.9087", "disabled": false, "description": null }, { "key": "dest_lat", "value": "-24.6600", "disabled": false, "description": null }, { "key": "dest_lng", "value": "25.9100", "disabled": false, "description": null }, { "key": "vehicle_type_id", "value": "", "disabled": true, "description": "Include to receive system_fare for that vehicle type" } ] }, "description": "Price a trip before booking it" } }, { "name": "Book a delivery (or ride)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/book", "host": [ "{{baseUrl}}" ], "path": [ "business", "book" ], "query": [] }, "description": "Book a delivery (or ride)\n\nIdempotent on external_reference: an exact retry returns 200 with replayed: true and the original delivery; the same reference with different details returns 409 external_reference_conflict; a booking still in progress returns 409 booking_in_progress with Retry-After. A reference stays tied to its first delivery for good, even once cancelled.", "body": { "mode": "raw", "raw": "{\n \"type\": \"parcel\",\n \"external_reference\": \"SHOP-1001\",\n \"passenger_name\": \"Neo\",\n \"passenger_phone\": \"+26771234567\",\n \"pickup_address\": \"Your store\",\n \"pickup_lat\": -24.6541,\n \"pickup_lng\": 25.9087,\n \"dest_address\": \"Customer\",\n \"dest_lat\": -24.66,\n \"dest_lng\": 25.91,\n \"prep_minutes\": 15,\n \"handover_required\": true,\n \"order_payload\": {\n \"store_name\": \"Your store\",\n \"items\": [\n {\n \"name\": \"Chicken wrap\",\n \"qty\": 2\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List trips, newest first", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips?month=2026-11&reference=&search=&test=0&per_page=20&page=&since=&from=&to=&type=&status=", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips" ], "query": [ { "key": "month", "value": "2026-11", "disabled": true, "description": "YYYY-MM" }, { "key": "reference", "value": "", "disabled": true, "description": null }, { "key": "search", "value": "", "disabled": true, "description": "Reference, passenger, address or your external_reference" }, { "key": "test", "value": "0", "disabled": true, "description": "0 hides test trips, 1 shows only them" }, { "key": "per_page", "value": "20", "disabled": true, "description": null }, { "key": "page", "value": "", "disabled": true, "description": null }, { "key": "since", "value": "", "disabled": true, "description": "Only trips updated since this time" }, { "key": "from", "value": "", "disabled": true, "description": "First day, inclusive (YYYY-MM-DD)" }, { "key": "to", "value": "", "disabled": true, "description": "Last day, inclusive (YYYY-MM-DD)" }, { "key": "type", "value": "", "disabled": true, "description": null }, { "key": "status", "value": "", "disabled": true, "description": "One status, or several separated by commas" } ] }, "description": "List trips, newest first" } }, { "name": "Book a merchant order delivery (order lines, cash on delivery, shop-and-deliver, bulky goods); retry safely with external_reference", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips" ], "query": [] }, "description": "Book a merchant order delivery (order lines, cash on delivery, shop-and-deliver, bulky goods); retry safely with external_reference\n\nThe merchant-order form of /business/book: the same route, recipient and payment fields, plus order_payload, cod_amount, shop_deliver and bulky goods. Same refusal codes." } }, { "name": "One trip", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}" ], "query": [] }, "description": "One trip" } }, { "name": "Cancel before pickup", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "cancel" ], "query": [] }, "description": "Cancel before pickup\n\nAllowed while pending, scheduled, queued, accepted, enroute or arrived. A business is never charged for cancelling; anything charged to the wallet for the trip is refunded.", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer changed their mind\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "The order is packed", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trip/{{reference}}/ready", "host": [ "{{baseUrl}}" ], "path": [ "business", "trip", "{{reference}}", "ready" ], "query": [] }, "description": "The order is packed\n\nReleases a held order to drivers at once and tells an assigned driver. Calling it again is harmless." } }, { "name": "Every trip matching from, to, type and status, as CSV", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/export?from=&to=&type=&status=", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "export" ], "query": [ { "key": "from", "value": "", "disabled": true, "description": null }, { "key": "to", "value": "", "disabled": true, "description": null }, { "key": "type", "value": "", "disabled": true, "description": null }, { "key": "status", "value": "", "disabled": true, "description": null } ] }, "description": "Every trip matching from, to, type and status, as CSV" } }, { "name": "Your latest 50 delivery batches, each with its stops", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/batches", "host": [ "{{baseUrl}}" ], "path": [ "business", "batches" ], "query": [] }, "description": "Your latest 50 delivery batches, each with its stops" } }, { "name": "Book a batch of up to 50 deliveries on one driver; retry safely with external_reference or Idempotency-Key", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/batches", "host": [ "{{baseUrl}}" ], "path": [ "business", "batches" ], "query": [] }, "description": "Book a batch of up to 50 deliveries on one driver; retry safely with external_reference or Idempotency-Key\n\nOne driver, one vehicle, for any retail merchant (restaurants, grocers, liquor stores, pharmacies, shops). Each stop takes the same goods fields and door rules as a single delivery (order lines, contents, declared value, 18+ ID check, delivery code, tip, COD). For orders collected now send dispatch_mode \"immediate\": Areye chooses the stop order, returns each stop's time at the door, refuses the batch when it adds more than max_added_minutes to any order (batch_adds_too_much_time), holds it off the market until shortly before the last ready_at (or until every order is marked ready with POST /business/trip/{reference}/ready), and freezes the driver's guaranteed pay. A priority (express) stop is never batched. With no dispatch_mode the legacy path is unchanged.", "body": { "mode": "raw", "raw": "{\n \"dispatch_mode\": \"immediate\",\n \"external_reference\": \"RUN-1001\",\n \"max_added_minutes\": 20,\n \"stops\": [\n {\n \"external_reference\": \"SHOP-1002\",\n \"pickup_address\": \"Your kitchen\",\n \"pickup_lat\": -24.6541,\n \"pickup_lng\": 25.9087,\n \"dest_address\": \"Customer one\",\n \"dest_lat\": -24.66,\n \"dest_lng\": 25.91,\n \"recipient_name\": \"Neo\",\n \"recipient_phone\": \"+26771234567\",\n \"items\": [\n {\n \"name\": \"Chicken wrap\",\n \"qty\": 2\n }\n ],\n \"driver_tip\": 10\n },\n {\n \"external_reference\": \"SHOP-1003\",\n \"pickup_address\": \"Your kitchen\",\n \"pickup_lat\": -24.6541,\n \"pickup_lng\": 25.9087,\n \"dest_address\": \"Customer two\",\n \"dest_lat\": -24.662,\n \"dest_lng\": 25.912,\n \"recipient_name\": \"Kabo\",\n \"recipient_phone\": \"+26771234568\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Price a batch without booking it: per-stop fee, the alone price, the batch total and (immediate) times at the door", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/batches/estimate", "host": [ "{{baseUrl}}" ], "path": [ "business", "batches", "estimate" ], "query": [] }, "description": "Price a batch without booking it: per-stop fee, the alone price, the batch total and (immediate) times at the door", "body": { "mode": "raw", "raw": "{\n \"dispatch_mode\": \"immediate\",\n \"external_reference\": \"RUN-1001\",\n \"max_added_minutes\": 20,\n \"stops\": [\n {\n \"external_reference\": \"SHOP-1002\",\n \"pickup_address\": \"Your kitchen\",\n \"pickup_lat\": -24.6541,\n \"pickup_lng\": 25.9087,\n \"dest_address\": \"Customer one\",\n \"dest_lat\": -24.66,\n \"dest_lng\": 25.91,\n \"recipient_name\": \"Neo\",\n \"recipient_phone\": \"+26771234567\",\n \"items\": [\n {\n \"name\": \"Chicken wrap\",\n \"qty\": 2\n }\n ],\n \"driver_tip\": 10\n },\n {\n \"external_reference\": \"SHOP-1003\",\n \"pickup_address\": \"Your kitchen\",\n \"pickup_lat\": -24.6541,\n \"pickup_lng\": 25.9087,\n \"dest_address\": \"Customer two\",\n \"dest_lat\": -24.662,\n \"dest_lng\": 25.912,\n \"recipient_name\": \"Kabo\",\n \"recipient_phone\": \"+26771234568\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "One batch and its stops", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/batches/{{batch}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "batches", "{{batch}}" ], "query": [] }, "description": "One batch and its stops" } }, { "name": "Cancel one order of a batch; the rest go on", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/batches/{{batch}}/stops/{{stop}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "business", "batches", "{{batch}}", "stops", "{{stop}}", "cancel" ], "query": [] }, "description": "Cancel one order of a batch; the rest go on\n\nOnly before that order is collected. Its fee and driver tip are refunded through its own trip (trip.cancelled), batch.stop_cancelled is sent, and the driver keeps the batch's guaranteed pay. Cancelling the last open order ends the batch (batch.cancelled). Stops cannot be added to a batch.", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Customer changed their mind\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Bulky delivery", "item": [ { "name": "Price a bulky order without booking it", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/bulky/quote", "host": [ "{{baseUrl}}" ], "path": [ "business", "bulky", "quote" ], "query": [] }, "description": "Price a bulky order without booking it\n\nThe same decision a booking freezes: send the same body to /business/book and the price, vehicle and crew are identical. Merchant-supplied totals are ignored; Areye calculates them from the lines." } }, { "name": "In-store quote: get the customer's QR", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/checkouts", "host": [ "{{baseUrl}}" ], "path": [ "business", "checkouts" ], "query": [] }, "description": "In-store quote: get the customer's QR\n\nThe bulky decision priced for a customer at the counter. Returns a signed QR URL the customer opens to pay Areye directly (no account, no app); the same URL then follows the delivery. Attributed with branch_code and consultant_code. An order that needs an operations check is refused here (book it with /business/book). The merchant is not charged." } }, { "name": "Quotes, payments and deliveries", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/checkouts?status=&branch_code=", "host": [ "{{baseUrl}}" ], "path": [ "business", "checkouts" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": null }, { "key": "branch_code", "value": "", "disabled": true, "description": null } ] }, "description": "Quotes, payments and deliveries" } }, { "name": "Cancel a quote, or a paid order before collection", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/checkouts/{{reference}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "business", "checkouts", "{{reference}}", "cancel" ], "query": [] }, "description": "Cancel a quote, or a paid order before collection\n\nBefore payment: the QR stops working. After payment and before collection: the delivery is cancelled and the customer refunded, once." } }, { "name": "The versioned goods and decision contract (for API clients and shop connectors)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/bulky/schema", "host": [ "{{baseUrl}}" ], "path": [ "business", "bulky", "schema" ], "query": [] }, "description": "The versioned goods and decision contract (for API clients and shop connectors)\n\nFields are only ever added. A connector maps its product data onto goods lines and never chooses a vehicle, crew or price." } }, { "name": "Let the driver dispose of damaged or refused lines", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/bulky/authorise-disposal", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "bulky", "authorise-disposal" ], "query": [] }, "description": "Let the driver dispose of damaged or refused lines\n\nOnly lines recorded as damaged or refused. The disposal fee frozen on the order is charged once, when the driver disposes with a photo." } }, { "name": "Another attempt for goods that came back", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/bulky/redeliver", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "bulky", "redeliver" ], "query": [] }, "description": "Another attempt for goods that came back\n\nOnce the goods are back at the store: a new order for the lines not delivered or disposed of, at the redelivery percentage frozen on the original. Once per return." } }, { "name": "Accept a price raised by review", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/bulky/accept-quote", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "bulky", "accept-quote" ], "query": [] }, "description": "Accept a price raised by review\n\nAfter trip.quote_changed. The difference is charged once and the order is released to dispatch." } }, { "name": "Decline a price raised by review", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/bulky/decline-quote", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "bulky", "decline-quote" ], "query": [] }, "description": "Decline a price raised by review\n\nThe order is cancelled and what you paid is refunded." } } ] }, { "name": "Tracking", "item": [ { "name": "Live tracking (no key): position, ETA, freshness", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/trip-track/{{reference}}", "host": [ "{{baseUrl}}" ], "path": [ "trip-track", "{{reference}}" ], "query": [] }, "description": "Live tracking (no key): position, ETA, freshness\n\nPoll every poll_after_seconds (15) while is_active; stop when it is null. Slow down or pause when your screen is in the background. A tracking_url token sees its own trip's pickup, ordered stops and destination (scope \"token\"), so you can draw the route once and then move only the driver marker. A bare reference gets the privacy-reduced view (scope \"reference\": no pickup, no stops) and stops working when Areye switches reference links off after integrators have moved. location_is_fresh uses the same age limit as dispatch; an old position is still returned for continuity but must be shown as last known, never as live. Polling supplies position and ETA only: webhooks are the authoritative delivery state. Do not keep coordinates beyond the delivery." } }, { "name": "Issue a new tracking link", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/tracking-link/rotate", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "tracking-link", "rotate" ], "query": [] }, "description": "Issue a new tracking link\n\nThe previous link stops working at once (404)." } }, { "name": "Turn the tracking link off", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/tracking-link/revoke", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "tracking-link", "revoke" ], "query": [] }, "description": "Turn the tracking link off\n\nHolders of the link get 410 tracking_link_revoked. Rotate to issue a new one." } }, { "name": "Read the order chat (customer side)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/trip-chat/{{reference}}?token={{chatToken}}", "host": [ "{{baseUrl}}" ], "path": [ "trip-chat", "{{reference}}" ], "query": [ { "key": "token", "value": "{{chatToken}}", "disabled": false, "description": "chat_token from the booking response" } ] }, "description": "Read the order chat (customer side)" } }, { "name": "Send a message as the customer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/trip-chat/{{reference}}", "host": [ "{{baseUrl}}" ], "path": [ "trip-chat", "{{reference}}" ], "query": [] }, "description": "Send a message as the customer", "body": { "mode": "raw", "raw": "{\n \"token\": \"{{chatToken}}\",\n \"message\": \"I am at the gate\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Documents", "item": [ { "name": "Pick list PDF (before packing)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/pick-list", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "pick-list" ], "query": [] }, "description": "Pick list PDF (before packing)\n\nFor the picker or shopper: items grouped by store, then aisle (send order_payload.items.*.aisle or category), with quantity, barcode / SKU, the substitution preference, tick boxes, the order number, the store and the pickup time. Never prices, never a delivery or pickup code. A shop order (shopping block) lists every store in its shopping sequence." } }, { "name": "Packing slip PDF (goes in the box)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/trips/{{trip}}/packing-slip?pieces=", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips", "{{trip}}", "packing-slip" ], "query": [ { "key": "pieces", "value": "", "disabled": true, "description": "Boxes in this order: one page per box, \"n of N\" (default order_payload.pieces, else 1)" } ] }, "description": "Packing slip PDF (goes in the box)\n\nOrder number and QR, sender and recipient (first names and surname), delivery address, items ordered against packed, substitutions made (original \u2192 substitute), items missing (refunded), piece n of N, your returns note, a signature line and the date. For a merchant order send items.*.qty_packed and items.*.substitute when packed; otherwise the packed column is left to fill in by hand. A shop order's slip carries the final outcome of every line and is ready once the basket is collected. Prices print only when show_prices is on (PUT /business/packing-slip-settings). Never a delivery or pickup code." } }, { "name": "Every stop's packing slip in one PDF (optionally with labels)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/batches/{{batch}}/packing-slips?with_labels=", "host": [ "{{baseUrl}}" ], "path": [ "business", "batches", "{{batch}}", "packing-slips" ], "query": [ { "key": "with_labels", "value": "", "disabled": true, "description": "1: each slip ends in a cut-off label (QR custody code + order number); needs the scanning add-on" } ] }, "description": "Every stop's packing slip in one PDF (optionally with labels)" } }, { "name": "Packing slip settings", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/packing-slip-settings", "host": [ "{{baseUrl}}" ], "path": [ "business", "packing-slip-settings" ], "query": [] }, "description": "Packing slip settings" } }, { "name": "Change the packing slip settings", "request": { "method": "PUT", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/packing-slip-settings", "host": [ "{{baseUrl}}" ], "path": [ "business", "packing-slip-settings" ], "query": [] }, "description": "Change the packing slip settings" } }, { "name": "Courier shipment packing slip (one page per piece)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/shipments/{{reference}}/packing-slip", "host": [ "{{baseUrl}}" ], "path": [ "business", "shipments", "{{reference}}", "packing-slip" ], "query": [] }, "description": "Courier shipment packing slip (one page per piece)\n\nEach page says what is in that piece (send parcels.*.contents when booking) and lists the whole consignment. A courier client uses GET /client/shipments/{waybill}/packing-slip for its own shipments." } } ] }, { "name": "Sandbox", "item": [ { "name": "LIVE: may this account have sandbox credentials, and has it?", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox" ], "query": [] }, "description": "LIVE: may this account have sandbox credentials, and has it?" } }, { "name": "LIVE: create or rotate this account's sandbox credentials (shown once)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox/credentials", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox", "credentials" ], "query": [] }, "description": "LIVE: create or rotate this account's sandbox credentials (shown once)\n\nCreates a sandbox twin of the account with its own sk_sandbox_ key, webhook secret and an enabled Storefront grant. Calling again rotates them. Portal admins and API keys only." } }, { "name": "SANDBOX: sign up as a developer (emails a 6-digit code)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/signup", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "signup" ], "query": [] }, "description": "SANDBOX: sign up as a developer (emails a 6-digit code)" } }, { "name": "SANDBOX: exchange the code for a sandbox key (shown once)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sandbox/signup/verify", "host": [ "{{baseUrl}}" ], "path": [ "sandbox", "signup", "verify" ], "query": [] }, "description": "SANDBOX: exchange the code for a sandbox key (shown once)" } }, { "name": "SANDBOX: the simulated driver takes one real step on a trip", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox/trips/{{reference}}/{{action}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox", "trips", "{{reference}}", "{{action}}" ], "query": [] }, "description": "SANDBOX: the simulated driver takes one real step on a trip\n\nEach step is the driver app's own action, so it fires the real webhooks with the real payloads. assign_driver \u2192 trip.accepted; arrive_pickup (no webhook for a delivery); pick_up \u2192 trip.picked_up; arrive_dropoff; deliver (delivery code, ID check, proof photo and signature, COD) \u2192 trip.completed delivery_outcome \"delivered\"; fail_delivery {reason} \u2192 trip.delivery_failed; id_refused {reason} \u2192 trip.age_verification_failed; complete_return \u2192 trip.completed delivery_outcome \"returned\" with return_reason; cancel_by_driver {reason}. Out of order: 409 driver_not_assigned / no_return_in_progress, or the driver app's own refusal." } }, { "name": "SANDBOX: the simulated driver's settings", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox/autopilot", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox", "autopilot" ], "query": [] }, "description": "SANDBOX: the simulated driver's settings" } }, { "name": "SANDBOX: run every new booking through a scenario on its own", "request": { "method": "PUT", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox/autopilot", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox", "autopilot" ], "query": [] }, "description": "SANDBOX: run every new booking through a scenario on its own\n\nOne booking only: send \"sandbox_scenario\" on POST /business/book instead (refused on live)." } }, { "name": "SANDBOX: point your webhooks at the built-in inbox", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox/inbox", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox", "inbox" ], "query": [] }, "description": "SANDBOX: point your webhooks at the built-in inbox" } }, { "name": "SANDBOX: read what was delivered (exact body and signed headers)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox/inbox?limit=&after_id=", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox", "inbox" ], "query": [ { "key": "limit", "value": "", "disabled": true, "description": null }, { "key": "after_id", "value": "", "disabled": true, "description": null } ] }, "description": "SANDBOX: read what was delivered (exact body and signed headers)" } }, { "name": "SANDBOX: set a test wallet balance (to try the reserve and insufficient-funds refusals)", "request": { "method": "PUT", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox/wallet", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox", "wallet" ], "query": [] }, "description": "SANDBOX: set a test wallet balance (to try the reserve and insufficient-funds refusals)" } }, { "name": "Sandbox only: move the simulated tow operator one step", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/sandbox/tow/{{reference}}/{{action}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "sandbox", "tow", "{{reference}}", "{{action}}" ], "query": [] }, "description": "Sandbox only: move the simulated tow operator one step" } } ] }, { "name": "Account", "item": [ { "name": "Your account: settings, services, wallet summary, portal_role and principal", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/profile", "host": [ "{{baseUrl}}" ], "path": [ "business", "profile" ], "query": [] }, "description": "Your account: settings, services, wallet summary, portal_role and principal" } }, { "name": "Update company details, webhook_url or the low-balance alert level", "request": { "method": "PATCH", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/profile", "host": [ "{{baseUrl}}" ], "path": [ "business", "profile" ], "query": [] }, "description": "Update company details, webhook_url or the low-balance alert level\n\nwebhook_url must be a public HTTPS address (422 webhook_url_unsafe). A changed webhook address is recorded and emailed to the account owner. A coordinator is refused (403 portal_admin_only)." } }, { "name": "API key metadata (key_preview = last four characters of the key you hold) and your webhook secret", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/api-key", "host": [ "{{baseUrl}}" ], "path": [ "business", "api-key" ], "query": [] }, "description": "API key metadata (key_preview = last four characters of the key you hold) and your webhook secret" } }, { "name": "Stage a new API key (shown once; traffic is unchanged)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/api-key/regenerate", "host": [ "{{baseUrl}}" ], "path": [ "business", "api-key", "regenerate" ], "query": [] }, "description": "Stage a new API key (shown once; traffic is unchanged)" } }, { "name": "Stage a new webhook secret (traffic is unchanged)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/webhook-secret/regenerate", "host": [ "{{baseUrl}}" ], "path": [ "business", "webhook-secret", "regenerate" ], "query": [] }, "description": "Stage a new webhook secret (traffic is unchanged)" } }, { "name": "Activate a staged api or webhook credential; old stays valid for 24 hours", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/credentials/{{kind}}/activate", "host": [ "{{baseUrl}}" ], "path": [ "business", "credentials", "{{kind}}", "activate" ], "query": [] }, "description": "Activate a staged api or webhook credential; old stays valid for 24 hours" } }, { "name": "Discard a staged api or webhook credential with an audit reason", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/credentials/{{kind}}/discard-staged", "host": [ "{{baseUrl}}" ], "path": [ "business", "credentials", "{{kind}}", "discard-staged" ], "query": [] }, "description": "Discard a staged api or webhook credential with an audit reason" } }, { "name": "Emergency-retire the previous credential before its 24-hour expiry (reason required)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/credentials/{{kind}}/retire-previous", "host": [ "{{baseUrl}}" ], "path": [ "business", "credentials", "{{kind}}", "retire-previous" ], "query": [] }, "description": "Emergency-retire the previous credential before its 24-hour expiry (reason required)" } }, { "name": "Restore the unexpired previous credential (reason required)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/credentials/{{kind}}/rollback", "host": [ "{{baseUrl}}" ], "path": [ "business", "credentials", "{{kind}}", "rollback" ], "query": [] }, "description": "Restore the unexpired previous credential (reason required)" } }, { "name": "Send a signed webhook.test event (V1, V2 and V3/key-id signatures) to your webhook URL", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/webhook-test", "host": [ "{{baseUrl}}" ], "path": [ "business", "webhook-test" ], "query": [] }, "description": "Send a signed webhook.test event (V1, V2 and V3/key-id signatures) to your webhook URL" } }, { "name": "Your recent webhook deliveries and their outcome (including refused ones)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/webhooks/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "business", "webhooks", "deliveries" ], "query": [] }, "description": "Your recent webhook deliveries and their outcome (including refused ones)" } }, { "name": "Re-send an exhausted delivery (same event id and bytes)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/webhooks/deliveries/{{eventId}}/replay", "host": [ "{{baseUrl}}" ], "path": [ "business", "webhooks", "deliveries", "{{eventId}}", "replay" ], "query": [] }, "description": "Re-send an exhausted delivery (same event id and bytes)" } }, { "name": "Wallet balances and billing type", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/wallet", "host": [ "{{baseUrl}}" ], "path": [ "business", "wallet" ], "query": [] }, "description": "Wallet balances and billing type" } }, { "name": "Wallet ledger: debits, credits and top-ups", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/wallet/transactions", "host": [ "{{baseUrl}}" ], "path": [ "business", "wallet", "transactions" ], "query": [] }, "description": "Wallet ledger: debits, credits and top-ups" } }, { "name": "Cash on delivery: fee, settlement cycle, netting, unsettled amount and ledger entries", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/cod/ledger", "host": [ "{{baseUrl}}" ], "path": [ "business", "cod", "ledger" ], "query": [] }, "description": "Cash on delivery: fee, settlement cycle, netting, unsettled amount and ledger entries" } }, { "name": "Cash on delivery settlements: {id, reference, period_start, period_end, gross, fee, net, currency, status, paid_at, orders}", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/cod/settlements", "host": [ "{{baseUrl}}" ], "path": [ "business", "cod", "settlements" ], "query": [] }, "description": "Cash on delivery settlements: {id, reference, period_start, period_end, gross, fee, net, currency, status, paid_at, orders}" } } ] }, { "name": "Fleet partner", "item": [ { "name": "Fixed-rent vehicles behind or paused: fee_status, arrears_amount, arrears_periods, arrears_since, last_collection, next_due_on, driver", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/arrears", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "arrears" ], "query": [] }, "description": "Fixed-rent vehicles behind or paused: fee_status, arrears_amount, arrears_periods, arrears_since, last_collection, next_due_on, driver" } }, { "name": "Per vehicle: days_in_period, days_in_service, days_down (by reason), days_with_trips, trips, km, online_hours, utilisation_pct, earnings, fixed_fees, rto, costs, profit; totals", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/utilisation?period=&from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "utilisation" ], "query": [ { "key": "period", "value": "", "disabled": true, "description": "YYYY-MM" }, { "key": "from", "value": "", "disabled": true, "description": null }, { "key": "to", "value": "", "disabled": true, "description": null } ] }, "description": "Per vehicle: days_in_period, days_in_service, days_down (by reason), days_with_trips, trips, km, online_hours, utilisation_pct, earnings, fixed_fees, rto, costs, profit; totals" } }, { "name": "The rent ledger for one vehicle: every collection attempt (collected | partial | failed) with collected_amount and wallet_balance_after", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/collections", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "collections" ], "query": [] }, "description": "The rent ledger for one vehicle: every collection attempt (collected | partial | failed) with collected_amount and wallet_balance_after" } }, { "name": "The vehicle's rent book when the owner collects: rent_collection (areye | owner), periods (due | part_paid | paid | waived, or collected | partial | failed when Areye collects), payments with receipt numbers and where each was applied, credit, totals, and the audit trail", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/rent", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "rent" ], "query": [] }, "description": "The vehicle's rent book when the owner collects: rent_collection (areye | owner), periods (due | part_paid | paid | waived, or collected | partial | failed when Areye collects), payments with receipt numbers and where each was applied, credit, totals, and the audit trail" } }, { "name": "Record rent the owner received (owner or portal admin). Applied to the oldest open periods first; any surplus is credit for the next period. The driver is notified with the receipt number. Send idempotency_key (or an Idempotency-Key header): the same key again returns the first payment with duplicate=true.", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/rent/payments", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "rent", "payments" ], "query": [] }, "description": "Record rent the owner received (owner or portal admin). Applied to the oldest open periods first; any surplus is credit for the next period. The driver is notified with the receipt number. Send idempotency_key (or an Idempotency-Key header): the same key again returns the first payment with duplicate=true." } }, { "name": "Void a recorded payment with a reason; it is kept, marked voided, and the rent it covered is owed again", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/rent/payments/{{payment}}/void", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "rent", "payments", "{{payment}}", "void" ], "query": [] }, "description": "Void a recorded payment with a reason; it is kept, marked voided, and the rent it covered is owed again" } }, { "name": "Waive what is still owed on one owner-collected rent period, with a reason", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/rent/periods/{{collection}}/waive", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "rent", "periods", "{{collection}}", "waive" ], "query": [] }, "description": "Waive what is still owed on one owner-collected rent period, with a reason" } }, { "name": "Who collects this vehicle's rent: areye, owner, or fleet (follow the fleet setting). Applies from the next due date.", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/rent-collection", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "rent-collection" ], "query": [] }, "description": "Who collects this vehicle's rent: areye, owner, or fleet (follow the fleet setting). Applies from the next due date." } }, { "name": "The rent receipt as a PDF", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/rent-payments/{{payment}}/receipt", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "rent-payments", "{{payment}}", "receipt" ], "query": [] }, "description": "The rent receipt as a PDF" } }, { "name": "Pause a vehicle for rent: the driver is taken offline, told, and refused new ride offers", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/suspend", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "suspend" ], "query": [] }, "description": "Pause a vehicle for rent: the driver is taken offline, told, and refused new ride offers" } }, { "name": "Lift a pause; the arrears still stand", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/reinstate", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "reinstate" ], "query": [] }, "description": "Lift a pause; the arrears still stand" } }, { "name": "Open a status span: in_service (needs a driver), maintenance, off_road or available; the previous span closes", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/status", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "status" ], "query": [] }, "description": "Open a status span: in_service (needs a driver), maintenance, off_road or available; the previous span closes" } }, { "name": "The vehicle's status spans, newest first", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/status-log", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "status-log" ], "query": [] }, "description": "The vehicle's status spans, newest first" } }, { "name": "Operating costs on a vehicle; ?period=YYYY-MM or from&to, else all", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/costs?period=&from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "costs" ], "query": [ { "key": "period", "value": "", "disabled": true, "description": null }, { "key": "from", "value": "", "disabled": true, "description": null }, { "key": "to", "value": "", "disabled": true, "description": null } ] }, "description": "Operating costs on a vehicle; ?period=YYYY-MM or from&to, else all" } }, { "name": "Log a cost (service and repair rows are the maintenance log and move the odometer forward)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/costs", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "costs" ], "query": [] }, "description": "Log a cost (service and repair rows are the maintenance log and move the odometer forward)" } }, { "name": "Remove a cost line (kept on file, marked deleted)", "request": { "method": "DELETE", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/costs/{{cost}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "costs", "{{cost}}" ], "query": [] }, "description": "Remove a cost line (kept on file, marked deleted)" } }, { "name": "Fleet overview: defaults, settlement terms, counts, today and this month, outstanding fees, paperwork alerts", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet" ], "query": [] }, "description": "Fleet overview: defaults, settlement terms, counts, today and this month, outstanding fees, paperwork alerts" } }, { "name": "Payment defaults for new vehicles, settlement cadence and day, automatic payout, bank on file, work categories", "request": { "method": "PATCH", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/settings", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "settings" ], "query": [] }, "description": "Payment defaults for new vehicles, settlement cadence and day, automatic payout, bank on file, work categories\n\nAny subset of the fields. Owner, portal admin or integration key; the bank fields (fleet_bank_name, fleet_account_name, fleet_account_number, fleet_branch_code) need a signed-in owner or portal admin (403 signed_in_admin_only for a key)." } }, { "name": "Live board: every vehicle with its driver, the trip under way, tracker status and paperwork dates", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/live", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "live" ], "query": [] }, "description": "Live board: every vehicle with its driver, the trip under way, tracker status and paperwork dates\n\nA snapshot; poll every 30\u201360 seconds. online = on duty and the phone spoke to Areye in the last minutes; ready = can be given work now; lat/lng = last known position or null when stale." } }, { "name": "Completed trips on one vehicle, newest first, with the settled split per trip", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/trips?from=&to=&page=&per_page=20", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "trips" ], "query": [ { "key": "from", "value": "", "disabled": true, "description": null }, { "key": "to", "value": "", "disabled": true, "description": null }, { "key": "page", "value": "", "disabled": true, "description": null }, { "key": "per_page", "value": "20", "disabled": true, "description": null } ] }, "description": "Completed trips on one vehicle, newest first, with the settled split per trip" } }, { "name": "Your fleet drivers: documents, vehicle, online, today, wallet balance", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/drivers", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "drivers" ], "query": [] }, "description": "Your fleet drivers: documents, vehicle, online, today, wallet balance" } }, { "name": "Completed trips by one of your drivers (same shape as a vehicle's trips)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/drivers/{{driver}}/trips?from=&to=&page=", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "drivers", "{{driver}}", "trips" ], "query": [ { "key": "from", "value": "", "disabled": true, "description": null }, { "key": "to", "value": "", "disabled": true, "description": null }, { "key": "page", "value": "", "disabled": true, "description": null } ] }, "description": "Completed trips by one of your drivers (same shape as a vehicle's trips)" } }, { "name": "Invite a driver by phone (SMS with the accept link; 14 days)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/drivers/invite", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "drivers", "invite" ], "query": [] }, "description": "Invite a driver by phone (SMS with the accept link; 14 days)\n\nAn existing Areye driver joins with one tap; a new one downloads the app and signs up with that phone, which attaches them automatically. With rental_vehicle_id the vehicle is assigned on acceptance." } }, { "name": "Open and past invitations with their accept links", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/invitations", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "invitations" ], "query": [] }, "description": "Open and past invitations with their accept links" } }, { "name": "Send the invitation SMS again (at most 3 reminders)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/invitations/{{invitation}}/resend", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "invitations", "{{invitation}}", "resend" ], "query": [] }, "description": "Send the invitation SMS again (at most 3 reminders)" } }, { "name": "Cancel an open invitation", "request": { "method": "DELETE", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/invitations/{{invitation}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "invitations", "{{invitation}}" ], "query": [] }, "description": "Cancel an open invitation" } }, { "name": "Put an active fleet driver in a free vehicle", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/assign", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "assign" ], "query": [] }, "description": "Put an active fleet driver in a free vehicle" } }, { "name": "Take the driver out of a vehicle, with a reason", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/vehicles/{{vehicle}}/unassign", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "vehicles", "{{vehicle}}", "unassign" ], "query": [] }, "description": "Take the driver out of a vehicle, with a reason" } }, { "name": "Remove a driver from your fleet (status removed, reason kept; their vehicle is freed; the driver is told)", "request": { "method": "DELETE", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/drivers/{{driver}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "drivers", "{{driver}}" ], "query": [] }, "description": "Remove a driver from your fleet (status removed, reason kept; their vehicle is freed; the driver is told)" } }, { "name": "Totals for a month or a date range, per vehicle and per driver", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/summary?period=&from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "summary" ], "query": [ { "key": "period", "value": "", "disabled": true, "description": "YYYY-MM; default the current month" }, { "key": "from", "value": "", "disabled": true, "description": null }, { "key": "to", "value": "", "disabled": true, "description": null } ] }, "description": "Totals for a month or a date range, per vehicle and per driver" } }, { "name": "Your settlement statements with payout status, newest first", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/settlements", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "settlements" ], "query": [] }, "description": "Your settlement statements with payout status, newest first" } }, { "name": "One statement with every trip, vehicle and driver line; JSON, PDF or CSV", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/settlements/{{settlement}}?format=", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "settlements", "{{settlement}}" ], "query": [ { "key": "format", "value": "", "disabled": true, "description": null } ] }, "description": "One statement with every trip, vehicle and driver line; JSON, PDF or CSV" } }, { "name": "Ask Areye to pay a statement's amount to the bank on file (signed-in owner or portal admin)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/fleet/settlements/{{settlement}}/request-payout", "host": [ "{{baseUrl}}" ], "path": [ "business", "fleet", "settlements", "{{settlement}}", "request-payout" ], "query": [] }, "description": "Ask Areye to pay a statement's amount to the bank on file (signed-in owner or portal admin)\n\nCreates the same payout request as Billing \u2192 Request payout: pending until Areye pays it; the withdrawable balance (wallet less payouts already requested) must cover the amount. The statement becomes requested, then paid; a rejected or cancelled payout returns it to statement." } } ] }, { "name": "Breakdown towing", "item": [ { "name": "Tow classes, faults, destinations and payment for a point", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/options?lat=&lng=", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "options" ], "query": [ { "key": "lat", "value": "", "disabled": false, "description": null }, { "key": "lng", "value": "", "disabled": false, "description": null } ] }, "description": "Tow classes, faults, destinations and payment for a point" } }, { "name": "Price a tow before booking", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/quote", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "quote" ], "query": [] }, "description": "Price a tow before booking" } }, { "name": "Book a tow for a policyholder (retry safely with Idempotency-Key)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/jobs", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "jobs" ], "query": [] }, "description": "Book a tow for a policyholder (retry safely with Idempotency-Key)" } }, { "name": "List tows, newest first", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/jobs?stage=&from=&to=&claim_reference=&policy_number=&page=&per_page=20", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "jobs" ], "query": [ { "key": "stage", "value": "", "disabled": true, "description": null }, { "key": "from", "value": "", "disabled": true, "description": null }, { "key": "to", "value": "", "disabled": true, "description": null }, { "key": "claim_reference", "value": "", "disabled": true, "description": null }, { "key": "policy_number", "value": "", "disabled": true, "description": null }, { "key": "page", "value": "", "disabled": true, "description": null }, { "key": "per_page", "value": "20", "disabled": true, "description": null } ] }, "description": "List tows, newest first" } }, { "name": "One tow", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/jobs/{{reference}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "jobs", "{{reference}}" ], "query": [] }, "description": "One tow" } }, { "name": "Cancel (fee rules: free before assignment or within the free window; a fixed fee once a truck is on the way; a share of the call-out after arrival; not after loading)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/jobs/{{reference}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "jobs", "{{reference}}", "cancel" ], "query": [] }, "description": "Cancel (fee rules: free before assignment or within the free window; a fixed fee once a truck is on the way; a share of the call-out after arrival; not after loading)" } }, { "name": "Re-quote a new destination; send confirm=true to apply", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/jobs/{{reference}}/change-destination", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "jobs", "{{reference}}", "change-destination" ], "query": [] }, "description": "Re-quote a new destination; send confirm=true to apply" } }, { "name": "Photos (15-minute signed links, sha256), stage events and route trail", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/jobs/{{reference}}/evidence", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "jobs", "{{reference}}", "evidence" ], "query": [] }, "description": "Photos (15-minute signed links, sha256), stage events and route trail" } }, { "name": "PDF job report", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/jobs/{{reference}}/report.pdf", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "jobs", "{{reference}}", "report.pdf" ], "query": [] }, "description": "PDF job report" } }, { "name": "A live tracking link for the policyholder (optionally sent by SMS)", "request": { "method": "POST", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/jobs/{{reference}}/tracking-link", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "jobs", "{{reference}}", "tracking-link" ], "query": [] }, "description": "A live tracking link for the policyholder (optionally sent by SMS)" } }, { "name": "Monthly statement with policy number and claim reference per line", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/statements?period=¤cy=", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "statements" ], "query": [ { "key": "period", "value": "", "disabled": true, "description": "YYYY-MM" }, { "key": "currency", "value": "", "disabled": true, "description": null } ] }, "description": "Monthly statement with policy number and claim reference per line" } }, { "name": "Statement as PDF or CSV", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/statements/{{period}}.{{format}}", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "statements", "{{period}}.{{format}}" ], "query": [] }, "description": "Statement as PDF or CSV" } }, { "name": "Active tows with operator positions (live map)", "request": { "method": "GET", "header": [ { "key": "X-Business-API-Key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/business/tow/map", "host": [ "{{baseUrl}}" ], "path": [ "business", "tow", "map" ], "query": [] }, "description": "Active tows with operator positions (live map)" } } ] } ] }