Auth tokens are different between sandbox and production environments.
\nFirst uses Basic Authentication. Your 'Authorization' header should look something like this (the 'Bearer' prefix is optional, and won't make a difference to the request):
\n Authorization: Bearer YOUR_API_KEY\n\nAll API request/response bodies are JSON - the content-type header for all requests must be set to application/json.
\n Content-Type: application/json\n\nAll requests to First's APIs should be HTTPS, and to either our sandbox or production environment, under the /api namespace.
\nProduction: https://api.firstdelivery.com/api/
\nSandbox: https://sandbox.firstdelivery.com/api/
\nSandbox data and authorization are ephemeral and subject to change every few months. Reach out if you need to be re-granted sandbox access!
\nFirstDelivery acts strictly as a pipe: we normalize and forward provider webhooks without altering semantics. We do not guarantee ordering, deduplication, or completeness of events.
\nFor any critical business logic (e.g., order state machines, customer notifications, financial settlement), you must combine webhook signals with polling APIs to reconcile truth.
\nRetry with backoff: use exponential backoff + jitter. Example: 1s → 2s → 4s (up to 3 retries).
\nRespect HTTP codes:
\n429 → back off, honor Retry-After.
5xx → retry.
4xx (client error) → do not retry.
Timeouts: set sensible per-request deadlines.
\nIdempotency: when possible, include idempotency keys to make retries safe.
\nTransient faults: assume intermittent provider/network issues and design for recovery.
\nReferences:
\n\nDelivered at-least-once: duplicates possible.
\nCan arrive out of sequence (e.g., DELIVERED before PICKED_UP).
May be delayed or missed entirely during provider outages or network issues.
\nProviders can retry aggressively if you don’t respond with 2xx quickly.
\nAcknowledge fast: return 2xx immediately, enqueue for async processing.
\nIdempotency: dedupe using event IDs (if available) or payload hashes.
\nDo not assume ordering: always compare event timestamp/state against your current record before applying updates.
\nExpect gaps: webhooks alone are never authoritative.
\nBecause events may be missed, delayed, or reordered:
\nImplement a polling mechanism to fetch authoritative order state.
\nUse polling to reconcile with webhook events regularly.
\nDesign downstream logic to merge webhook signals + polled truth.
\nThis is essential for business-critical workflows (order fulfillment, billing, compliance).
\nRetries: exponential backoff, honor rate limits, don’t retry 4xx.
\nWebhooks: at-least-once, out-of-order, delayed, possibly dropped.
\nPolling: mandatory to reconcile truth.
\nWebhook payloads are hints, not the source of truth.
\nResponses typically follow the format of the previous query, response codes follow typical HTTP best practices:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Making a Request","slug":"making-a-request"},{"content":"FirstDelivery API & Webhook Best Practices","slug":"firstdelivery-api-webhook-best-practices"},{"content":"Responses and Status Codes","slug":"responses-and-status-codes"}],"owner":"2850328","collectionId":"49338fb8-9897-5cdf-0ffe-ff7c4bb00c61","publishedId":"RW87qVSS","public":true,"customColor":{"top-bar":"1B273F","right-sidebar":"303030","highlight":"52AE68"},"publishDate":"2024-02-12T17:54:07.000Z"},"item":[{"name":"Platform API","item":[{"name":"Territories","item":[{"name":"Create Territory","event":[{"listen":"test","script":{"id":"e8a24196-6d64-404a-a8ec-12d546e913b4","exec":["","pm.test(\"Successful POST request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 202]);","}); "],"type":"text/javascript"}}],"id":"e485069e-704e-4ba9-a8a1-386528a2b3cf","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"mikes testaa\",\n \"shortcode\": \"PAHL\",\n \"runner_commission\": 5,\n \"auto_dispatch\": true,\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -84.39102792034079,\n 33.95189377729187\n ],\n [\n -84.41501821353695,\n 33.95091381561112\n ],\n [\n -84.4387758271438,\n 33.947983435458944\n ],\n [\n -84.46207038619055,\n 33.943131057341354\n ],\n [\n -84.48467610023073,\n 33.93640373589924\n ],\n [\n -84.50637399416374,\n 33.92786669412983\n ],\n [\n -84.52695406627284,\n 33.91760267829743\n ],\n [\n -84.54621735077312,\n 33.905711140417196\n ],\n [\n -84.5639778634478,\n 33.89230725700097\n ],\n [\n -84.58006441050702,\n 33.87752079444011\n ],\n [\n -84.59432224259055,\n 33.861494832950754\n ],\n [\n -84.60661453782244,\n 33.844384362401016\n ],\n [\n -84.6168236999679,\n 33.82635476456462\n ],\n [\n -84.62485246000432,\n 33.80758019739014\n ],\n [\n -84.63062477175282,\n 33.788241897731346\n ],\n [\n -84.63408649458894,\n 33.76852641964817\n ],\n [\n -84.63520585862256,\n 33.74862382585801\n ],\n [\n -84.63397371007004,\n 33.72872585019602\n ],\n [\n -84.6304035368112,\n 33.7090240490338\n ],\n [\n -84.6245312762983,\n 33.68970795951668\n ],\n [\n -84.61641491004595,\n 33.67096328221778\n ],\n [\n -84.60613385086107,\n 33.652970105382664\n ],\n [\n -84.59378813075895,\n 33.63590118736425\n ],\n [\n -84.57949739914682,\n 33.61992031313222\n ],\n [\n -84.56339974233799,\n 33.60518073990102\n ],\n [\n -84.54565033678375,\n 33.5918237459647\n ],\n [\n -84.52641994958314,\n 33.57997729576967\n ],\n [\n -84.505893300855,\n 33.569754833108924\n ],\n [\n -84.48426730343844,\n 33.56125421309614\n ],\n [\n -84.46174919613713,\n 33.554556782284926\n ],\n [\n -84.43855458734413,\n 33.54972661494938\n ],\n [\n -84.41490542638887,\n 33.546809912146\n ],\n [\n -84.39102792034079,\n 33.545834568743665\n ],\n [\n -84.36715041429268,\n 33.546809912146\n ],\n [\n -84.34350125333744,\n 33.54972661494938\n ],\n [\n -84.32030664454443,\n 33.554556782284926\n ],\n [\n -84.29778853724312,\n 33.56125421309614\n ],\n [\n -84.27616253982656,\n 33.569754833108924\n ],\n [\n -84.25563589109842,\n 33.57997729576967\n ],\n [\n -84.23640550389781,\n 33.5918237459647\n ],\n [\n -84.21865609834356,\n 33.60518073990102\n ],\n [\n -84.20255844153475,\n 33.61992031313222\n ],\n [\n -84.18826770992261,\n 33.63590118736425\n ],\n [\n -84.17592198982048,\n 33.652970105382664\n ],\n [\n -84.1656409306356,\n 33.67096328221778\n ],\n [\n -84.15752456438325,\n 33.68970795951668\n ],\n [\n -84.15165230387036,\n 33.7090240490338\n ],\n [\n -84.14808213061151,\n 33.72872585019602\n ],\n [\n -84.14684998205901,\n 33.74862382585801\n ],\n [\n -84.14796934609262,\n 33.76852641964817\n ],\n [\n -84.15143106892874,\n 33.788241897731346\n ],\n [\n -84.15720338067723,\n 33.80758019739014\n ],\n [\n -84.16523214071367,\n 33.82635476456462\n ],\n [\n -84.17544130285913,\n 33.844384362401016\n ],\n [\n -84.18773359809101,\n 33.861494832950754\n ],\n [\n -84.20199143017454,\n 33.87752079444011\n ],\n [\n -84.21807797723376,\n 33.89230725700097\n ],\n [\n -84.23583848990843,\n 33.905711140417196\n ],\n [\n -84.25510177440873,\n 33.91760267829743\n ],\n [\n -84.27568184651784,\n 33.92786669412983\n ],\n [\n -84.29737974045082,\n 33.93640373589924\n ],\n [\n -84.31998545449102,\n 33.943131057341354\n ],\n [\n -84.34328001353774,\n 33.947983435458944\n ],\n [\n -84.36703762714461,\n 33.95091381561112\n ],\n [\n -84.39102792034079,\n 33.95189377729187\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097400000002,\n 41.4449243\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/v3/territories","description":"A territory is a geographic zone under which merchants and runners are grouped. This gives you the ability to
\nconfigure DSP routing strategies
\napply settings to groups of runners in a given market (e.g per-order commission, block restrictions)
\napply settings to groups of restaurants in a given market (e.g alert messages)
\nIf you don't have your own drivers, you can skip this section!
\nIf you have a delivery fleet, there are multiple defaults you can set on a territory, relating to how you charge merchants, how you schedule & pay runners, and how orders are dispatched. These will typically be disregarded if you use Strategies to route orders to our DSP network.
\nIf you use our DSP network as your fleet, configuration is a lot simpler! The only default setting available is whether or not to auto-dispatch to a DSP based on your Strategy configuration when you Create an Order.
\nDepending on your spread of merchants, we recommend setting up either:
\none territory per city (if your merchants are clustered in cities)
\none territory per timezone (if merchants are spread randomly)
\nFor the DSP-only use case, the zone geojson - though required - is arbitrary and has no effect on any business logic (fleets, coverage, etc). We recommend using geojson.io to generate this value.
(Optional) Limits how many territories to fetch
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"(Optional) Sorts territories by when they were created ('asc' | 'desc')
\n","type":"text/plain"},"key":"sort","value":"asc"},{"disabled":true,"description":{"content":"(Optional) Offset value for which territories to fetch (useful if you need to paginate)
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"(Optional) Filter merchants by created date (ISO8601 Date)
\n","type":"text/plain"},"key":"since","value":""}],"variable":[]}},"response":[{"id":"7043430c-e96a-44ce-88d7-3b89a3afd0f7","name":"Get Territories","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"url":"https://habitat-market.ngrok.io/api/v3/territories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 16 Mar 2023 17:09:44 GMT"},{"key":"Etag","value":"W/\"1fee-PQZv5xElUtkOSFtynKz4beyXAVM\""},{"key":"Ngrok-Trace-Id","value":"12a59e18bcf0c93461050ec173e3da4b"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": [\n {\n \"id\": \"038009fa-e0b0-4805-bdcc-ee49a2d73925\",\n \"created_at\": \"2023-03-16T16:54:59.280Z\",\n \"name\": \"mikes testaa\",\n \"shortcode\": \"PAHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -84.39102792034079,\n 33.95189377729187\n ],\n [\n -84.41501821353695,\n 33.95091381561112\n ],\n [\n -84.4387758271438,\n 33.947983435458944\n ],\n [\n -84.46207038619055,\n 33.943131057341354\n ],\n [\n -84.48467610023073,\n 33.93640373589924\n ],\n [\n -84.50637399416374,\n 33.92786669412983\n ],\n [\n -84.52695406627284,\n 33.91760267829743\n ],\n [\n -84.54621735077312,\n 33.905711140417196\n ],\n [\n -84.5639778634478,\n 33.89230725700097\n ],\n [\n -84.58006441050702,\n 33.87752079444011\n ],\n [\n -84.59432224259055,\n 33.861494832950754\n ],\n [\n -84.60661453782244,\n 33.844384362401016\n ],\n [\n -84.6168236999679,\n 33.82635476456462\n ],\n [\n -84.62485246000432,\n 33.80758019739014\n ],\n [\n -84.63062477175282,\n 33.788241897731346\n ],\n [\n -84.63408649458894,\n 33.76852641964817\n ],\n [\n -84.63520585862256,\n 33.74862382585801\n ],\n [\n -84.63397371007004,\n 33.72872585019602\n ],\n [\n -84.6304035368112,\n 33.7090240490338\n ],\n [\n -84.6245312762983,\n 33.68970795951668\n ],\n [\n -84.61641491004595,\n 33.67096328221778\n ],\n [\n -84.60613385086107,\n 33.652970105382664\n ],\n [\n -84.59378813075895,\n 33.63590118736425\n ],\n [\n -84.57949739914682,\n 33.61992031313222\n ],\n [\n -84.56339974233799,\n 33.60518073990102\n ],\n [\n -84.54565033678375,\n 33.5918237459647\n ],\n [\n -84.52641994958314,\n 33.57997729576967\n ],\n [\n -84.505893300855,\n 33.569754833108924\n ],\n [\n -84.48426730343844,\n 33.56125421309614\n ],\n [\n -84.46174919613713,\n 33.554556782284926\n ],\n [\n -84.43855458734413,\n 33.54972661494938\n ],\n [\n -84.41490542638887,\n 33.546809912146\n ],\n [\n -84.39102792034079,\n 33.545834568743665\n ],\n [\n -84.36715041429268,\n 33.546809912146\n ],\n [\n -84.34350125333744,\n 33.54972661494938\n ],\n [\n -84.32030664454443,\n 33.554556782284926\n ],\n [\n -84.29778853724312,\n 33.56125421309614\n ],\n [\n -84.27616253982656,\n 33.569754833108924\n ],\n [\n -84.25563589109842,\n 33.57997729576967\n ],\n [\n -84.23640550389781,\n 33.5918237459647\n ],\n [\n -84.21865609834356,\n 33.60518073990102\n ],\n [\n -84.20255844153475,\n 33.61992031313222\n ],\n [\n -84.18826770992261,\n 33.63590118736425\n ],\n [\n -84.17592198982048,\n 33.652970105382664\n ],\n [\n -84.1656409306356,\n 33.67096328221778\n ],\n [\n -84.15752456438325,\n 33.68970795951668\n ],\n [\n -84.15165230387036,\n 33.7090240490338\n ],\n [\n -84.14808213061151,\n 33.72872585019602\n ],\n [\n -84.14684998205901,\n 33.74862382585801\n ],\n [\n -84.14796934609262,\n 33.76852641964817\n ],\n [\n -84.15143106892874,\n 33.788241897731346\n ],\n [\n -84.15720338067723,\n 33.80758019739014\n ],\n [\n -84.16523214071367,\n 33.82635476456462\n ],\n [\n -84.17544130285913,\n 33.844384362401016\n ],\n [\n -84.18773359809101,\n 33.861494832950754\n ],\n [\n -84.20199143017454,\n 33.87752079444011\n ],\n [\n -84.21807797723376,\n 33.89230725700097\n ],\n [\n -84.23583848990843,\n 33.905711140417196\n ],\n [\n -84.25510177440873,\n 33.91760267829743\n ],\n [\n -84.27568184651784,\n 33.92786669412983\n ],\n [\n -84.29737974045082,\n 33.93640373589924\n ],\n [\n -84.31998545449102,\n 33.943131057341354\n ],\n [\n -84.34328001353774,\n 33.947983435458944\n ],\n [\n -84.36703762714461,\n 33.95091381561112\n ],\n [\n -84.39102792034079,\n 33.95189377729187\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": false,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"1d08b5c3-36f1-4ae7-9d0e-b7e0ba171efa\",\n \"created_at\": \"2023-03-14T22:38:52.108Z\",\n \"name\": \"Philadelphia\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.23875540887481,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 40.04321413624328\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": false,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"79dd81b0-0649-487b-9af6-9c1ab0f30bba\",\n \"created_at\": \"2023-03-14T22:32:31.266Z\",\n \"name\": \"Philadelphia\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.23875540887481,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 40.04321413624328\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": null,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"0a3ef2af-9231-41ed-8768-1def8ee9a5f9\",\n \"created_at\": \"2023-03-14T22:13:46.044Z\",\n \"name\": \"Philly\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.23875540887481,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 40.04321413624328\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": null,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"a953b4be-ae6f-43f8-a77d-49be62c3fef2\",\n \"created_at\": \"2023-03-14T22:12:22.897Z\",\n \"name\": \"Philly\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.23875540887481,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 40.04321413624328\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": null,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"db93f018-36e2-416b-8196-5d3a36033440\",\n \"created_at\": \"2017-01-01T22:06:55.741Z\",\n \"name\": \"Philadelphia\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.19944190979005,\n 40.08227449035694\n ],\n [\n -75.2460479736328,\n 40.079384912479235\n ],\n [\n -75.28698921203613,\n 40.07229179232393\n ],\n [\n -75.28759002685547,\n 39.96712200067156\n ],\n [\n -75.26458740234375,\n 39.915529641706314\n ],\n [\n -75.29316902160643,\n 39.881288765222514\n ],\n [\n -75.24304389953612,\n 39.870749669137865\n ],\n [\n -75.19248962402344,\n 39.883132940527126\n ],\n [\n -75.14167785644531,\n 39.8910359871695\n ],\n [\n -75.13592720031737,\n 39.915002988576184\n ],\n [\n -75.14150619506836,\n 39.92987938065514\n ],\n [\n -75.13927459716797,\n 39.949621810595595\n ],\n [\n -75.13309478759766,\n 39.96291183776863\n ],\n [\n -75.07455825805664,\n 39.983828528239144\n ],\n [\n -75.16176223754883,\n 40.060271207785874\n ],\n [\n -75.19944190979005,\n 40.08227449035694\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -75.1673,\n 39.9532\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 1.5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": 0.05,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": null,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n }\n ],\n \"total\": 6\n}"}],"_postman_id":"09239d59-1839-4301-93b5-11d9ca77a7b4"},{"name":"Get Territory","id":"64a4d74f-ac16-40cd-9a36-84c1d6bfac66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"GET","header":[],"url":"https://habitat-market.ngrok.io/api/v3/territories/038009fa-e0b0-4805-bdcc-ee49a2d73925","urlObject":{"path":["api","v3","territories","038009fa-e0b0-4805-bdcc-ee49a2d73925"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"b417de24-0193-438e-a0cf-f1b6008f586c","name":"Get Territory","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"url":"https://habitat-market.ngrok.io/api/v3/territories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 16 Mar 2023 17:09:44 GMT"},{"key":"Etag","value":"W/\"1fee-PQZv5xElUtkOSFtynKz4beyXAVM\""},{"key":"Ngrok-Trace-Id","value":"12a59e18bcf0c93461050ec173e3da4b"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": [\n {\n \"id\": \"038009fa-e0b0-4805-bdcc-ee49a2d73925\",\n \"created_at\": \"2023-03-16T16:54:59.280Z\",\n \"name\": \"mikes testaa\",\n \"shortcode\": \"PAHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -84.39102792034079,\n 33.95189377729187\n ],\n [\n -84.41501821353695,\n 33.95091381561112\n ],\n [\n -84.4387758271438,\n 33.947983435458944\n ],\n [\n -84.46207038619055,\n 33.943131057341354\n ],\n [\n -84.48467610023073,\n 33.93640373589924\n ],\n [\n -84.50637399416374,\n 33.92786669412983\n ],\n [\n -84.52695406627284,\n 33.91760267829743\n ],\n [\n -84.54621735077312,\n 33.905711140417196\n ],\n [\n -84.5639778634478,\n 33.89230725700097\n ],\n [\n -84.58006441050702,\n 33.87752079444011\n ],\n [\n -84.59432224259055,\n 33.861494832950754\n ],\n [\n -84.60661453782244,\n 33.844384362401016\n ],\n [\n -84.6168236999679,\n 33.82635476456462\n ],\n [\n -84.62485246000432,\n 33.80758019739014\n ],\n [\n -84.63062477175282,\n 33.788241897731346\n ],\n [\n -84.63408649458894,\n 33.76852641964817\n ],\n [\n -84.63520585862256,\n 33.74862382585801\n ],\n [\n -84.63397371007004,\n 33.72872585019602\n ],\n [\n -84.6304035368112,\n 33.7090240490338\n ],\n [\n -84.6245312762983,\n 33.68970795951668\n ],\n [\n -84.61641491004595,\n 33.67096328221778\n ],\n [\n -84.60613385086107,\n 33.652970105382664\n ],\n [\n -84.59378813075895,\n 33.63590118736425\n ],\n [\n -84.57949739914682,\n 33.61992031313222\n ],\n [\n -84.56339974233799,\n 33.60518073990102\n ],\n [\n -84.54565033678375,\n 33.5918237459647\n ],\n [\n -84.52641994958314,\n 33.57997729576967\n ],\n [\n -84.505893300855,\n 33.569754833108924\n ],\n [\n -84.48426730343844,\n 33.56125421309614\n ],\n [\n -84.46174919613713,\n 33.554556782284926\n ],\n [\n -84.43855458734413,\n 33.54972661494938\n ],\n [\n -84.41490542638887,\n 33.546809912146\n ],\n [\n -84.39102792034079,\n 33.545834568743665\n ],\n [\n -84.36715041429268,\n 33.546809912146\n ],\n [\n -84.34350125333744,\n 33.54972661494938\n ],\n [\n -84.32030664454443,\n 33.554556782284926\n ],\n [\n -84.29778853724312,\n 33.56125421309614\n ],\n [\n -84.27616253982656,\n 33.569754833108924\n ],\n [\n -84.25563589109842,\n 33.57997729576967\n ],\n [\n -84.23640550389781,\n 33.5918237459647\n ],\n [\n -84.21865609834356,\n 33.60518073990102\n ],\n [\n -84.20255844153475,\n 33.61992031313222\n ],\n [\n -84.18826770992261,\n 33.63590118736425\n ],\n [\n -84.17592198982048,\n 33.652970105382664\n ],\n [\n -84.1656409306356,\n 33.67096328221778\n ],\n [\n -84.15752456438325,\n 33.68970795951668\n ],\n [\n -84.15165230387036,\n 33.7090240490338\n ],\n [\n -84.14808213061151,\n 33.72872585019602\n ],\n [\n -84.14684998205901,\n 33.74862382585801\n ],\n [\n -84.14796934609262,\n 33.76852641964817\n ],\n [\n -84.15143106892874,\n 33.788241897731346\n ],\n [\n -84.15720338067723,\n 33.80758019739014\n ],\n [\n -84.16523214071367,\n 33.82635476456462\n ],\n [\n -84.17544130285913,\n 33.844384362401016\n ],\n [\n -84.18773359809101,\n 33.861494832950754\n ],\n [\n -84.20199143017454,\n 33.87752079444011\n ],\n [\n -84.21807797723376,\n 33.89230725700097\n ],\n [\n -84.23583848990843,\n 33.905711140417196\n ],\n [\n -84.25510177440873,\n 33.91760267829743\n ],\n [\n -84.27568184651784,\n 33.92786669412983\n ],\n [\n -84.29737974045082,\n 33.93640373589924\n ],\n [\n -84.31998545449102,\n 33.943131057341354\n ],\n [\n -84.34328001353774,\n 33.947983435458944\n ],\n [\n -84.36703762714461,\n 33.95091381561112\n ],\n [\n -84.39102792034079,\n 33.95189377729187\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": false,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"1d08b5c3-36f1-4ae7-9d0e-b7e0ba171efa\",\n \"created_at\": \"2023-03-14T22:38:52.108Z\",\n \"name\": \"Philadelphia\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.23875540887481,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 40.04321413624328\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": false,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"79dd81b0-0649-487b-9af6-9c1ab0f30bba\",\n \"created_at\": \"2023-03-14T22:32:31.266Z\",\n \"name\": \"Philadelphia\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.23875540887481,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 40.04321413624328\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": null,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"0a3ef2af-9231-41ed-8768-1def8ee9a5f9\",\n \"created_at\": \"2023-03-14T22:13:46.044Z\",\n \"name\": \"Philly\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.23875540887481,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 40.04321413624328\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": null,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"a953b4be-ae6f-43f8-a77d-49be62c3fef2\",\n \"created_at\": \"2023-03-14T22:12:22.897Z\",\n \"name\": \"Philly\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.23875540887481,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 39.8813869589423\n ],\n [\n -75.05292257123028,\n 40.04321413624328\n ],\n [\n -75.23875540887481,\n 40.04321413624328\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -81.59097,\n 41.444923\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": null,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": null,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n },\n {\n \"id\": \"db93f018-36e2-416b-8196-5d3a36033440\",\n \"created_at\": \"2017-01-01T22:06:55.741Z\",\n \"name\": \"Philadelphia\",\n \"shortcode\": \"PHL\",\n \"timezone\": \"America/New_York\",\n \"zone\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -75.19944190979005,\n 40.08227449035694\n ],\n [\n -75.2460479736328,\n 40.079384912479235\n ],\n [\n -75.28698921203613,\n 40.07229179232393\n ],\n [\n -75.28759002685547,\n 39.96712200067156\n ],\n [\n -75.26458740234375,\n 39.915529641706314\n ],\n [\n -75.29316902160643,\n 39.881288765222514\n ],\n [\n -75.24304389953612,\n 39.870749669137865\n ],\n [\n -75.19248962402344,\n 39.883132940527126\n ],\n [\n -75.14167785644531,\n 39.8910359871695\n ],\n [\n -75.13592720031737,\n 39.915002988576184\n ],\n [\n -75.14150619506836,\n 39.92987938065514\n ],\n [\n -75.13927459716797,\n 39.949621810595595\n ],\n [\n -75.13309478759766,\n 39.96291183776863\n ],\n [\n -75.07455825805664,\n 39.983828528239144\n ],\n [\n -75.16176223754883,\n 40.060271207785874\n ],\n [\n -75.19944190979005,\n 40.08227449035694\n ]\n ]\n ]\n },\n \"center\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -75.1673,\n 39.9532\n ]\n },\n \"operator_id\": 1,\n \"options\": {\n \"merchant_commission\": {\n \"base\": 5.99\n },\n \"runner_commission\": {\n \"base\": 1.5,\n \"base_outside_zone\": 1.5\n },\n \"runner_scheduling\": {\n \"schedule_publish_days_out\": 6,\n \"schedule_max_callout_percent\": 0.05,\n \"hide_open_shifts\": false\n },\n \"ext_fulfillment\": {\n \"strategy_id\": \"3390e635-d510-4f51-b809-513db03d2e76\"\n },\n \"self_fulfillment\": {\n \"use_engine\": true,\n \"auto_route\": false,\n \"auto_assign\": null,\n \"auto_assign_filter_mins\": null,\n \"require_signature\": false\n }\n }\n }\n ],\n \"total\": 6\n}"}],"_postman_id":"64a4d74f-ac16-40cd-9a36-84c1d6bfac66"}],"id":"8266cd55-d837-446c-9c2a-5ac6a2ec1bc3","_postman_id":"8266cd55-d837-446c-9c2a-5ac6a2ec1bc3","description":""},{"name":"Cohorts","item":[{"name":"Get Cohorts","id":"d8d83484-73e6-4d0d-bce6-5a1494fa6cfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Gets all cohorts. You can pass these id fields as the cohort_id in a merchant create post.
Also called \"Habitats\", cohorts are groups of merchants that live under the umbrella of a territory. They can be useful for demand forecasting when using your own fleet of drivers and scheduling against forecasted delivery volume. All merchants have a cohort, though in most cases a merchant's cohort is the default cohort created with a territory.
\n","_postman_id":"9bfd8c0f-0a34-4f02-bd74-7ae2a3923eda"},{"name":"Runners","item":[{"name":"Create Runner","event":[{"listen":"prerequest","script":{"id":"a8a93a67-8b1f-48a5-9017-57ed594087b0","exec":["const randomEmail = pm.variables.replaceIn(\"Karina_Ryan@yahoo.com\");","","pm.request.body[\"email\"] = randomEmail"],"type":"text/javascript"}}],"id":"7d8e88fe-0f86-4515-99d0-989e9e763d4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"address\": \"2000 Market Street, Philadelphia PA, 19125\",\n \"email\": \"Willis1@gmail.com\",\n \"name\": \"Wilbur Koelpin\",\n \"phone\": \"747-935-7806\",\n \"transport_type\": \"car\",\n \"territory_id\": \"db93f018-36e2-416b-8196-5d3a36033440\"\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/v3/runners","description":"Creates a runner in a given territory. The id field in a successful response should be saved on your end - this needs to be sent as the runner_id field when assigning orders.
Runners are delivery personnel that can be assigned orders for when you manage your own fleet. They are users that can log in the the driver app to manage their shifts and active orders.
\n","_postman_id":"eed70a28-424b-4a92-8243-ebfd627e18aa"},{"name":"Merchants","item":[{"name":"Create Merchant","id":"f4082241-5dd8-4d00-a792-93c969fa3746","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Creates a merchant. Every order must have a merchant associated with it.
The id field in a successful response should be saved on your end - this needs to be sent as the merchant_id field when getting quotes and sending orders.
\n\n🛑 In sandbox and production, make sure to use valid U.S phone numbers. Some DSPs will reject on the basis of a phone number being 'fake' (e.g 123456789) or outside the country!
\n
The timezone of the merchant is determined by it's parent Territory
\n\n\n","urlObject":{"path":["api","vendors","2c77c710-d9a2-11ed-bffb-7df939ab8e29"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"f591a9aa-7949-482a-b307-cde1c8ffe2eb","name":"Update phone, name","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n\n \"company_address\": \"2188 E Norris St, Philadelphia\",\n \"company_name\": \"WAWA\",\n \"company_phone\": \"4433869479\"\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/vendors/c82c2dc1-db14-4962-abe0-3be7b5fcc2e6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":"Connection,Content-Encoding,Content-Type,Date,Keep-Alive,Ratelimit-Limit,Ratelimit-Policy,Ratelimit-Remaining,Ratelimit-Reset"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 29 May 2024 16:29:30 GMT"},{"key":"Etag","value":"W/\"6be-9Ow1nlssOp4NK47al6SMNesuiGg\""},{"key":"Ratelimit-Limit","value":"300"},{"key":"Ratelimit-Policy","value":"300;w=60"},{"key":"Ratelimit-Remaining","value":"296"},{"key":"Ratelimit-Reset","value":"11"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"c82c2dc1-db14-4962-abe0-3be7b5fcc2e6\",\n \"auto_accept\": true,\n \"company_address\": \"2188 E Norris St, Philadelphia\",\n \"company_email\": \"wawa@tryhabitat.com\",\n \"company_name\": \"WAWA\",\n \"company_phone\": \"2677660550\",\n \"company_type\": \"Restaurant\",\n \"diner_delivery_fee\": 5.25,\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -75.13014249999999,\n 39.9782879\n ],\n \"interpolated\": true\n },\n \"grubhub_email\": null,\n \"grubhub_password\": null,\n \"dashboard_id\": null,\n \"daas_rate\": 11,\n \"order_phone\": \"2677660550\",\n \"owner_phone\": null,\n \"pickup_details\": \"11\",\n \"pizza\": true,\n \"priority\": true,\n \"habitat\": \"627e5f1d-4e66-4533-9aac-14fbdf99b231\",\n \"prep_time\": 18,\n \"radius\": null,\n \"active_zone\": null,\n \"send_call_alerts\": true,\n \"self_delivery\": true,\n \"timezone\": \"America/New_York\",\n \"uid\": \"f3ba2c00-0331-11ef-8407-67c0cf7a3a57\",\n \"seed_demand_matrix\": null,\n \"created_at\": \"2024-04-25T18:30:55.023Z\",\n \"onboard_start\": null,\n \"archived_at\": null,\n \"yelp_phone\": null,\n \"grubhub_phone\": null,\n \"cusine_type\": null,\n \"billing_email\": \"wawa@tryhabitat.com\",\n \"stripe_id\": \"cus_OAOY0zjNyLn1mp\",\n \"completed_orders\": 0,\n \"test\": true,\n \"smart_arrival_estimates\": true,\n \"tier\": null,\n \"runner_commission\": null,\n \"billing_relationship\": true,\n \"territory_id\": \"db93f018-36e2-416b-8196-5d3a36033440\",\n \"oozo_rate\": 11,\n \"default_partner\": null,\n \"partnered\": true,\n \"operator_id\": 1,\n \"catering_price\": 11,\n \"strategy_id\": \"9a2c394d-0613-466e-ba7b-dc7d2aad527b\",\n \"default_invoice_type\": null,\n \"scheduled_price\": 11,\n \"daas_types\": [\n \"online\",\n \"cash\"\n ],\n \"auto_route_accept\": false,\n \"chat_support\": false,\n \"external_assign\": false,\n \"use_smart_arrival_estimates\": false,\n \"footer_image\": \"https://dsp-assets-first.s3.amazonaws.com/footer_merchant-c82c2dc1-db14-4962-abe0-3be7b5fcc2e6\",\n \"footer_link\": \"https://marketing.com\",\n \"header_image\": null,\n \"catering\": true,\n \"partial_volume\": false,\n \"internal_fleet\": true\n}"}],"_postman_id":"10957f41-5645-41b6-a9ed-1b54b3bc25d2"},{"name":"Get Merchants","id":"bb520e3d-cf0b-4955-8f94-8408e517a6f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"GET","header":[],"url":"https://habitat-market.ngrok.io/api/v3/merchants?limit=1&sort=asc","description":"🛑 This endpoint's URL is NOT under the /v3/ namespace, but will work with merchants created with the V3 Create Merchant endpoint above
\n
Fetch all merchants for your workspace, limited to 250 per fetch, but with pagination options.
\n","urlObject":{"path":["api","v3","merchants"],"host":["https://habitat-market.ngrok.io"],"query":[{"key":"limit","value":"1"},{"key":"sort","value":"asc"}],"variable":[]}},"response":[{"id":"92227913-8eec-42dc-bf43-d4f01af5b8a5","name":"Get Merchants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"url":{"raw":"https://habitat-market.ngrok.io/api/v3/merchants?limit=1&sort=asc","host":["https://habitat-market.ngrok.io"],"path":["api","v3","merchants"],"query":[{"key":"limit","value":"1"},{"key":"sort","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"856"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 16 Mar 2023 16:48:53 GMT"},{"key":"Etag","value":"W/\"358-sDxEVD9WbGmCu73aCE7/KG3rJG0\""},{"key":"Ngrok-Trace-Id","value":"8fc203eed3cc61c3fe92575dbbafde64"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": [\n {\n \"id\": \"66ea2921-c416-11ed-85d7-2b8b3a8b5eeb\",\n \"created_at\": \"2023-03-16T16:20:01.825Z\",\n \"name\": \"mikes test\",\n \"location\": {\n \"address\": \"2211 E Hagert St, Philadelphia, PA 19125, USA\",\n \"coordinates\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -75.1251352,\n 39.9808023\n ]\n }\n },\n \"phone\": \"12333322311\",\n \"email\": \"test-account@firstdelivey.com\",\n \"habitat\": \"4146ce29-852e-4b1d-a7a4-55699a057419\",\n \"territory\": \"a953b4be-ae6f-43f8-a77d-49be62c3fef2\",\n \"timezone\": \"America/New_York\",\n \"operator_id\": 1,\n \"archived\": null,\n \"options\": {\n \"prep_time\": 20,\n \"pickup_instructions\": null,\n \"auto_accept\": false,\n \"priority\": false\n },\n \"rates\": {\n \"daas_rate\": null,\n \"oozo_rate\": null,\n \"catering_rate\": null,\n \"scheduled_rate\": 15,\n \"diner_delivery_fee\": null,\n \"runner_commission\": null\n },\n \"billing\": {\n \"enabled\": true,\n \"stripe_id\": null,\n \"invoice_email\": \"test-account@firstdelivey.com\",\n \"invoice_default_type\": null\n }\n }\n ],\n \"total\": 18\n}"}],"_postman_id":"bb520e3d-cf0b-4955-8f94-8408e517a6f3"},{"name":"Get Merchant","id":"28c540c3-a595-4ce5-bfa1-2b5d8417938f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"GET","header":[],"url":"https://habitat-market.ngrok.io/api/v3/merchants/2c77c710-d9a2-11ed-bffb-7df939ab8e29","description":"Gets a specific merchant object given an id
\n","urlObject":{"path":["api","v3","merchants","2c77c710-d9a2-11ed-bffb-7df939ab8e29"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"bb9c1406-c63e-431e-8c9e-5f9bf346d6da","name":"Get Merchant","originalRequest":{"method":"GET","header":[],"url":"https://habitat-market.ngrok.io/api/v3/merchants/2c77c710-d9a2-11ed-bffb-7df939ab8e29"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Sucuri/Cloudproxy"},{"key":"Date","value":"Wed, 26 Apr 2023 23:14:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"798"},{"key":"Connection","value":"keep-alive"},{"key":"X-Sucuri-ID","value":"14028"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests;"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Etag","value":"W/\"31e-yyDCP/rscKx8TS+meZz23hRSEok\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Via","value":"1.1 vegur"},{"key":"X-Sucuri-Cache","value":"HIT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": {\n \"id\": \"d0924c31-5540-11ed-9c77-7f289b287406\",\n \"created_at\": \"2022-10-26T15:13:58.858Z\",\n \"name\": \"wawa\",\n \"location\": {\n \"address\": \"16 W 14th St, New York, NY 10011, USA\",\n \"coordinates\": {\n \"type\": \"Point\",\n \"coordinates\": [\n -73.99798179999999,\n 40.7376758\n ]\n }\n },\n \"phone\": \"2677660550\",\n \"email\": \"jj@gmail.com\",\n \"habitat\": \"ce3140da-9629-46aa-8509-b049667dc4f1\",\n \"territory\": \"76a558fb-2c89-42b4-a493-fafc966a5825\",\n \"timezone\": \"America/New_York\",\n \"operator_id\": 26,\n \"archived\": null,\n \"options\": {\n \"prep_time\": 20,\n \"pickup_instructions\": null,\n \"auto_accept\": true,\n \"priority\": false\n },\n \"rates\": {\n \"daas_rate\": 5.5,\n \"oozo_rate\": null,\n \"catering_rate\": 30,\n \"scheduled_rate\": 15,\n \"diner_delivery_fee\": null,\n \"runner_commission\": null\n },\n \"billing\": {\n \"enabled\": true,\n \"stripe_id\": null,\n \"invoice_email\": \"jj@gmail.com\",\n \"invoice_default_type\": null\n }\n }\n}"}],"_postman_id":"28c540c3-a595-4ce5-bfa1-2b5d8417938f"}],"id":"f3720581-508a-4668-81c0-1cf5eff880e7","_postman_id":"f3720581-508a-4668-81c0-1cf5eff880e7","description":""},{"name":"Orders","item":[{"name":"Get Provider Quotes","id":"4a1ab494-958a-449f-957d-a602a30d4bf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"merchant_id\": \"2c77c710-d9a2-11ed-bffb-7df939ab8e29\",\n \"dropoff_by\": \"2023-03-22T15:44:13.389Z\",\n \"dropoff\": {\n \"full_address\": \"2166 E Norris St., Philadelphia PA, 19125\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/v3/quotes","description":"For basic use cases, you don't. Getting provider quotes is always an optional step before placing an order. It is mostly useful if your territories and merchants are configured to use Strategies - think of the response as a 'snapshot' of what the First algorithm would do if you immediately placed the order. Breaking it down, the Quote response tells you:
\nstrategy object shows which strategy was used to determine which provider is preferredThe most common use cases for quotes are to give your end-customer:
\ndropoff address is close to the Merchant's address (at least the same city!)The quote response contains the following top-level keys:
\nquotes - successful DSP quotes, with banned DSPs filtered and sorted by your strategy's prefer ranking.all_quotes - all successful DSP quotes, including banned DSPsstrategy - prefer rankings and bans for the strategy used for the quote requestIf you are not using Dispatch Strategies:
\nthe order will appear in Dispatch under the column related to it's status
\nfrom here it can be dragged to your fleet, or Pending External Driver to send to a DSP
\nIf you are using Dispatch Strategies:
\nthe order will appear in Dispatch under Pending External Driver, with the accepted fleet's badge on it
\nonce the order is assigned to a DSP driver, it will move to that runner's row until completion
\nThe most common reasons why fleets aren't available are due to bad data:
\nUse real phone numbers for merchant and customer - many DSPs will reject on the basis of a fake phone number (and can be smart about it)
\nKeep the pickup and dropoff addresses in mind based on what you're trying to test
\nWant as many DSPs as possible? Send the pickup address next door to dropoff.
\nWant as few/no DSPs to response? Send the dropoff address several states over.
\nUber is the only DSP in our fleet network that will send webhooks in sandbox to simulate the delivery lifecycle. This effectively means that orders will not be assigned if:
\nAn non-Uber quote_id ovverride is passed into this API request
If the configured Dispatch Strategy automation results in a non-Uber DSP being selected
\nAdditionally, the timing of the assign and subsequent fulfilllment webhooks will respect the passed pickup_time / dropoff_time : we recommend passing neither when testing this functionality to expedite the webhooks.
By default, all DSP requests are sent on an ASAP basis. For scheduled orders, you can optionally pass in eitherpickup_time OR dropoff_time (not both!). Either of these dates must be greater than 20 minutes from the time of the request.
The First platform is unopinionated with the values you pass for order_total , tax and diner_delivery_fee - these will just pass through to the Order and Order Export objects for your reporting purposes.
On the other hand, subtotal and tip can have an affect when sending orders to DSPs
- subtotal - is the price of delivery items before any fees. When requesting a refund, the DSP will typically use this amount to calculate the refund total
- tip - is the driver's tip. Zero/low tips can impact fleet availability, and when accepted by a fleet, cause delays due to drivers declining the order.
Dropoff address can be passed to us in a structured dropoff object, or as a string ( dropoff.full_address). To maximize provider accept rates, we strongly recommend
- 1: passing dropoff.full_addressthat is ideally the sanitized result of a geocoding API (Mapbox, Google Maps Geocoding / Places Widget); and
- 2: using dropoff.instructions to pass any apartment number, building names, etc.
If you are using the structured object address, you should ideally use dropoff.instructions in the same way as above to maximize Provider Accept rates and overall deliverability.
You may also pass dropoff.unit if you are highly confident that this value will resolve to a geocodable address, but in our experience, passing dropoff.unit typically lowers the percentage of DSP accepts due to bad user input (e.g dropoff instructions, building names, etc in this field)
Passing the id of a quote (see Get Provider Quotes) into this request as quote_id will attempt to create a delivery with that quote's DSP, regardless of your strategy or any bans. This is useful if your end-users are able to choose a provider (e.g in the event of a cancel, hand-pick a different provider.
When sending a request with a quote_id, the order of operations is:
Attempt to create a delivery using the exact quote
\nIf the quote has expired, create a new quote/order using same provider
\nIf the provider rejects, fall back to strategy
\n\n\nIf the Quote flow is part of your end-user experience, we strongly encourage re-fetching quotes before the order is placed to minimize the possibility of changes in Provider pricing and/or availability.
\n
Quote expiration varies depending on the DSP (some don't even have the concept!) - so we stay unopinionated and don't enforce a standard. A good rule of thumb timeframe is after ~5 minutes, you may start to get quote rejection errors. For the best user experience, we recommend calling the quote endpoint a second time directly before placing the order - this allows you to let the user confirm a DSP, price, or time discrepancy before placing.
\nIf you're using External Fleet mode and Strategies - a lot can happen between validation errors, DSP rejects, etc. auto_route object will tell you what happened:
enabled indicates that EXT. FLEETS is enabled
success false means the order was not successfully routed to a DSP
errors is an array of messages that tells you what our system / DSPs rejected
Phone validation: Some providers will validate the merchant and customer phone numbers for validity and/or by country
\nAddress formatting: when passing full_address, placement of unit number, exclusion of state, zip or country, etc - can cause a Provider Reject. We highly recommend using full_address in combination with a geocoded result (e.g from Mapbox, Google APIs). Otherwise, pass us the address as an object (see fields below)
(Optional) Number of orders to limit
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"(Optional) Filter which orders to fetch by created date (ISO8601 Date)
\n","type":"text/plain"},"key":"since","value":""},{"description":{"content":"(Optional) Offset value for which batch of orders you want to fetch
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"(Optional) Sort by any field, set desc field to true for descending, false for ascending
(Optional) JSON object with more filters for grabbing specific data sets. Status values listed above, territory values are the territory IDs in your syem. Start and Stop are date strings.
\n","type":"text/plain"},"key":"filters","value":"{territories: ['territory_1', 'territory_2'], start: ', stop: null, status: ['scheduled', 'pending_merchant', 'pending_assign', 'runner_assigned', 'en_route_pickup', 'arrived_pickup', 'picked_up', 'en_route_dropoff', 'arrived_dropoff', 'completed', 'cancelled']}"}],"variable":[]}},"response":[{"id":"64adc811-b3c5-4a8a-8912-df71e2941235","name":"Get Orders","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://habitat-market.ngrok.io/api/v3/orders?limit=10&page=1","host":["https://habitat-market.ngrok.io"],"path":["api","v3","orders"],"query":[{"key":"limit","value":"10"},{"key":"page","value":"1"},{"key":"since","value":"","description":"(Optional) Filter which orders to fetch by created date (ISO8601 Date)","disabled":true},{"key":"sort","value":"asc","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Sucuri/Cloudproxy"},{"key":"Date","value":"Thu, 27 Apr 2023 16:04:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Sucuri-ID","value":"14028"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests;"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Etag","value":"W/\"39b3-xTTFZnVANUNjUR2GFwHtm2rnQZs\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 vegur"},{"key":"X-Sucuri-Cache","value":"BYPASS"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": [\n {\n \"id\": \"04391c00-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"0437bc70-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"04070f80-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:13.275Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"snackpass\",\n \"pickup_name\": \"Adalina\",\n \"pickup_address\": \"912 N State St, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"13128209000\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.8996995,\n \"pickup_lng\": -87.62853129999999,\n \"dropoff_lat\": 41.9270754,\n \"dropoff_lng\": -87.6306663,\n \"route_distance_miles\": 2.48,\n \"crow_flies_distance_miles\": 1.89,\n \"dropoff_address\": \"2401 N Lake Shore Dr, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Veniam est sit rerum consequuntur minus et assumenda.\",\n \"customer_name\": \"Elenor Kihn\",\n \"customer_phone\": \"530-350-3620 x4223\",\n \"payment_type\": \"prepaid\",\n \"pickup_estimate\": \"2022-10-11T20:20:12.956Z\",\n \"dropoff_estimate\": \"2022-10-11T20:50:12.956Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"a42ff9d1-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"04045060-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"04007fd0-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"03d30732-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:12.914Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"lezzoo\",\n \"pickup_name\": \"Dog Haus\",\n \"pickup_address\": \"205 W Wacker Dr, Chicago, IL 60606, USA\",\n \"pickup_phone\": \"13125668081\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.8864436,\n \"pickup_lng\": -87.6342963,\n \"dropoff_lat\": 41.9215739,\n \"dropoff_lng\": -87.65305230000001,\n \"route_distance_miles\": 4.25,\n \"crow_flies_distance_miles\": 2.61,\n \"dropoff_address\": \"953 W Webster Ave, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Minus perspiciatis reiciendis vitae error.\",\n \"customer_name\": \"Bryana Fahey\",\n \"customer_phone\": \"606-232-7632 x34256\",\n \"payment_type\": \"cash\",\n \"pickup_estimate\": \"2022-10-11T20:15:12.616Z\",\n \"dropoff_estimate\": \"2022-10-11T20:29:31.616Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"b6cb28d1-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"03d0bd40-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"03cc9e90-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"039f25f2-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:12.575Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"truckbux\",\n \"pickup_name\": \"The Cumin Bowl\",\n \"pickup_address\": \"831 N Sedgwick St, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"17086287803\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.8973543,\n \"pickup_lng\": -87.6385033,\n \"dropoff_lat\": 41.9285718,\n \"dropoff_lng\": -87.6420413,\n \"route_distance_miles\": 2.35,\n \"crow_flies_distance_miles\": 2.16,\n \"dropoff_address\": \"2521 N Clark St, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Omnis magni nihil ullam nesciunt optio ut et voluptatibus nostrum.\",\n \"customer_name\": \"Mittie Walsh\",\n \"customer_phone\": \"638-423-4323 x303\",\n \"payment_type\": \"catering\",\n \"pickup_estimate\": \"2022-10-11T20:25:12.276Z\",\n \"dropoff_estimate\": \"2022-10-11T20:37:42.276Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"9a3a6281-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"039c66d0-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"03982110-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"03730ce2-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:12.229Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"olo\",\n \"pickup_name\": \"Small Cheval - Wells\",\n \"pickup_address\": \"1345 N Wells St, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"13128373860\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.9070414,\n \"pickup_lng\": -87.63400759999999,\n \"dropoff_lat\": 41.9328061,\n \"dropoff_lng\": -87.6550469,\n \"route_distance_miles\": 2.28,\n \"crow_flies_distance_miles\": 2.08,\n \"dropoff_address\": \"1028 W Diversey Pkwy, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Quod deserunt tempora hic facilis.\",\n \"customer_name\": \"Anjali Jacobs\",\n \"customer_phone\": \"736.355.2731\",\n \"payment_type\": \"cash\",\n \"pickup_estimate\": \"2022-10-11T20:35:11.988Z\",\n \"dropoff_estimate\": \"2022-10-11T20:48:28.988Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"96252861-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"036fffa0-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"036b44b0-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"033e6852-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:11.937Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"eat24\",\n \"pickup_name\": \"Gussie's Handmade Italian\",\n \"pickup_address\": \"227 W North Ave, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"13129293091\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.91085409999999,\n \"pickup_lng\": -87.6359523,\n \"dropoff_lat\": 41.9260399,\n \"dropoff_lng\": -87.6404781,\n \"route_distance_miles\": 1.21,\n \"crow_flies_distance_miles\": 1.07,\n \"dropoff_address\": \"2413-15 N Clark St, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Quas nesciunt dolor explicabo sequi qui.\",\n \"customer_name\": \"Jairo Watsica\",\n \"customer_phone\": \"360-375-4401 x9328\",\n \"payment_type\": \"online\",\n \"pickup_estimate\": \"2022-10-11T20:35:11.642Z\",\n \"dropoff_estimate\": \"2022-10-11T20:41:54.642Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"921bfc31-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"033b8220-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"03376370-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"02fbe112-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:11.595Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"ninjas\",\n \"pickup_name\": \"Foxtrot\",\n \"pickup_address\": \"23 W Maple St, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"13129293175\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.9016397,\n \"pickup_lng\": -87.62929319999999,\n \"dropoff_lat\": 41.9263409,\n \"dropoff_lng\": -87.64946049999999,\n \"route_distance_miles\": 2.44,\n \"crow_flies_distance_miles\": 2,\n \"dropoff_address\": \"2429 N Lincoln Ave, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"A ut qui totam quasi consequuntur autem doloribus porro animi.\",\n \"customer_name\": \"Porter Wuckert\",\n \"customer_phone\": \"746-790-8774 x075\",\n \"payment_type\": \"cash\",\n \"pickup_estimate\": \"2022-10-11T20:25:11.206Z\",\n \"dropoff_estimate\": \"2022-10-11T20:39:11.206Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"84d453b1-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"02f8fae0-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"02f4b520-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"02c76392-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:11.158Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"olo\",\n \"pickup_name\": \"Roots Handmade Pizza - Chicago\",\n \"pickup_address\": \"1610 N Wells St, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"13122107788\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.9115057,\n \"pickup_lng\": -87.6350113,\n \"dropoff_lat\": 41.9328061,\n \"dropoff_lng\": -87.6550469,\n \"route_distance_miles\": 1.93,\n \"crow_flies_distance_miles\": 1.8,\n \"dropoff_address\": \"1028 W Diversey Pkwy, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Ipsum ad nemo est.\",\n \"customer_name\": \"Josephine Ondricka\",\n \"customer_phone\": \"899-981-2468\",\n \"payment_type\": \"cash\",\n \"pickup_estimate\": \"2022-10-11T20:45:10.863Z\",\n \"dropoff_estimate\": \"2022-10-11T20:55:37.863Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"a567b681-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"02c45650-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"02bfc270-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"029249d2-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:10.812Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"doordash\",\n \"pickup_name\": \"Alpana\",\n \"pickup_address\": \"831 N State St, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"0\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.8978021,\n \"pickup_lng\": -87.62809299999999,\n \"dropoff_lat\": 41.9326381,\n \"dropoff_lng\": -87.64215779999999,\n \"route_distance_miles\": 3.15,\n \"crow_flies_distance_miles\": 2.51,\n \"dropoff_address\": \"521 W Diversey Pkwy, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Est eligendi debitis nulla distinctio et reiciendis dolor.\",\n \"customer_name\": \"Ulises Rolfson\",\n \"customer_phone\": \"1-647-377-3852\",\n \"payment_type\": \"credit_card\",\n \"pickup_estimate\": \"2022-10-11T20:45:10.514Z\",\n \"dropoff_estimate\": \"2022-10-11T20:55:42.514Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"b8a259d1-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"028f8ab0-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"028be130-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"025cbae2-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:10.473Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"slice\",\n \"pickup_name\": \"Kababish - BBQ & Grill\",\n \"pickup_address\": \"1554 N Larrabee St, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"13122184443\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.910499,\n \"pickup_lng\": -87.643648,\n \"dropoff_lat\": 41.9267767,\n \"dropoff_lng\": -87.6409888,\n \"route_distance_miles\": 1.45,\n \"crow_flies_distance_miles\": 1.13,\n \"dropoff_address\": \"2447 N Clark St, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Ex aut sed.\",\n \"customer_name\": \"Ernesto Considine\",\n \"customer_phone\": \"(878) 616-1394 x8256\",\n \"payment_type\": \"cash\",\n \"pickup_estimate\": \"2022-10-11T20:35:10.165Z\",\n \"dropoff_estimate\": \"2022-10-11T20:42:33.165Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"85e94621-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n },\n {\n \"id\": \"02567950-49a0-11ed-bc25-1dc13eb202d3\",\n \"quote_id\": \"024fe9a0-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_id\": \"0215c6d1-49a0-11ed-bc25-1dc13eb202d3\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": null,\n \"dsps_name\": null,\n \"created_at\": \"2022-10-11T20:05:10.084Z\",\n \"status\": \"pending_assign\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/Chicago\",\n \"partner_name\": \"mealpal\",\n \"pickup_name\": \"Can't Believe It's Not Meat\",\n \"pickup_address\": \"1143 N Wells St, Chicago, IL 60610, USA\",\n \"pickup_phone\": \"13126249986\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 41.9034979,\n \"pickup_lng\": -87.6341384,\n \"dropoff_lat\": 41.9200798,\n \"dropoff_lng\": -87.6626182,\n \"route_distance_miles\": 2,\n \"crow_flies_distance_miles\": 1.86,\n \"dropoff_address\": \"2142 N Clybourn Ave, Chicago, IL 60614\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \"Aliquam enim molestiae.\",\n \"customer_name\": \"Krystal Thompson\",\n \"customer_phone\": \"885-265-7597\",\n \"payment_type\": \"online\",\n \"pickup_estimate\": \"2022-10-11T20:15:09.700Z\",\n \"dropoff_estimate\": \"2022-10-11T20:25:45.700Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": null,\n \"tip\": null,\n \"order_total\": null,\n \"runner\": null,\n \"merchant_id\": \"8e1f7a31-a7cb-11ec-b378-45e05d0a54f7\",\n \"runner_id\": null,\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 5,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null\n }\n ],\n \"total\": 108268\n}"}],"_postman_id":"918119ab-7c55-45a0-832a-49ad8841fb88"},{"name":"Get Order","id":"e7f56579-13ae-492d-bd62-d988a242c2e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"GET","header":[],"url":"https://habitat-market.ngrok.io/api/v3/orders/df5c9da0-623d-11ee-8d45-dd71e550b626","urlObject":{"path":["api","v3","orders","df5c9da0-623d-11ee-8d45-dd71e550b626"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"10bad85c-7027-4c7f-9abe-5ec69bac79d0","name":"Get Order","originalRequest":{"method":"GET","header":[],"url":"https://api.tryhabitat.com/api/v3/orders/df5c9da0-623d-11ee-8d45-dd71e550b626"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Sucuri/Cloudproxy"},{"key":"Date","value":"Thu, 27 Apr 2023 16:08:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Sucuri-ID","value":"14028"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests;"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Etag","value":"W/\"6f7-jcb16EiwZdmPl9ro2uav7IrfNKI\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Via","value":"1.1 vegur"},{"key":"X-Sucuri-Cache","value":"BYPASS"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": {\n \"id\": \"9bbd8313-da38-4b04-b14f-3cbd9a92312a\",\n \"quote_id\": \"8a5a9bd0-ad7b-11ed-a9f4-f959336bb66d\",\n \"external_order_id\": \"c05f04df-79bf-48fe-b696-53d815481d32\",\n \"external_order_reference\": null,\n \"dsps_delivery_id\": null,\n \"_request_id\": \"fake:dcbf7185-20f7-4cef-9c63-1d84824d7c09\",\n \"dsps_name\": null,\n \"created_at\": \"2023-02-15T21:56:05.697Z\",\n \"status\": \"completed\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/New_York\",\n \"partner_name\": \"olo\",\n \"pickup_name\": \"Tacodeli Gracy Farms\",\n \"pickup_address\": \"26 Broadway, New York, NY 10004, USA\",\n \"pickup_phone\": \"2333322311\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 40.7052022,\n \"pickup_lng\": -74.0131655,\n \"dropoff_lat\": 40.7056311,\n \"dropoff_lng\": -74.0131104,\n \"route_distance_miles\": 0.79,\n \"crow_flies_distance_miles\": 0.03,\n \"dropoff_address\": \"28 Broadway, New York NY, 10004\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": \" I want contactless delivery\",\n \"customer_name\": \"MICHAEL PASZKIEWICZ\",\n \"customer_phone\": \"4433869479\",\n \"payment_type\": \"online\",\n \"pickup_estimate\": \"2023-02-15T22:40:00.000Z\",\n \"dropoff_estimate\": \"2023-02-15T23:00:00.000Z\",\n \"runner_assigned_at\": \"2023-02-15T22:40:54.000Z\",\n \"runner_accepted_at\": \"2023-02-15T22:41:12.927Z\",\n \"runner_arrived_origin\": \"2023-02-15T22:41:41.382Z\",\n \"runner_picked_up\": \"2023-02-15T22:41:57.424Z\",\n \"runner_arrived_dropoff\": \"2023-02-15T22:56:15.459Z\",\n \"runner_dropped_off\": \"2023-02-15T23:00:06.776Z\",\n \"cancelled_at\": null,\n \"contents\": [\n {\n \"itemName\": \"Foosburger\",\n \"quantity\": 1\n }\n ],\n \"tip\": 3,\n \"order_total\": 5.99,\n \"runner\": {\n \"id\": \"c3ae4462-eb20-4165-a2f7-f8164ce2118e\",\n \"name\": \"test\",\n \"phone\": \"1231231116\"\n },\n \"merchant_id\": \"49d7d331-a19a-11ed-9fff-dff3e2e96892\",\n \"runner_id\": \"c3ae4462-eb20-4165-a2f7-f8164ce2118e\",\n \"skip_routing_strategy\": false,\n \"diner_delivery_fee\": null,\n \"runner_commission\": 3.25,\n \"billable_merchant_fee\": null,\n \"dsps_delivery_fee\": null,\n \"dropoff_image\": \"https://example.com/img.jpg\"\n }\n}"}],"_postman_id":"e7f56579-13ae-492d-bd62-d988a242c2e9"},{"name":"Update Order","id":"3309abde-82da-43e2-b834-fa670cf40d62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"dropoff_notes\": \"abcd\"\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/v3/orders/df5c9da0-623d-11ee-8d45-dd71e550b626","description":"Update order details
\nIf the order is assigned to a DSP, dropoff_notes is the only field that is updatable
If you operate your own fleet, and runners are not using the First Runner app, you can remotely update the status of an order, and send runner location updates, via this endpoint.
\nStatus updates can be one of those available in the Status section. To send just a runner location update, pass null as the value for status.
Attempting to update the status of an order being fulfilled by a fleet in our DSP network will return a 400 error.
\n","urlObject":{"path":["api","v3","orders","df5c9da0-623d-11ee-8d45-dd71e550b626","status"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"24dd6665-5344-4a00-9b23-7fe48ae8daa8","name":"Update Status","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"en_route_pickup\",\n \"payload\": {\n \"runner_id\": \"fe19da88-5ab9-4693-9786-ede9d8294126\",\n \"location\": {\n \"latitude\": 90,\n \"longitude\": 84\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/v3/orders/0ffeaeb0-c2bd-11ed-938e-6b0e25251d1d/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 15 Mar 2023 21:06:41 GMT"},{"key":"Etag","value":"W/\"4ef-040jTAzmDrZcmHKadUvDG41ujW8\""},{"key":"Ngrok-Trace-Id","value":"99375098bd5452fe6073148c23729232"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": {\n \"id\": \"0ffeaeb0-c2bd-11ed-938e-6b0e25251d1d\",\n \"quote_id\": \"0fef6c70-c2bd-11ed-938e-6b0e25251d1d\",\n \"external_order_id\": \"12345\",\n \"external_order_reference\": \"1234\",\n \"dsps_delivery_id\": null,\n \"_request_id\": \"243e6565-2ed4-4869-9576-ea8ef6ffa759\",\n \"dsps_name\": null,\n \"created_at\": \"2023-03-14T23:07:59.149Z\",\n \"status\": \"pending_dispatch\",\n \"method\": \"Delivery\",\n \"timezone\": \"America/New_York\",\n \"pickup_name\": \"mikes test\",\n \"pickup_address\": \"2211 E Hagert St, Philadelphia, PA 19125, USA\",\n \"pickup_phone\": \"2333322311\",\n \"pickup_instructions\": null,\n \"pickup_lat\": 39.98,\n \"pickup_lng\": -75.13,\n \"dropoff_lat\": 39.98,\n \"dropoff_lng\": -75.13,\n \"route_distance_miles\": 0.67,\n \"dropoff_address\": \"2166 E Norris St., Philadelphia PA, 19125\",\n \"dropoff_suite\": null,\n \"dropoff_instructions\": null,\n \"customer_name\": \"Steve\",\n \"customer_phone\": \"2333344999\",\n \"payment_type\": \"credit_card\",\n \"pickup_estimate\": \"2023-03-14T23:27:58.553Z\",\n \"dropoff_estimate\": \"2023-03-14T23:32:58.553Z\",\n \"runner_assigned_at\": null,\n \"runner_accepted_at\": null,\n \"runner_arrived_origin\": null,\n \"runner_picked_up\": null,\n \"runner_arrived_dropoff\": null,\n \"runner_dropped_off\": null,\n \"cancelled_at\": null,\n \"contents\": [\n {\n \"itemName\": \"Cheeszteak\"\n }\n ],\n \"tip\": 2,\n \"order_total\": 9,\n \"runner\": null,\n \"merchant_id\": \"c9c8be91-c2bc-11ed-938e-6b0e25251d1d\",\n \"runner_id\": null\n }\n}"}],"_postman_id":"c8a154d0-a76c-462a-bfd8-2d83da98a450"},{"name":"Get Fulfillment Status","id":"d63f150e-4bb8-4acb-bc34-e824042afa53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"GET","header":[],"url":"https://habitat-market.ngrok.io/api/v3/orders/df5c9da0-623d-11ee-8d45-dd71e550b626/status","urlObject":{"path":["api","v3","orders","df5c9da0-623d-11ee-8d45-dd71e550b626","status"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"a7ecd70b-52b5-46d3-83bc-76aad8bda0f9","name":"Get Fulfillment Status","originalRequest":{"method":"GET","header":[],"url":"https://habitat-market.ngrok.io/api/v3/orders/df5c9da0-623d-11ee-8d45-dd71e550b626/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"248"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Apr 2023 13:19:09 GMT"},{"key":"Etag","value":"W/\"f8-OA2wSOrSNt9mfA0loLI9AEWSFm8\""},{"key":"Ngrok-Trace-Id","value":"4b057863898248aa4a828fa41269cea3"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"orderNumber\": 1234,\n \"status\": \"Delivered\",\n \"estimatedPickupTime\": \"2023-04-05T14:17:41.180Z\",\n \"estimatedDropoffTime\": \"2023-04-05T14:37:41.180Z\",\n \"driverName\": \"enrique25 \",\n \"driverPhoneNumber\": \"3953521378\",\n \"transportType\": \"Car\",\n \"latitude\": 0,\n \"longitude\": 0\n}"}],"_postman_id":"d63f150e-4bb8-4acb-bc34-e824042afa53"},{"name":"Cancel Order","id":"92e6c1a9-ca6c-4856-a74f-ce0b3b46dcbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reason\": \"DestinationUnreachable\",\n\t\"reasonComments\": \"Driver called and rang, no response after 5 minutes\"\n}"},"url":"https://habitat-market.ngrok.io/api/orders/2f3385e0-981e-11ed-954d-c32dcb0a5fb2/cancel","description":"Cancel an order before it has been fulfilled. If you are using our DSP Fleet network, orders can only be cancelled before the driver has picked up the food.
\nRefund reasons, listed below, are often used in the case of a refund request with a DSP. You don't need to support every single case, but best practice would be to support every one you can.
\n","urlObject":{"path":["api","orders","2f3385e0-981e-11ed-954d-c32dcb0a5fb2","cancel"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"27679eee-5d8a-43a3-bf76-43fc8cd5f2a8","name":"Cancel order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reason\": \"DestinationUnreachable\",\n\t\"reasonComments\": \"Driver called and rang, no response after 5 minutes\"\n}"},"url":"https://habitat-market.ngrok.io/api/orders/df5c9da0-623d-11ee-8d45-dd71e550b626/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 24 Mar 2023 18:57:30 GMT"},{"key":"Etag","value":"W/\"b7-e3Mi6fWb7/e5i1KJ/ATDBqJoVcg\""},{"key":"Ngrok-Trace-Id","value":"663ed9d47c6be8ab5a504a36cc32c448"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": {\n \"order_id\": \"a944dbc0-ca75-11ed-8f65-cfb250471e45\",\n \"reason\": \"DestinationUnreachable\",\n \"reason_comments\": \"Driver called and rang, no response after 5 minutes\"\n }\n}"}],"_postman_id":"92e6c1a9-ca6c-4856-a74f-ce0b3b46dcbb"}],"id":"18544d27-f452-4f5e-858e-c47a5edf3271","_postman_id":"18544d27-f452-4f5e-858e-c47a5edf3271","description":""},{"name":"Strategies","item":[{"name":"Create Dispatch Strategy","id":"7e8dd905-f356-4776-b6b2-f994984aeb1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"strategy\": {\n \"tie_breaker\": \"cheapest\",\n \"name\": \"Cheapest test\",\n \"default\": true\n },\n \"strategy_providers\": [\n {\n \"name\": \"relay\",\n \"type\": \"ban\",\n \"index\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/v3/strategies","description":"Strategies allow you to configure ranked preferences for which DSPs should receive an order, based on several parameters. Our algorithm determines the strategy based on this order:
\nWe then use this ranked list to request the delivery from the top down (i_.e in the case that the 'top' DSP rejects the order, we move to the next one)_
\nCreating a Strategy is currently not available via API - go to your Dispatch Settings to configure DSP routing strategies on a per-territory and per-merchant basis
\n","urlObject":{"path":["api","v3","strategies"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"b41d2146-feee-4fe0-aeaf-92598c852bf7","name":"Create Dispatch Strategy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"url":"https://habitat-market.ngrok.io/api/v3/strategies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"265"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 16 Mar 2023 22:05:23 GMT"},{"key":"Etag","value":"W/\"109-lr/iMCnR5a0RcgZ0Ne/Vz/gWVjk\""},{"key":"Ngrok-Trace-Id","value":"e11033f47dc86d198b88732a14c41085"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": {\n \"strategies\": [\n {\n \"id\": \"3390e635-d510-4f51-b809-513db03d2e76\",\n \"operator_id\": 1,\n \"default\": true,\n \"tie_breaker\": \"cheapest\",\n \"name\": \"Default (Cheapest)\"\n }\n ],\n \"strategy_providers\": [],\n \"providers\": [\n \"doordash\",\n \"uber\",\n \"ally\",\n \"relay\",\n \"cutcats\",\n \"quickness\"\n ]\n }\n}"}],"_postman_id":"7e8dd905-f356-4776-b6b2-f994984aeb1d"},{"name":"Replace Strategy Schedule","id":"dcff189b-38e7-4768-9fe0-cc61777c1a7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[{\n \"start\": {\n \"day\": \"tuesday\",\n \"hour\": 10.5\n },\n \"stop\": {\n \"day\": \"tuesday\",\n \"hour\": 22.5\n }\n}, {\n \"start\": {\n \"day\": \"wednesday\",\n \"hour\": 10.5\n },\n \"stop\": {\n \"day\": \"wednesday\",\n \"hour\": 22.5\n }\n}, {\n \"start\": {\n \"day\": \"thursday\",\n \"hour\": 10.5\n },\n \"stop\": {\n \"day\": \"thursday\",\n \"hour\": 22.5\n }\n}, {\n \"start\": {\n \"day\": \"friday\",\n \"hour\": 10.5\n },\n \"stop\": {\n \"day\": \"friday\",\n \"hour\": 22.5\n }\n}, {\n \"start\": {\n \"day\": \"saturday\",\n \"hour\": 10.5\n },\n \"stop\": {\n \"day\": \"saturday\",\n \"hour\": 22.5\n }\n}] ","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/dispatch/strategies_hours/3dacee10-c99c-4ef2-92b5-4f67abf23744","urlObject":{"path":["api","dispatch","strategies_hours","3dacee10-c99c-4ef2-92b5-4f67abf23744"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"dcff189b-38e7-4768-9fe0-cc61777c1a7b"},{"name":"Get Dispatch Strategies","id":"d10a5408-1cd0-4e09-bd57-0bc5752a9a81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"GET","header":[],"url":"https://habitat-market.ngrok.io/api/v3/strategies","description":"Get all Strategies
\nStrategies are also configurable via dispatch - check Dispatch Settings to configure DSP routing strategies on a per-territory and per-merchant basis
\n","urlObject":{"path":["api","v3","strategies"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"ad0d7339-0763-47e7-89f1-53951a248a67","name":"Get Dispatch Strategy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"url":"https://habitat-market.ngrok.io/api/v3/strategies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"265"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 16 Mar 2023 22:05:23 GMT"},{"key":"Etag","value":"W/\"109-lr/iMCnR5a0RcgZ0Ne/Vz/gWVjk\""},{"key":"Ngrok-Trace-Id","value":"e11033f47dc86d198b88732a14c41085"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": {\n \"strategies\": [\n {\n \"id\": \"3390e635-d510-4f51-b809-513db03d2e76\",\n \"operator_id\": 1,\n \"default\": true,\n \"tie_breaker\": \"cheapest\",\n \"name\": \"Default (Cheapest)\"\n }\n ],\n \"strategy_providers\": [],\n \"providers\": [\n \"doordash\",\n \"uber\",\n \"ally\",\n \"relay\",\n \"cutcats\",\n \"quickness\"\n ]\n }\n}"}],"_postman_id":"d10a5408-1cd0-4e09-bd57-0bc5752a9a81"},{"name":"(BETA) Get Strategy Schedule","id":"b842f9e1-b50b-44ab-a7cd-7efda8941890","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"b842f9e1-b50b-44ab-a7cd-7efda8941890"},{"name":"(BETA) Remove Strategy Schedule","id":"debb393c-c27c-47f1-b2f2-f4bac449989b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"DELETE","header":[],"url":"https://habitat-market.ngrok.io/api/dispatch/strategies_hours/263091ef-2f98-4f40-85e4-a44065ecd837","urlObject":{"path":["api","dispatch","strategies_hours","263091ef-2f98-4f40-85e4-a44065ecd837"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"debb393c-c27c-47f1-b2f2-f4bac449989b"},{"name":"Append To Strategy Schedule","id":"59bcd98a-683d-4829-8461-07eb244adbe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"start\": {\n \"day\": \"wednesday\",\n \"hour\": 12.75\n },\n \"stop\": {\n \"day\": \"wednesday\",\n \"hour\": 15\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/dispatch/strategies_hours/263091ef-2f98-4f40-85e4-a44065ecd837","description":"Add ranges of hours for which a strategy is INACTIVE, meaning that the strategy will not be executed during those hours, and order must be manually placed with an external DSP by a dispatcher.
\nNo conversion necessary for hour values - we interpret these on the fly during a request, converting the respective ranges and timestamp to UTC.
\n","urlObject":{"path":["api","dispatch","strategies_hours","263091ef-2f98-4f40-85e4-a44065ecd837"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"59bcd98a-683d-4829-8461-07eb244adbe0"}],"id":"7b6b5558-b768-41cf-8312-ea37637a6e69","_postman_id":"7b6b5558-b768-41cf-8312-ea37637a6e69","description":""},{"name":"Webhooks","item":[{"name":"Create Webhook","id":"4f2a91dc-42a6-40f2-a5d4-37187727e91f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{ACCESS_TOKEN_ADMIN}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://first-delivery.ngrok.io/webhooks\"\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/webhooks","description":"There are a few ways you can set these up to work, but usually just the URL is all you need:
\nThe url field can take a placeholder value that we will replace with the First order.id -
http_options allows you to pass custom headers like Authorization (don't worry, we encrypt these!)
event_filters Allow you to selectively send webhooks dependent on the status (see Order Statuses for event definitions)
Check out the 'Examples' dropdown in the top right corner to see the different types of payloads.
\n","urlObject":{"path":["api","webhooks"],"host":["https://habitat-market.ngrok.io"],"query":[],"variable":[]}},"response":[{"id":"e0555e60-3846-43cf-8fe1-516632575c61","name":"all webhooks to basic URL","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://webhooks.firstdelivery.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"232"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 17 Mar 2023 17:51:42 GMT"},{"key":"Etag","value":"W/\"e8-LN54qXeNJKnaULQi1Qo7UyeOV8g\""},{"key":"Ngrok-Trace-Id","value":"d99718864c4be3232ee0326b7eb182bf"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"webhook\": {\n \"id\": \"30202232-d3ae-4840-ab20-d6cb5a379b95\",\n \"created_at\": \"2023-03-17 17:51:42.790555+00\",\n \"operator_id\": 1,\n \"url\": \"https://webhooks.firstdelivery.com\",\n \"http_options\": null,\n \"active\": true,\n \"event_filter\": null\n }\n}"},{"id":"183052a6-04fd-4389-9369-29eaec460d22","name":"with First OrderID in URL","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://webhooks.firstdelivery.com/orders/$\"\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"233"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 17 Mar 2023 18:14:08 GMT"},{"key":"Etag","value":"W/\"e9-RIVy6xSVZZcgEAoX0XFGy10856E\""},{"key":"Ngrok-Trace-Id","value":"0dd833b38cb06b27f7d8f5f6ace17dc3"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"webhook\": {\n \"id\": \"42e1f7b7-09db-4008-8a77-8729f549c922\",\n \"created_at\": \"2023-03-17 18:14:08.707849+00\",\n \"event_filter\": null,\n \"url\": \"https://webhooks.firstdelivery.com/orders/${ORDER_ID}\",\n \"active\": true,\n \"http_options\": {}\n }\n}"},{"id":"6eb58811-d1e2-4096-baaa-a581c5ef4f5a","name":"on select events","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://webhooks.firstdelivery.com\",\n \"event_filter\": [\"cancelled\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"241"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 17 Mar 2023 17:52:58 GMT"},{"key":"Etag","value":"W/\"f1-y7L4g8sVilOojPDd16AxR2qUKJo\""},{"key":"Ngrok-Trace-Id","value":"2fcd8fa2dacdd838bf1342747575211a"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"webhook\": {\n \"id\": \"885af834-36a9-46ce-a9cc-8cb9ee196732\",\n \"created_at\": \"2023-03-17 17:52:58.984459+00\",\n \"operator_id\": 1,\n \"url\": \"https://webhooks.firstdelivery.com\",\n \"http_options\": null,\n \"active\": true,\n \"event_filter\": [\n \"cancelled\"\n ]\n }\n}"},{"id":"622dc135-3bb4-49fe-aaa9-551c3400d8da","name":"with auth headers","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{ACCESS_TOKEN_ADMIN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://webhooks.firstdelivery.com\",\n \"http_options\": {\n \"headers\": {\n \"Authorization\": \"YOUR_SERVER_ACCESS_TOKEN\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://habitat-market.ngrok.io/api/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"268"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 17 Mar 2023 18:09:07 GMT"},{"key":"Etag","value":"W/\"10c-aw1yI6SmkpAFbiRfkh2/xwcR4b4\""},{"key":"Ngrok-Trace-Id","value":"a8dbfb0cba496f33e99d978b62b79fbf"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"webhook\": {\n \"id\": \"071c80b3-39e0-4c99-81f2-4703668bfcde\",\n \"created_at\": \"2023-03-17 18:09:07.556135+00\",\n \"event_filter\": null,\n \"url\": \"https://webhooks.firstdelivery.com\",\n \"active\": true,\n \"http_options\": {\n \"headers\": {\n \"Authorization\": \"YOUR_SERVER_ACCESS_TOKEN\"\n }\n }\n }\n}"}],"_postman_id":"4f2a91dc-42a6-40f2-a5d4-37187727e91f"}],"id":"8f44ae28-6d58-4939-9de7-054575808d57","description":"First's webhooks are a normalized pass-through of what the DSP emits to First - therefore, we are currently unable to guarantee exact sequencing, accuracy, and deliverability of webhooks (we just format and pass them along). Less than 1% of orders are affected.
\nFor this reason, if you are relying on webhooks to execute business-critical logic when status changes, we strongly reccommend first sanity checking against your internal status, and/or use polling in combination.
Runner location updates will come in with the last observed status (or new status) - not a distinct status like LocationUpdate
status_v3 is the same as status on any /v3/orders endpoint, and currently reccommended over status, which is less granular and to be deprecated.
cancel_details.reason is the raw DSP-specific cancel code
Example of a happy-path from creation to completion:
\n{\n \"status\": \"Pending\",\n \"orderId\": \"57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"status_v3\": \"scheduled\",\n \"externalId\": \"963360\", //your passed in `external_id`\n \"orderNumber\": 3893,\n \"trackerLink\": \"https://ordertracker.delivery/?orderId=57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"dspTrackerLink\": \"https://track.doordash.com/order/0e38c90e-3959-4047-a3af-8e06ec4387c9/track\",\n \"estimatedPickupTime\": \"2024-10-25T12:09:52.142Z\",\n \"estimatedDropoffTime\": \"2024-10-25T12:19:52.142Z\"\n}\n{\n \"status\": \"Assigned\",\n \"orderId\": \"57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"latitude\": 40.7254627,\n \"longitude\": -73.4833305,\n \"status_v3\": \"en_route_pickup\",\n \"driverName\": \"Edvard G.\",\n \"externalId\": \"963360\",\n \"orderNumber\": 3893,\n \"trackerLink\": \"https://ordertracker.delivery/?orderId=57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"transportType\": \"Car\",\n \"dspTrackerLink\": \"https://track.doordash.com/order/0e38c90e-3959-4047-a3af-8e06ec4387c9/track\",\n \"driverPhoneNumber\": \"+17086833263\",\n \"estimatedPickupTime\": \"2024-10-25T12:19:56.000Z\",\n \"estimatedDropoffTime\": \"2024-10-25T12:46:07.000Z\"\n}\n{\n \"status\": \"InTransit\",\n \"orderId\": \"57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"latitude\": 40.7295676,\n \"longitude\": -73.4634871,\n \"status_v3\": \"en_route_dropoff\",\n \"driverName\": \"Edvard G.\",\n \"externalId\": \"963360\",\n \"orderNumber\": 3893,\n \"trackerLink\": \"https://ordertracker.delivery/?orderId=57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"transportType\": \"Car\",\n \"dspTrackerLink\": \"https://track.doordash.com/order/0e38c90e-3959-4047-a3af-8e06ec4387c9/track\",\n \"driverPhoneNumber\": \"+17086833263\",\n \"estimatedPickupTime\": \"2024-10-25T12:19:31.000Z\",\n \"estimatedDropoffTime\": \"2024-10-25T12:26:20.000Z\"\n}\n{\n \"status\": \"AtDestination\",\n \"orderId\": \"57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"latitude\": 40.729583,\n \"longitude\": -73.463406,\n \"status_v3\": \"arrived_dropoff\",\n \"driverName\": \"Edvard G.\",\n \"externalId\": \"963360\",\n \"orderNumber\": 3893,\n \"trackerLink\": \"https://ordertracker.delivery/?orderId=57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"transportType\": \"Car\",\n \"dspTrackerLink\": \"https://track.doordash.com/order/0e38c90e-3959-4047-a3af-8e06ec4387c9/track\",\n \"driverPhoneNumber\": \"+17086833263\",\n \"estimatedPickupTime\": \"2024-10-25T12:19:31.000Z\",\n \"estimatedDropoffTime\": \"2024-10-25T12:26:20.000Z\"\n}\n{\n \"status\": \"Delivered\",\n \"orderId\": \"57abe6a0-92c9-11ef-83ea-77a93...\n \"latitude\": 40.7029607,\n \"longitude\": -73.448888,\n \"status_v3\": \"completed\",\n \"driverName\": \"Edvard G.\",\n \"externalId\": \"963360\",\n \"orderNumber\": 3893,\n \"trackerLink\": \"https://ordertracker.delivery/?orderId=57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"transportType\": \"Car\",\n \"dspTrackerLink\": \"https://track.doordash.com/order/0e38c90e-3959-4047-a3af-8e06ec4387c9/track\",\n \"driverPhoneNumber\": \"+17086833263\",\n \"estimatedPickupTime\": \"2024-10-25T12:19:32.490Z\",\n \"estimatedDropoffTime\": \"2024-10-25T12:29:33.562Z\"\n}\n\nA cancellation will emit additional cancel_details.
reason is a non-standardized code directly from the DSP
details is a comment from the driver (usually empty)
{\n \"orderId\": \"57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"status_v3\": \"scheduled\",\n \"externalId\": \"963360\",\n \"orderNumber\": 3893,\n \"trackerLink\": \"https://ordertracker.delivery/?orderId=57abe6a0-92c9-11ef-83ea-77a593a719fc\",\n \"dspTrackerLink\": \"https://track.doordash.com/order/0e38c90e-3959-4047-a3af-8e06ec4387c9/track\",\n \"estimatedPickupTime\": \"2024-10-25T12:09:52.142Z\",\n \"estimatedDropoffTime\": \"2024-10-25T12:19:52.142Z\",\n \"cancel_details\": {\n \"reason\": \"cancel_by_merchant\",\n \"details\": null\n }, \n}\n\nExport order data and summaries for billing your merchants, and paying your drivers (if you have a fleet). We currently have three types of exports - available using the type field. This endpoint is similar to the GET /v3/orders endpoint, but is focused on billing and payments for completed orders, and has no limit.
Depending on the size of the query, you may be emailed the response as a CSV.
\nPer order summary with relevant fields for billing merchants, if you aren't using our Stripe integration
\nPer order summary with relevant fields for paying your runners, if you aren't using our Stripe integration
\nPer day summary with relevant fields for paying your runners, if you aren't using our Stripe integration
\nCreates a new DSP refund request. Requires admin, partner, or vendor authentication.
\n","urlObject":{"path":["v3","refunds"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3e3008fa-daf2-4562-a330-b4c73c8004c1","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{auth_token}}"}],"body":{"mode":"raw","raw":"{\n \"amount\": 15.5,\n \"contact_email\": \"customer@example.com\",\n \"description\": \"Food was cold and delivery was late\",\n \"external_dsps_id\": \"dsp_delivery_12345\",\n \"external_dsps_name\": \"DoorDash\",\n \"issue_type\": \"food_quality\",\n \"merchant_name\": \"Joe's Pizza\",\n \"internal_status\": \"unreviewed\"\n}"},"url":"{{base_url}}/v3/refunds"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"refund_12345\",\n \"amount\": 15.5,\n \"contact_email\": \"customer@example.com\",\n \"description\": \"Food was cold and delivery was late\",\n \"external_dsps_id\": \"dsp_delivery_12345\",\n \"external_dsps_name\": \"DoorDash\",\n \"issue_type\": \"food_quality\",\n \"merchant_name\": \"Joe's Pizza\",\n \"internal_status\": \"unreviewed\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n }\n}"}],"_postman_id":"39ce0073-cac9-454e-a588-1505fc54837f"},{"name":"Get DSP Refunds","id":"78dbcd68-6441-45d9-a2bb-26a2db2cda9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth_token}}"}],"url":"{{base_url}}/v3/refunds?limit=50&page=0&active=true&search=door&filters[start]=2024-01-01&filters[stop]=2024-01-31&filters[status][]=pending&filters[status][]=approved&filters[internal_status][]=unreviewed&filters[internal_status][]=flagged&filters[merchant_id]=merchant_123&sorting[id]=created_at&sorting[desc]=true&format=csv","description":"Retrieves a paginated list of DSP refunds with filtering and sorting options. Supports CSV/Excel export.
\n","urlObject":{"path":["v3","refunds"],"host":["{{base_url}}"],"query":[{"description":{"content":"Number of results per page (max 250 in production)
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Page number (0-based)
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Filter for active refunds only
\n","type":"text/plain"},"key":"active","value":"true"},{"description":{"content":"Search term for refunds
\n","type":"text/plain"},"key":"search","value":"door"},{"description":{"content":"Start date filter (ISO format)
\n","type":"text/plain"},"key":"filters[start]","value":"2024-01-01"},{"description":{"content":"End date filter (ISO format)
\n","type":"text/plain"},"key":"filters[stop]","value":"2024-01-31"},{"description":{"content":"Filter by refund status
\n","type":"text/plain"},"key":"filters[status][]","value":"pending"},{"description":{"content":"Multiple status values supported
\n","type":"text/plain"},"key":"filters[status][]","value":"approved"},{"description":{"content":"Filter by internal status
\n","type":"text/plain"},"key":"filters[internal_status][]","value":"unreviewed"},{"description":{"content":"Multiple internal status values supported
\n","type":"text/plain"},"key":"filters[internal_status][]","value":"flagged"},{"description":{"content":"Filter by merchant ID
\n","type":"text/plain"},"key":"filters[merchant_id]","value":"merchant_123"},{"description":{"content":"Field to sort by
\n","type":"text/plain"},"key":"sorting[id]","value":"created_at"},{"description":{"content":"Sort in descending order
\n","type":"text/plain"},"key":"sorting[desc]","value":"true"},{"description":{"content":"Export format (csv, json, xlsx)
\n","type":"text/plain"},"key":"format","value":"csv"}],"variable":[]}},"response":[{"id":"6f3176c5-355f-4e26-912e-d6f0c91557db","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v3/refunds?limit=50&page=0","host":["{{base_url}}"],"path":["v3","refunds"],"query":[{"key":"limit","value":"50"},{"key":"page","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"refund_12345\",\n \"amount\": 15.5,\n \"contact_email\": \"customer@example.com\",\n \"description\": \"Food was cold and delivery was late\",\n \"external_dsps_id\": \"dsp_delivery_12345\",\n \"external_dsps_name\": \"DoorDash\",\n \"issue_type\": \"food_quality\",\n \"merchant_name\": \"Joe's Pizza\",\n \"internal_status\": \"unreviewed\",\n \"status\": \"pending\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 50,\n \"total\": 1,\n \"pages\": 1\n },\n \"usedCache\": false\n}"}],"_postman_id":"78dbcd68-6441-45d9-a2bb-26a2db2cda9c"},{"name":"Update DSP Refund","id":"7eca363b-0a7a-4580-8099-4c43daf5d71f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{auth_token}}"}],"body":{"mode":"raw","raw":"{\n \"internal_status\": \"resolved\"\n}"},"url":"{{base_url}}/v3/refunds/{{refund_id}}","description":"Updates a DSP refund's internal status. Requires DspRefundEdit permission.
\n","urlObject":{"path":["v3","refunds","{{refund_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"58c9da8d-d935-4d45-828f-514b15af2c0c","name":"Success Response","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"internal_status\": \"resolved\"\n}"},"url":"{{base_url}}/v3/refunds/refund_12345"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"refund_12345\",\n \"amount\": 15.5,\n \"contact_email\": \"customer@example.com\",\n \"description\": \"Food was cold and delivery was late\",\n \"external_dsps_id\": \"dsp_delivery_12345\",\n \"external_dsps_name\": \"DoorDash\",\n \"issue_type\": \"food_quality\",\n \"merchant_name\": \"Joe's Pizza\",\n \"internal_status\": \"resolved\",\n \"status\": \"pending\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T11:45:00Z\"\n }\n}"}],"_postman_id":"7eca363b-0a7a-4580-8099-4c43daf5d71f"},{"name":"Get DSP Refund by DSP ID","id":"5309322a-9c1a-4bbb-828d-0be681e08d2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{auth_token}}"}],"url":"{{base_url}}/v3/refunds/{{dsps_delivery_id}}","description":"Retrieves a specific DSP refund by its external DSP delivery ID.
\n","urlObject":{"path":["v3","refunds","{{dsps_delivery_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f516b92b-e41f-40b2-be3f-0332432eedb3","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v3/refunds/dsp_delivery_12345"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"refund_12345\",\n \"amount\": 15.5,\n \"contact_email\": \"customer@example.com\",\n \"description\": \"Food was cold and delivery was late\",\n \"external_dsps_id\": \"dsp_delivery_12345\",\n \"external_dsps_name\": \"DoorDash\",\n \"issue_type\": \"food_quality\",\n \"merchant_name\": \"Joe's Pizza\",\n \"internal_status\": \"unreviewed\",\n \"status\": \"pending\",\n \"created_at\": \"2024-01-15T10:30:00Z\",\n \"updated_at\": \"2024-01-15T10:30:00Z\"\n }\n}"}],"_postman_id":"5309322a-9c1a-4bbb-828d-0be681e08d2a"}],"id":"a1649d87-0b43-4801-b57f-4682e3038082","description":"Refund Request Creation
When a refund is created via the API, First automatically sends an email to the DSP's support email address with the customer's contact email CC'd.
Manual Email Exchange
The refund dispute is then handled through manual email communication between:
The DSP support team
\nThe customer (via CC)
\nStatus Updates
For DoorDash and Uber Direct only, when the refund dispute is resolved, First will automatically update the refund status to one of:
rejected — Refund request was denied
approved — Full refund approved
partial_approved — Partial refund approved
Other DSPs
For all other delivery service providers, the status remains in the manual email workflow without automatic status updates.
The internal_status field can be used to manually manage the state of all refunds. Note that this is distinct from the status field, which can only be changed by the DSP.
Email Automation: All refund requests trigger automatic email notifications
\nManual Process: Resolution requires human intervention via email
\nSelective Automation: Only DoorDash and Uber Eats get automatic status updates
\nCustomer Involvement: Customers are CC'd on all communications
\nBearer token for authentication
\n"}],"url":"{{base_url}}/api/v3/shifts?page=0&limit=20","description":"Retrieves a paginated list of shifts with optional filters.
\nAuthentication Required: admin, partner, or vendor role
\nReturns a paginated list of shifts with embedded user information.
\n{\n \"data\": [\n {\n \"id\": \"string (UUID)\",\n \"created_at\": \"string (ISO date)\",\n \"retreat_point\": \"string (UUID)\",\n \"recurring\": \"string | null\",\n \"hourly_rate\": \"number\",\n \"length_hours\": \"number\",\n \"start\": \"string (ISO date)\",\n \"user_id\": \"string (UUID)\",\n \"stop\": \"string (ISO date)\",\n \"role\": \"string\",\n \"territory_id\": \"string (UUID)\",\n \"chomp_run_id\": \"number | null\",\n \"shift_type\": \"string\",\n \"bonus_pay\": \"number\",\n \"guarantee\": \"number\",\n \"blitz\": \"boolean\",\n \"user\": {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"string\",\n \"username\": \"string\",\n \"is_external_runner\": \"boolean\"\n }\n }\n ],\n \"total\": \"number\"\n}\n{\n \"data\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"created_at\": \"2025-10-20T10:00:00.000Z\",\n \"retreat_point\": \"650e8400-e29b-41d4-a716-446655440000\",\n \"recurring\": null,\n \"hourly_rate\": 15.5,\n \"length_hours\": 8,\n \"start\": \"2025-10-20T08:00:00.000Z\",\n \"user_id\": \"750e8400-e29b-41d4-a716-446655440000\",\n \"stop\": \"2025-10-20T16:00:00.000Z\",\n \"role\": \"runner\",\n \"territory_id\": \"850e8400-e29b-41d4-a716-446655440000\",\n \"chomp_run_id\": 123,\n \"shift_type\": \"delivery\",\n \"bonus_pay\": 0,\n \"guarantee\": 100,\n \"blitz\": false,\n \"user\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+15551234567\",\n \"username\": \"john.doe@example.com\",\n \"is_external_runner\": false\n }\n }\n ],\n \"total\": 42\n}\nPage number for pagination (default: 0)
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Number of results per page (default: 20, max: 250 in production)
\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"Filter shifts starting after this ISO date (e.g., 2025-10-20T00:00:00Z)
\n","type":"text/plain"},"key":"start","value":""},{"disabled":true,"description":{"content":"Filter shifts ending before this ISO date (e.g., 2025-10-30T00:00:00Z)
\n","type":"text/plain"},"key":"stop","value":""},{"disabled":true,"description":{"content":"Filter by specific user UUID
\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"Filter by territory UUID
\n","type":"text/plain"},"key":"territory_id","value":""},{"disabled":true,"description":{"content":"Filter by retreat point UUID
\n","type":"text/plain"},"key":"retreat_point","value":""},{"disabled":true,"description":{"content":"Filter by chomp run ID
\n","type":"text/plain"},"key":"chomp_run_id","value":""}],"variable":[]}},"response":[{"id":"792a02de-e593-4805-93da-827982816f95","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v3/shifts?page=0&limit=20","host":["{{base_url}}"],"path":["api","v3","shifts"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"created_at\": \"2025-10-20T10:00:00.000Z\",\n \"retreat_point\": \"650e8400-e29b-41d4-a716-446655440000\",\n \"recurring\": null,\n \"hourly_rate\": 15.5,\n \"length_hours\": 8,\n \"start\": \"2025-10-20T08:00:00.000Z\",\n \"user_id\": \"750e8400-e29b-41d4-a716-446655440000\",\n \"stop\": \"2025-10-20T16:00:00.000Z\",\n \"role\": \"runner\",\n \"territory_id\": \"850e8400-e29b-41d4-a716-446655440000\",\n \"chomp_run_id\": 123,\n \"shift_type\": \"delivery\",\n \"bonus_pay\": 0,\n \"guarantee\": 100,\n \"blitz\": false,\n \"user\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+15551234567\",\n \"username\": \"john.doe@example.com\",\n \"is_external_runner\": false\n }\n }\n ],\n \"total\": 42\n}"}],"_postman_id":"8aaaec57-2578-4fdf-9687-c5171faf4cbe"}],"id":"cb1bffd8-86e9-4a86-8fe6-2bd7dbf1b01a","_postman_id":"cb1bffd8-86e9-4a86-8fe6-2bd7dbf1b01a","description":""}],"id":"ccf63ad1-6be6-4f35-a97d-557f317a679d","description":"The First Platform API provides full access for you to externally manage your delivery operation
\nWhen creating, getting, updating orders - statuses are defined as following:
\n","_postman_id":"ccf63ad1-6be6-4f35-a97d-557f317a679d"}],"event":[{"listen":"prerequest","script":{"id":"60330587-abaf-4ce9-befe-ccb41ceb2f4a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ae39e992-450a-4da4-b3b7-c5d82acdb2f9","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BASE_HABITAT_URL","value":"https://habitat-market.ngrok.io","type":"string"},{"key":"ACCESS_TOKEN_ADMIN","value":"d03ea3d0-d3b9-11ed-8b58-fd444294f6c5","type":"string","disabled":true},{"key":"ORDER_ID","value":"df5c9da0-623d-11ee-8d45-dd71e550b626","type":"string"},{"key":"ORDER_STATUS","value":"runner_assigned","type":"string"},{"key":"$merchantId","value":"2c77c710-d9a2-11ed-bffb-7df939ab8e29","type":"string"},{"key":"RUNNER_ID","value":"1697c3af-450f-42f4-8609-669a4350c22f","type":"string"}]}