{ "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": "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-10&reference=&search=&test=0&per_page=20&page=&since=&from=&to=&type=&status=", "host": [ "{{baseUrl}}" ], "path": [ "business", "trips" ], "query": [ { "key": "month", "value": "2026-10", "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 delivery batches", "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 delivery batches" } }, { "name": "Book a batch of up to 50 deliveries; 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; retry safely with external_reference or Idempotency-Key" } }, { "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": "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": "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": "Rotate your API key (the old key stops at once; the owner is emailed)", "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": "Rotate your API key (the old key stops at once; the owner is emailed)" } }, { "name": "Rotate the webhook signing secret (the owner is emailed)", "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": "Rotate the webhook signing secret (the owner is emailed)" } }, { "name": "Send a signed webhook.test event (V1 and V2 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 and V2 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}" } } ] } ] }