Welcome! We're glad you're here to integrate with the Carpool Customer API.
\nThis guide will help you set up your API access smoothly and efficiently. Let’s get you up and running.
\nTo access our API, you’ll need a username and password. If you haven't received these yet, please reach out to our support team at tms@carpoollogisitics.com. We’ll provide you with the necessary credentials promptly.
\nFor security purposes, we use API Keys. Here’s a quick walkthrough to create yours:
\n1. Log In to Carpool TMS
\nSign in at https://my.carpoollogistics.com/ with your provided credentials.
\n2. Navigate to API Keys
\nClick on the user profile icon in the top right corner and select \"API Keys\" from the dropdown menu.
\n3. Generate Your Key
\nEnter a descriptive name for your key, click \"Create\", and make sure to copy and securely store your key.
\nThe Carpool Customer API requires that the Accept header be set to application/json for all requests. This header indicates that the client expects JSON responses from the API.
Setting the Accept header to application/json is crucial for ensuring that the API responses are in JSON format, facilitating easy management and parsing on the client side.
When making requests, include the Accept header as follows:
\ncurl -X GET \"https://my.carpoollogisitics.com/api/user/me\" \\\n -H \"Accept: application/json\"\n\nThis header should accompany all of your API requests.
\nSecure access to the Carpool Customer API requires that all requests be accompanied by a valid API Key and the appropriate Accept header. This section explains how to include your API Key and set the Accept header in your API requests to authorize your interactions with the API.
\nAfter obtaining your API Key, it must be included in the Authorization header of every API request. Additionally, to ensure responses are in the correct format, you must specify application/json as the value of the Accept header.
To authenticate your requests, add the API Key as Bearer to the Authorization header. Also, include the Accept header with the value application/json to specify that you expect the response in JSON format:
Authorization: Bearer YOUR_API_KEY_HERE\nAccept: application/json \n\nReplace YOUR_API_KEY_HERE with your actual API Key.
If your API Key is expired or incorrect, you will receive a 401 Unauthorized status code with the following response body:
\n{\n \"message\": \"Unauthenticated.\"\n}\n\nAll responses from the Carpool Customer API are wrapped in a data object. Here is an example of a typical response:
{\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Sam\",\n \"last_name\": \"Smith\",\n \"phone\": \"+14045551212\",\n \"email\": \"sam@customer.com\",\n \"teams\": []\n }\n}\n\nThis standardized response format applies to all endpoints across the Carpool Customer API, making it straightforward for developers to parse and utilize the returned data.
\nIf you need any help or assistance, please reach out to our support team at tms@carpoollogisitics.com.
\nOrders & Customers API is currently under development. There may be additions response or request bodies. These APIs will be available for public consumption March 2025.
\nGets information about the authenticated user.
\nRequest Parameters:
\nNone Required
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}},"urlObject":{"path":["user","me"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"dd6def9a-dc28-463d-a58d-2a32404e6e1f","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/api/user/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 28 Mar 2024 21:34:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"499"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Terrence\",\n \"last_name\": \"Jackson\",\n \"phone\": \"+14045458424\",\n \"email\": \"terrence@carpoollogistics.com\",\n \"teams\": []\n }\n}"}],"_postman_id":"6947ae82-a1ef-410c-ae9c-61e46831bb56"}],"id":"7cb129cd-b601-470e-b61a-acabacb8d2f0","event":[{"listen":"prerequest","script":{"id":"bc526807-ecb6-4b33-ba58-c0d8a4a9029a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"22c8016f-8793-4586-b3c1-46a667c2b391","type":"text/javascript","exec":[""]}}],"_postman_id":"7cb129cd-b601-470e-b61a-acabacb8d2f0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}}},{"name":"Customer Quote","item":[{"name":"Create Customer Quote","id":"df910f30-1fff-4510-9562-3326ec321ddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"origin\": {\n \"city\": \"Anton\",\n \"state\": \"CO\",\n \"postal_code\": \"80801\"\n },\n \"destination\": {\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"postal_code\": \"30305\"\n },\n \"vehicles\": [\n {\n \"vin\": \"3FAHP0JA6CR358042\",\n \"type\": \"car\",\n \"inoperable\": false,\n \"enclosed\": false\n },\n {\n \"vin\": \"1FTSW21R78EA63479\",\n \"type\": \"truck\",\n \"inoperable\": false,\n \"enclosed\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customer/quote","description":"Create a quote for transport with pricing and transport time and pick up time for a specified set of vehicles.
\nRequest Parameters:
\n","urlObject":{"path":["customer","quote"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a0223140-7e2c-4b33-847e-75e6ab54adf5","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}],"body":{"mode":"raw","raw":"{\n \"origin\": {\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"postal_code\": \"30349\"\n },\n \"destination\": {\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postal_code\": \"33101\"\n },\n \"vehicles\": [\n {\n \"vin\": \"5XXGN4A7XEG296332\",\n \"inoperable\": false\n },\n {\n \"vin\": \"5NPEG4JAXMH121966\",\n \"inoperable\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customer/quote"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"X-RateLimit-Limit","value":"500","description":""},{"key":"X-RateLimit-Remaining","value":"499","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"xjx1j96rmnxxz\",\n \"origin\": {\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"postal_code\": \"30349\"\n },\n \"destination\": {\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postal_code\": \"33101\"\n },\n \"vehicles\": [\n {\n \"id\": \"adnqhbzz7hfy9\",\n \"quote_id\": \"xjx1j96rmnxxz\",\n \"year\": null,\n \"make\": null,\n \"model\": null,\n \"type\": \"car\",\n \"inoperable\": false\n },\n {\n \"id\": \"l3w698aog2ww6\",\n \"quote_id\": \"xjx1j96rmnxxz\",\n \"year\": null,\n \"make\": null,\n \"model\": null,\n \"type\": \"car\",\n \"inoperable\": false\n }\n ],\n \"distance\": 656,\n \"price_options\": [\n {\n \"type\": \"economy\",\n \"price\": 1148,\n \"delivery_time\": \"4 business days\"\n },\n {\n \"type\": \"expedited\",\n \"price\": 1631,\n \"delivery_time\": \"2 business days\"\n },\n {\n \"type\": \"enclosed\",\n \"price\": 1416,\n \"delivery_time\": \"3 business days\"\n }\n ],\n \"checkout_url\": \"http://localhost/customer/quote/xjx1j96rmnxxz/checkout\",\n \"email_url\": \"http://localhost/plugin/customer/quote/xjx1j96rmnxxz/email?expires=1738138755&signature=c35a4e3ded8f254d931bec37fb6d1cdbc9c86dc5afaf07c5d1df2189b9fc87c3\"\n }\n}"},{"id":"bbe56106-f9bc-4cf0-b77e-465eafadc5cb","name":"422 Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de","type":"text"}],"body":{"mode":"raw","raw":"{\n \"origin\": {\n \"city\": \"Atlanta\"\n },\n \"destination\": {\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postal_code\": \"33101\"\n },\n \"vehicles\": [\n {\n \"vin\": \"5XXGN4A7XEG296332\",\n \"inoperable\": false\n },\n {\n \"vin\": \"5NPEG4JAXMH121966\",\n \"inoperable\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customer/quote"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"X-RateLimit-Limit","value":"500","description":"","type":"text"},{"key":"X-RateLimit-Remaining","value":"499","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 422,\n \"error\": {\n \"code\": \"validation_error\",\n \"message\": \"A validation error occurred while processing the request.\",\n \"details\": {\n \"origin.postal_code\": [\n \"The origin.postal code field is required.\"\n ],\n \"destination.postal_code\": [\n \"The destination.postal code field is required.\"\n ]\n },\n \"timestamp\": \"2024-04-15 03:58:00\",\n \"path\": \"/api/customer/quote\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"},{"id":"caa3c1eb-c74b-425d-b295-628c901129d5","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de","type":"text"}],"body":{"mode":"raw","raw":"{\n \"origin\": {\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"postal_code\": \"30349\"\n },\n \"destination\": {\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postal_code\": \"33101\"\n },\n \"vehicles\": [\n {\n \"vin\": \"5XXGN4A7XEG296332\",\n \"inoperable\": false\n },\n {\n \"vin\": \"5NPEG4JAXMH121966\",\n \"inoperable\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customer/quote"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[{"key":"X-RateLimit-Limit","value":"500","description":"","type":"text"},{"key":"X-RateLimit-Remaining","value":"499","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"status_code\": 500,\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"A server error occurred while processing the request.\",\n \"details\": null,\n \"timestamp\": \"2024-04-13 02:58:42\",\n \"path\": \"/api/customer/quote\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"}],"_postman_id":"df910f30-1fff-4510-9562-3326ec321ddb"},{"name":"Get Customer Quote","id":"9c7e7f34-47d7-46ba-a7a6-b219c59ae9f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/customer/quote/{{quote_id}}","description":"Retrieve a previously created quote for transport with pricing, transport time and pick up time for a specified set of vehicles.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}},"urlObject":{"path":["customer","quote","{{quote_id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4da4f137-c420-4880-848f-d06b553a6407","name":"Get Customer Quote","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}],"url":"{{url}}/customer/quote/{{quote_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"nZEWgx\",\n \"origin\": {\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"postal_code\": \"30318\"\n },\n \"destination\": {\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"postal_code\": \"33101\"\n },\n \"vehicles\": [\n {\n \"id\": \"Dz6GQG\",\n \"quote_id\": \"nZEWgx\",\n \"year\": \"2014\",\n \"make\": \"Kia\",\n \"model\": \"Optima\",\n \"type\": \"car\",\n \"inoperable\": false\n },\n {\n \"id\": \"WDbamL\",\n \"quote_id\": \"nZEWgx\",\n \"year\": \"2021\",\n \"make\": \"Hyundai\",\n \"model\": \"Sonata\",\n \"type\": \"car\",\n \"inoperable\": false\n }\n ],\n \"distance\": 662,\n \"price_options\": [\n {\n \"type\": \"economy\",\n \"price\": 1158.5,\n \"delivery_time\": \"4 business days\"\n },\n {\n \"type\": \"expedited\",\n \"price\": 1645.719,\n \"delivery_time\": \"2 business days\"\n },\n {\n \"type\": \"enclosed\",\n \"price\": 1429.178,\n \"delivery_time\": \"3 business days\"\n }\n ]\n }\n}"},{"id":"7440e36b-f308-49f7-88ad-dff0d3dbce13","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de","type":"text"}],"url":"{{url}}/customer/quote/{{quote_id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"status_code\": 404,\n \"error\": {\n \"code\": \"customer_quote_not_found\",\n \"message\": \"The request resource was not found.\",\n \"details\": \"Quote with id '{{quote_id}}' does not exist.\",\n \"timestamp\": \"2023-04-13 03:10:35\",\n \"path\": \"/api/customer/quote/{{quote_id}}\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"},{"id":"6fc45699-563e-4f96-9fba-6a283d77f87f","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de","type":"text"}],"url":"{{url}}/customer/quote/{{quote_id}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 500,\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"A server error occurred while processing the request.\",\n \"details\": null\n \"timestamp\": \"2024-04-15 03:53:24\",\n \"path\": \"/api/customer/quote/c7tSoL\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"}],"_postman_id":"9c7e7f34-47d7-46ba-a7a6-b219c59ae9f8"}],"id":"4f4b2137-2d6d-40bb-a229-0ddc68d72650","event":[{"listen":"prerequest","script":{"id":"76f7287d-a0bc-42e5-b27b-1c20f0c83edf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c7ee69cc-354c-4720-9cb6-3e35b4318041","type":"text/javascript","exec":[""]}}],"_postman_id":"4f4b2137-2d6d-40bb-a229-0ddc68d72650","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}}},{"name":"Orders","item":[{"name":"Create Order","event":[{"listen":"test","script":{"id":"154003dc-e66e-4a02-8835-5be343e3f6dd","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"71d6ce6a-2970-4015-b3fe-be84333f5b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_id\": \"2abb4b940dbf4bc3af74229fffa5ce9d\",\n // \"quote_id\": \"8qu63lnfd1ugu\",\n \"origin\": {\n \"name\": \"Acme Vehicle Warehouse\",\n \"type\": \"auction\",\n \"address\": \"1234 Elm Street\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_name\": \"Jane Smith\",\n \"contact_phone\": \"555-987-6543\",\n \"contact_email\": \"warehouse@acmevehicles.com\",\n \"external_notes\": \"text\"\n },\n \"destination\": {\n \"name\": \"Auto Destination Hub\",\n \"address\": \"456 Destination Blvd\",\n \"type\": \"dealer\",\n \"city\": \"Gotham\",\n \"state\": \"NJ\",\n \"postal_code\": \"07001\",\n \"contact_name\": \"Michael Black\",\n \"contact_phone\": \"555-654-3210\",\n \"contact_email\": \"mblack@autohub.com\",\n \"external_notes\": \"text\"\n },\n \"vehicles\": [\n {\n \"vehicle_type\": \"car\",\n \"year\": \"2020\",\n \"make\": \"Toyota\",\n \"model\": \"Camry\",\n \"vin\": \"1HGCM82633A004352\",\n \"gate_pass\": \"https://example.com\",\n \"color\": \"blue\",\n \"value\": \"20000\",\n \"operable\": true,\n \"oversized\": false\n }\n ],\n \"price_option\": \"economy\",\n \"first_available_date\": \"2025-02-06\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/orders","description":"Create a new order.
\nGets information about a collection. For a complete list of this endpoint's possible values, use the collection.json schema file.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}},"urlObject":{"path":["api","orders",":orderId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"","key":"orderId"}]}},"response":[{"id":"43bcfe88-b714-46de-a1cd-414dc2bb492d","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/orders/:orderId","host":["{{url}}"],"path":["orders",":orderId"],"variable":[{"key":"orderId","value":"26fafe10c2e7422a88ecde74fb377134"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 200,\n \"data\": {\n \"order_id\": \"26fafe10c2e7422a88ecde74fb377134\",\n \"customer_id\": \"2abb4b940dbf4bc3af74229fffa5ce9d\",\n \"status\": \"pending\",\n \"created_at\": \"2025-03-06T10:33:33.000000Z\",\n \"updated_at\": \"2025-03-06T10:33:33.000000Z\",\n \"origin\": {\n \"id\": \"7b5f2c1c1fa54a33b590ee1d699c014b\",\n \"name\": \"Acme Vehicle Warehouse\",\n \"type\": \"auction\",\n \"address\": \"1234 Elm Street\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_name\": \"Jane Smith\",\n \"contact_phone\": \"+13806666666\",\n \"contact_email\": \"warehouse@acmevehicles.com\"\n },\n \"destination\": {\n \"id\": \"e52174ce6fef47d2bdfbd5b75ef9bebb\",\n \"name\": \"Auto Destination Hub\",\n \"address\": \"456 Destination Blvd\",\n \"type\": \"dealer\",\n \"city\": \"Gotham\",\n \"state\": \"NJ\",\n \"postal_code\": \"07001\",\n \"contact_name\": \"Michael Black\",\n \"contact_phone\": \"+13809999999\",\n \"contact_email\": \"mblack@autohub.com\"\n },\n \"vehicles\": [\n {\n \"id\": \"455c8b4cfc3943d09ff1e080d0314f36\",\n \"status\": \"ordered\",\n \"year\": 2020,\n \"make\": \"Toyota\",\n \"model\": \"Camry\",\n \"vin\": \"1HGCM82633A004352\",\n \"color\": \"blue\",\n \"value\": 20000,\n \"operable\": true,\n \"oversized\": false,\n \"tracking_url\": \"https://my.carpoollogistics.com/vehicle/455c8b4cfc3943d09ff1e080d0314f36/inspection/share?signature=83b89c2593e11fb2d083f9f1e5936d811edda132e2f836aa170de840ae152859\"\n }\n ]\n }\n}"},{"id":"ff9f20df-5edb-475d-b17b-8f2dd410a8c7","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_id\": \"2abb4b940dbf4bc3af74229fffa5ce9d\",\n \"origin\": {\n \"name\": \"Acme Vehicle Warehouse\",\n \"type\": \"auction\",\n \"address\": \"1234 Elm Street\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_name\": \"Jane Smith\",\n \"contact_phone\": \"+13806666666\",\n \"contact_email\": \"warehouse@acmevehicles.com\"\n },\n \"destination\": {\n \"name\": \"Auto Destination Hub\",\n \"address\": \"456 Destination Blvd\",\n \"type\": \"dealer\",\n \"city\": \"Gotham\",\n \"state\": \"NJ\",\n \"postal_code\": \"07001\",\n \"contact_name\": \"Michael Black\",\n \"contact_phone\": \"+13809999999\",\n \"contact_email\": \"mblack@autohub.com\"\n },\n \"vehicles\": [\n {\n \"vehicle_type\": \"car\",\n \"year\": 2020,\n \"make\": \"Toyota\",\n \"model\": \"Camry\",\n \"vin\": \"1HGCM82633A004352\",\n \"gate_pass\": \"https://example.com\",\n \"color\": \"blue\",\n \"value\": 20000,\n \"operable\": true,\n \"oversized\": false\n }\n ],\n \"price_option\": \"economy\",\n \"first_available_date\": \"2025-02-06\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/orders/:orderId","host":["{{url}}"],"path":["orders",":orderId"],"variable":[{"key":"orderId","value":"f19475ff4aee4059b6f717e3424cfbea"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"},"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 403,\n \"error\": {\n \"code\": \"forbidden_access\",\n \"message\": \"You do not have permission to access this resource.\",\n \"details\": null,\n \"timestamp\": \"2025-03-11 08:45:21\",\n \"path\": \"/api/orders/f19475ff4aee4059b6f717e3424cfbea\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"},{"id":"a86b389d-f066-4b6c-b3ec-786c0bd47155","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/orders/:orderId","host":["{{url}}"],"path":["orders",":orderId"],"variable":[{"key":"orderId","value":"26fafe10c2e7422a88ecde74fb377135"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"status_code\": 404,\n \"error\": {\n \"code\": \"order_not_found\",\n \"message\": \"The request resource was not found.\",\n \"details\": \"Order with id '26fafe10c2e7422a88ecde74fb377135' does not exist.\",\n \"timestamp\": \"2023-04-13 03:10:35\",\n \"path\": \"/api/orders/26fafe10c2e7422a88ecde74fb377135\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"}],"_postman_id":"1621cee7-6c13-4ed4-bc3e-0f47bd861585"},{"name":"Get Orders","event":[{"listen":"test","script":{"id":"f733df7b-1c35-48f7-9218-ce68a7d8cd7e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d83f28f8-e3d8-4865-97a3-f594c9464b95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/orders?page=2","description":"Gets all of your collections. The response includes all of your subscribed collections.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}},"urlObject":{"path":["api","orders"],"host":["{{url}}"],"query":[{"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"1190e8cb-86a1-4aa3-bbd3-54525a2a8fe9","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/orders?page=2","host":["{{url}}"],"path":["orders"],"query":[{"key":"page","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"order_id\": \"26fafe10c2e7422a88ecde74fb377134\", \n \"customer_id\": \"8d5f037d3cb74822850dfdb2a68a3cdd\",\n \"status\": \"processing\",\n \"created_at\": \"2025-02-05T14:30:00Z\",\n \"updated_at\": \"2025-02-05T14:30:00Z\",\n \"estimated_delivery_date\": \"2025-02-12\"\n },\n {\n \"order_id\": \"e52483fb1977455b90b9ab134566c3b2\", \n \"customer_id\": \"2abb4b940dbf4bc3af74229fffa5ce9d\",\n \"status\": \"pending\",\n \"created_at\": \"2025-02-05T14:30:00Z\",\n \"updated_at\": \"2025-02-05T14:30:00Z\",\n \"estimated_delivery_date\": \"2025-02-12\"\n },\n {\n \"order_id\": \"fba1dc1d4faa42999b70343d36bfe327\", \n \"customer_id\": \"be78e67f02654e31a5e0e4caa140e2bb\", \n \"status\": \"complete\",\n \"created_at\": \"2025-02-05T14:30:00Z\",\n \"updated_at\": \"2025-02-05T14:30:00Z\",\n \"estimated_delivery_date\": \"2025-02-12\"\n }\n ],\n \"links\": {\n \"first\": \"https://my.carpoollogistics.com/api/orders?page=2\",\n \"last\": null,\n \"prev\": \"https://my.carpoollogistics.com/api/orders?page=2\",\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 2,\n \"from\": null,\n \"path\": \"https://my.carpoollogistics.com/api/orders\",\n \"per_page\": 15,\n \"to\": null\n }\n}"}],"_postman_id":"d83f28f8-e3d8-4865-97a3-f594c9464b95"},{"name":"Cancel Order","id":"04b8dd87-5ba7-4648-8750-e5e05e7720fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{url}}/api/orders/:orderId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}},"urlObject":{"path":["api","orders",":orderId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"26fafe10c2e7422a88ecde74fb377134","key":"orderId"}]}},"response":[{"id":"783139a5-665a-4b6d-b414-f081999bf7b2","name":"204 No Content","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{url}}/orders/:orderId","host":["{{url}}"],"path":["orders",":orderId"],"variable":[{"key":"orderId","value":"26fafe10c2e7422a88ecde74fb377134"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"eb091111-4828-4842-8d62-736f406f2061","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{url}}/orders/:orderId","host":["{{url}}"],"path":["orders",":orderId"],"variable":[{"key":"orderId","value":"26fafe10c2e7422a88ecde74fb377134"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"Text","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 403,\n \"error\": {\n \"code\": \"forbidden_access\",\n \"message\": \"You do not have permission to access this resource.\",\n \"details\": null,\n \"timestamp\": \"2025-03-11 08:47:45\",\n \"path\": \"/api/orders/26fafe10c2e7422a88ecde74fb377134\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"},{"id":"aedd4afb-14df-40dc-868c-32daa020a5aa","name":"400 Bad request","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{url}}/orders/:orderId","host":["{{url}}"],"path":["orders",":orderId"],"variable":[{"key":"orderId","value":"26fafe10c2e7422a88ecde74fb377134"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 400,\n \"error\": {\n \"code\": \"invalid_order_state\",\n \"message\": \"Cannot cancel an order that has been processed.\",\n \"details\": null,\n \"timestamp\": \"2025-03-06 20:25:26\",\n \"path\": \"/api/orders/26fafe10c2e7422a88ecde74fb377134\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"}],"_postman_id":"04b8dd87-5ba7-4648-8750-e5e05e7720fc"}],"id":"71494fa1-1780-4742-9366-3f87267ac9f4","description":"The /orders endpoints let you manage your orders.
Description
\nCreate a new customer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}},"urlObject":{"path":["api","customers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"03453009-a518-46e9-ac94-613504a26c62","name":"201 Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"other\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 201,\n \"data\": {\n \"id\": \"c220a277b6904bf082ee5b55ae89b286\",\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+13806666666\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"auction\"\n }\n}"},{"id":"738c6a61-64b7-4c7f-98b9-face8867ada3","name":"422 Unprocessable Entity","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"johndoe@acmevehicles.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customers"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 422,\n \"error\": {\n \"code\": \"validation_error\",\n \"message\": \"A validation error occurred while processing the request.\",\n \"details\": {\n \"postal_code\": [\n \"The postal code field is required.\"\n ]\n },\n \"timestamp\": \"2024-04-15 03:58:00\",\n \"path\": \"/api/customers\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"},{"id":"110e7dd7-8947-40c9-8ebf-e020c7af3069","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customers"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"status_code\": 500,\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"A server error occurred while processing the request.\",\n \"details\": null,\n \"timestamp\": \"2024-04-13 02:58:42\",\n \"path\": \"/api/customers\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"}],"_postman_id":"fedbbf76-898d-4c8f-babd-39486a88f2f6"},{"name":"Update Customer","id":"ab855a8c-5073-4d71-9e4a-d6a08d5a0992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"other\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/customers/:customerId","description":"Description
\nUpdate a customer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}},"urlObject":{"path":["api","customers",":customerId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"27e830bb-b2fb-47a5-a766-2499f7309a27","name":"200 OK","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"other\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/customers/:customerId","host":["{{url}}"],"path":["customers",":customerId"],"variable":[{"key":"customerId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 200\n}"},{"id":"e155430c-86c5-4983-821a-d520e1859687","name":"404 Not Found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"other\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/customers/:customerId","host":["{{url}}"],"path":["customers",":customerId"],"variable":[{"key":"customerId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 404,\n \"error\": {\n \"code\": \"customer_not_found\",\n \"message\": \"We could not find the customer you are looking for\",\n \"path\": \"/api/customers/:customerId\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"},{"id":"dee0cc5a-5412-4d8c-9430-b18099deb766","name":"422 Unprocessable Entity","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+1-555-123-4567\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"other\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/customers/:customerId","host":["{{url}}"],"path":["customers",":customerId"],"variable":[{"key":"customerId","value":""}]}},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 422,\n \"error\": {\n \"code\": \"validation_error\",\n \"message\": \"A validation error occurred while processing the request.\",\n \"details\": {\n \"postal_code\": [\n \"The postal code field is required.\"\n ]\n },\n \"timestamp\": \"2024-04-15 03:58:00\",\n \"path\": \"/api/customers/:customerId\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"}],"_postman_id":"ab855a8c-5073-4d71-9e4a-d6a08d5a0992"},{"name":"Get Customer","id":"a5a08dc1-0089-4b72-9a51-056b2fe12908","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/api/customers/:customerId","urlObject":{"path":["api","customers",":customerId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"477149258dce438bb602d03dd17da710","key":"customerId"}]}},"response":[{"id":"50f31553-233f-4410-a3ab-5f0bb808fc0e","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/customers/:customerId","host":["{{url}}"],"path":["customers",":customerId"],"variable":[{"key":"customerId","value":"2abb4b940dbf4bc3af74229fffa5ce9d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"2abb4b940dbf4bc3af74229fffa5ce9d\",\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+13806666666\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"auction\"\n }\n}"},{"id":"21183240-a8a1-4787-b09a-e8c0adfb8624","name":"403 Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/customers/:customerId","host":["{{url}}"],"path":["customers",":customerId"],"variable":[{"key":"customerId","value":"201f5b79147c465bb0c4b79f1062ceaf"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"status_code\": 403,\n \"error\": {\n \"code\": \"forbidden_access\",\n \"message\": \"You do not have permission to access this resource.\",\n \"details\": null,\n \"timestamp\": \"2025-03-11 09:53:56\",\n \"path\": \"/api/customers/201f5b79147c465bb0c4b79f1062ceaf\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"},{"id":"9963f69e-f8f6-4d10-a5f8-7de8302cb2dd","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/customers/:customerId","host":["{{url}}"],"path":["customers",":customerId"],"variable":[{"key":"customerId","value":"54dc88ca178c47cdb49f66aa6dda7057"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"status_code\": 404,\n \"error\": {\n \"code\": \"customer_not_found\",\n \"message\": \"The request resource was not found.\",\n \"details\": \"Customer with id '54dc88ca178c47cdb49f66aa6dda7057' does not exist.\",\n \"timestamp\": \"2023-04-13 03:10:35\",\n \"path\": \"/api/customer/54dc88ca178c47cdb49f66aa6dda7057\"\n },\n \"documentation_url\": \"https://documentation.carpoollogistics.com/\"\n}"}],"_postman_id":"a5a08dc1-0089-4b72-9a51-056b2fe12908"},{"name":"Get Customers","id":"b5822036-8839-4497-b99f-01f8ec14c8dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/customers","urlObject":{"path":["api","customers"],"host":["{{url}}"],"query":[{"disabled":true,"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"5e266373-3ec7-43de-a67e-9780e23bac36","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/customers?page=2","host":["{{url}}"],"path":["customers"],"query":[{"key":"page","value":"2"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1fe4970cf50642c1a9938a5db3bd322f\",\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+13806666666\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"independent_dealer\"\n },\n {\n \"id\": \"c220a277b6904bf082ee5b55ae89b286\",\n \"name\": \"Acme Vehicle Transport\",\n \"address\": \"1234 Elm Street\",\n \"address_2\": \"\",\n \"city\": \"Metropolis\",\n \"state\": \"NY\",\n \"postal_code\": \"10108\",\n \"contact_firstname\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"phone_number\": \"+13809999999\",\n \"email\": \"johndoe@acmevehicles.com\",\n \"type\": \"auction\"\n }\n ],\n \"links\": {\n \"first\": \"https://my.carpoollogistics.com/api/orders?page=2\",\n \"last\": null,\n \"prev\": \"https://my.carpoollogistics.com/api/orders?page=2\",\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 2,\n \"from\": null,\n \"path\": \"https://my.carpoollogistics.com/api/orders\",\n \"per_page\": 15,\n \"to\": null\n }\n}"}],"_postman_id":"b5822036-8839-4497-b99f-01f8ec14c8dd"}],"id":"d9330abc-b239-4704-9893-4f8341243ec7","_postman_id":"d9330abc-b239-4704-9893-4f8341243ec7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"UoR6v0g5kTsxbQD3Qj1InNPyYfCM8lfLFAi8KQ9L3fc006de"}]},"isInherited":true,"source":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","type":"collection"}}},{"name":"Plugin","item":[{"name":"Lookup VIN","id":"5868b67c-7488-4651-99f8-5718acfab595","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vins\": [\n \"JKAKXRLC51A021169\",\n \"VF3BF3276NS432113\",\n \"VF3BF3276NS43211Y\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/plugin/customer/vin-lookup","description":"The VIN Lookup API offers a single endpoint for validating VINs and retrieving their status.
\nAuthentication Required: This endpoint requires session cookies to be included. See parent folder description.
\n","urlObject":{"path":["plugin","customer","vin-lookup"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6ca5c2ea-5b4e-4f26-ad6b-86c13bc9a2c3","name":"Lookup VIN Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vins\": [\n \"JKAKXRLC51A021169\",\n \"1FTPW14VX9KB84518\",\n \"VF3BF3276NS43211Y\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/plugin/customer/vin-lookup"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1586"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 28 Jan 2026 09:04:10 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"x-amzn-RequestId","value":"46de40d9-05e5-4202-9e26-01f95992f195"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, X-Requested-With, Authorization, X-CSRF-TOKEN, X-XSRF-TOKEN"},{"key":"set-cookie","value":"XSRF-TOKEN=eyJpdiI6IjErYkNpVlYwRWh5QmdmMDFTNk9BOVE9PSIsInZhbHVlIjoidFpoSnNuUXlvazFZQlBPclh0WW5WeklIUzJ0ditZbk5mNCtmR3ZQR3BzQVN1b2tjTkFzUjhDMElHakNsdzNOZ1N2YzBWUTZGeG5jYWZkZkVSb3hBOGtZdWxjcW5WT3N6SlNxelFWdHM3OCszOTlmbWVCcVp4WTg5MnB6YXh5NzciLCJtYWMiOiIwNGUyOGE5YmU2ZWFlYjc2MWQ2ZDMzMGMwNDZkN2VjYzc5NDUxMTc5MDhhMzVhMWE2MmMwYzliMjgxZmRmNzg3IiwidGFnIjoiIn0%3D; expires=Thu, 29 Jan 2026 09:04:10 GMT; Max-Age=86400; path=/; secure; samesite=lax"},{"key":"set-cookie","value":"carpool_logistics_session=eyJpdiI6IjB4dXZnWXI5b0hnTisxd0lKUm9aOHc9PSIsInZhbHVlIjoiU0VhaXVTZUFZNWM5WFBBWUYwd2h4S0dhT0Z1VzkvamFBUzIreHhjUndMR2hjMWVHM3BaTG9KQUU1RExDUFc1THBqSEVWOE1kZFRUcjFjeERUN01HUE15cHZFejdUNkxzQUpwNXlIWDFQMlFTbFVYT3ZCL0ZWM2YwV2xFSS8rTzIiLCJtYWMiOiJkNWU3ZTJmZGVkNmNkMzM0OGM0ZTdkNTg3ZDQyZDRjOGU3MDgwN2M2MTIwNjgwYmI1OWRiNzM4NTkxMjExOGIxIiwidGFnIjoiIn0%3D; expires=Thu, 29 Jan 2026 09:04:10 GMT; Max-Age=86400; path=/; secure; httponly; samesite=lax"},{"key":"x-amz-apigw-id","value":"X42ZkE4TIAMEOXg="},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6979d109-325f38cd150067d7686dbe6f;Parent=06ed9694dcb03101;Sampled=0;Lineage=1:7b0a071b:0"},{"key":"x-amzn-Remapped-Date","value":"Wed, 28 Jan 2026 09:04:10 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e0bed00f7c599b055dc1b21ec2ba7e72.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD12-P5"},{"key":"X-Amz-Cf-Id","value":"Bv1AhBBv-I-ghw7KUPtJxX2Om2cxBs2pWpDDHD0xBE6LQ0qMVaOpMQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"status\": \"ordered\",\n \"vin\": \"1FTPW14VX9KB84518\",\n \"message\": null,\n \"year\": 2009,\n \"make\": \"Ford\",\n \"model\": \"F-150\",\n \"vehicle_type\": \"truck\",\n \"url\": \"https://develop.carpoollogistics.com/vehicle/63863\",\n \"estimated_pickup_date\": null,\n \"estimated_delivery_date\": null,\n \"delivery_date_actual\": null,\n \"pick_up_date_actual\": null,\n \"origin_city\": \"Savannah\",\n \"origin_state\": \"GA\",\n \"destination_city\": \"Memphis\",\n \"destination_state\": \"TN\",\n \"due_date\": \"2026-01-29\"\n },\n {\n \"status\": \"error\",\n \"vin\": \"JKAKXRLC51A021169\",\n \"message\": \"0 - VIN decoded clean. Check Digit (9th position) is correct; 10 - Off-road Vehicle Warning – This is not a vehicle identification number (VIN) for a motor vehicle. This indicates that the manufacturer did not certify this product as complying with the Federal motor vehicle safety standards which are applicable to motor vehicles as defined at 49 U.S.C. 30102.\",\n \"year\": null,\n \"make\": null,\n \"model\": null,\n \"vehicle_type\": null,\n \"url\": null,\n \"estimated_pickup_date\": null,\n \"estimated_delivery_date\": null,\n \"delivery_date_actual\": null,\n \"pick_up_date_actual\": null,\n \"origin_city\": null,\n \"origin_state\": null,\n \"destination_city\": null,\n \"destination_state\": null,\n \"due_date\": null\n },\n {\n \"status\": \"error\",\n \"vin\": \"VF3BF3276NS43211Y\",\n \"message\": \"1 - Check Digit (9th position) does not calculate properly; 400 - Invalid Characters Present\",\n \"year\": null,\n \"make\": null,\n \"model\": null,\n \"vehicle_type\": null,\n \"url\": null,\n \"estimated_pickup_date\": null,\n \"estimated_delivery_date\": null,\n \"delivery_date_actual\": null,\n \"pick_up_date_actual\": null,\n \"origin_city\": null,\n \"origin_state\": null,\n \"destination_city\": null,\n \"destination_state\": null,\n \"due_date\": null\n }\n ]\n}"}],"_postman_id":"5868b67c-7488-4651-99f8-5718acfab595"},{"name":"Create Customer Quote","id":"64f3a7af-a2d5-4b5a-afe6-fbf2e1812f83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"origin\": {\n \"city\": \"Anton\",\n \"state\": \"CO\",\n \"postal_code\": \"80801\"\n },\n \"destination\": {\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"postal_code\": \"30305\"\n },\n \"vehicles\": [\n {\n \"vin\": \"3FAHP0JA6CR358042\",\n \"type\": \"car\",\n \"inoperable\": false,\n \"enclosed\": false\n },\n {\n \"vin\": \"1FTSW21R78EA63479\",\n \"type\": \"truck\",\n \"inoperable\": false,\n \"enclosed\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/plugin/customer/quote","description":"Create a quote for transport with pricing and transport time and pick up time for a specified set of vehicles.
\nAuthentication Required: This endpoint requires session cookies to be included. See parent folder description.
\nRequest Parameters:
\n","urlObject":{"path":["plugin","customer","quote"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2272cda5-44ad-4e6b-b246-36980db7716b","name":"Create Customer Quote","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"origin\": {\n \"city\": \"Anton\",\n \"state\": \"CO\",\n \"postal_code\": \"80801\"\n },\n \"destination\": {\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"postal_code\": \"30305\"\n },\n \"vehicles\": [\n {\n \"vin\": \"3FAHP0JA6CR358042\",\n \"type\": \"car\",\n \"inoperable\": false,\n \"enclosed\": false\n },\n {\n \"vin\": \"1FTSW21R78EA63479\",\n \"type\": \"truck\",\n \"inoperable\": false,\n \"enclosed\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/plugin/customer/quote"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 26 Nov 2025 10:37:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, X-Requested-With, Authorization, X-CSRF-TOKEN, X-XSRF-TOKEN"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6ImRDNmZwNlZFUUNENDVnbWswUkxYdkE9PSIsInZhbHVlIjoiTE9KeHhVc3BHZ1ltQTlZbkhwMUIydmZXU1lWOHQvcUNrZmRkZUpKazlMdElmdDNuTkpvVUd0MmU1VHpQcElCalJEM3RoWnZ1NmY0SE1DK29BaTFOQUlVdGFzeW83bWNXREJjSGgyZkFZTit6UVFNYnFockhVakdlN1pxQzE1WW4iLCJtYWMiOiJhNjlhYjhkYzE2MDY1OTI5MzExOTBmODIwMWY5OGRlMWMwYzQwNzNkNWZkNDM5ODcxZmU0MmE4ZTMzNzBmYWEwIiwidGFnIjoiIn0%3D; expires=Thu, 27 Nov 2025 10:37:33 GMT; Max-Age=86399; path=/; secure; samesite=none"},{"key":"Set-Cookie","value":"carpool_logistics_session=eyJpdiI6IkxOWTVBcnFzdS9xcUFrajFLT3BxL2c9PSIsInZhbHVlIjoiQk1vdHBGOWZ0VXZmN2IrQjJYSElrSFFCWjZnazVDS1cweitxYktZR2FZK3JseGdwQjhIbitEbElkK3Jvekg1T0NDY2REeSt0ZWh4bThVYVRUZnI0WE1PQU5LVisvMkZVaGlpUDBPaDZmMmVPMDQ3dExTNm1mTVVGQUo2Nk16Y2YiLCJtYWMiOiJmYTBiYzJhNGQyNjc4OWNmNWMyNDg4MGQxYzk2MzQ1NjgwZmE3Zjc2MDhjOTZiZWJmNWM3NTFlN2RmZDEzNDY3IiwidGFnIjoiIn0%3D; expires=Thu, 27 Nov 2025 10:37:33 GMT; Max-Age=86399; path=/; secure; httponly; samesite=none"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"status_code\": 200,\n \"data\": {\n \"id\": \"6z9l981ctz2x4\",\n \"origin\": {\n \"city\": \"Anton\",\n \"state\": \"CO\",\n \"postal_code\": \"80801\"\n },\n \"destination\": {\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"postal_code\": \"30305\"\n },\n \"vehicles\": [\n {\n \"id\": \"edfxguewlzb9y\",\n \"quote_id\": \"6z9l981ctz2x4\",\n \"year\": \"2012\",\n \"make\": \"Ford\",\n \"model\": \"Fusion SEL FWD\",\n \"type\": \"car\",\n \"inoperable\": false,\n \"quoted_price\": null\n },\n {\n \"id\": \"dwp9bw2d4tgjh\",\n \"quote_id\": \"6z9l981ctz2x4\",\n \"year\": \"2008\",\n \"make\": \"Ford\",\n \"model\": \"F-250 Super Duty - Single Rear Wheel\",\n \"type\": \"oversized\",\n \"inoperable\": false,\n \"quoted_price\": null\n }\n ],\n \"distance\": 1323,\n \"price_options\": [\n {\n \"type\": \"economy\",\n \"price\": 2276,\n \"delivery_eta\": \"12/08/25\",\n \"delivery_time\": \"7 business days\"\n },\n {\n \"type\": \"expedited\",\n \"price\": 3473,\n \"delivery_eta\": \"12/04/25\",\n \"delivery_time\": \"5 business days\"\n },\n {\n \"type\": \"enclosed\",\n \"price\": 3443,\n \"delivery_eta\": \"12/09/25\",\n \"delivery_time\": \"8 business days\"\n }\n ],\n \"checkout_url\": \"http://localhost/customer/quote/6z9l981ctz2x4/checkout\",\n \"email_url\": \"http://localhost/plugin/customer/quote/6z9l981ctz2x4/email?expires=1764196653&signature=3f51b499577c7b74bfe26343eed455ee5206e21ab8a1491221124940bd0e8f52\"\n }\n}"}],"_postman_id":"64f3a7af-a2d5-4b5a-afe6-fbf2e1812f83"},{"name":"Get current user","id":"e22129d2-c8c8-4338-bb88-b10151b3532b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/plugin/customer/me","description":"Returns the current authenticated user's profile data optimized for browser extension display.
\nThe user object contains current_role field. Possible values are the following:
- super_admin
- admin
- staff
- customer
- driver
- carrier
- dispatcher
- carrier_manager
- approver
- releaser
- customer_rep
- customer_manager
- account_manager
- booking_high_value
- staff_customer_rates
- customer_manager_high_value
Authentication Required: This endpoint requires session cookies to be included. See parent folder description.
\n","urlObject":{"path":["plugin","customer","me"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"685efb16-ba11-43c6-bf5f-fb0008830276","name":"Get current user response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/plugin/customer/me"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.29"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 01 Dec 2025 12:15:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, X-Requested-With, Authorization, X-CSRF-TOKEN, X-XSRF-TOKEN"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6ImJBWTB0Nkc3ZWFsQWs3T3dabUJ1dnc9PSIsInZhbHVlIjoiYllhWWRFVEtVT0E0N1pKQXFGcVVGakkvZU5mVXIwdlh6RUVFRnZKTkdMNU91UGIwK0t5L016bTQzWWp6TVh3T3Z5V0h5MEVpTTFZeUcyVU5SWWJBYW51YXdkV1hZSmMxNjN4bTBsSW5RaVhLNGVNQjJ3K2dzOFF3OVlQU0h6eFAiLCJtYWMiOiJkZTI3ZDdiNGEyYmE4N2IzODJlMTA3MWEwYmM0MzMzZTdhY2M2Nzk1NmVjYzhhYTZkYmNkZjJhNzY1YjIwZTlmIiwidGFnIjoiIn0%3D; expires=Tue, 02 Dec 2025 12:15:32 GMT; Max-Age=86400; path=/; secure; samesite=none"},{"key":"Set-Cookie","value":"carpool_logistics_session=eyJpdiI6Ik9YTjJPTlhMM1FIL0tWMWtueWpoT2c9PSIsInZhbHVlIjoiRmFpd1VOVS9jRnlOS2VsZFBvTFZWQkMvNFg3TllBQWZicktGajVldVhCQjZWY2VzV095cGxKdlRMQ0YrNnNtOENUUEFQWnozVkhtc2Rta05RbnptTHkzZnQxdWpvNG1rODQwOHJZd3YwMFBRVlZ1T09SU1hnbVNDdytxKzBsNEwiLCJtYWMiOiI2OGFiNTQwMGJkMGUwMTllYmM4NGU1ZmE0ZjRlYTNhYTQ1MzNmNWU1YmMzMjMzZTMwMTc1NDFiZmZmNzhkOGEzIiwidGFnIjoiIn0%3D; expires=Tue, 02 Dec 2025 12:15:32 GMT; Max-Age=86400; path=/; secure; httponly; samesite=none"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4163,\n \"customer_id\": 486,\n \"first_name\": \"Liza\",\n \"last_name\": \"Liza\",\n \"phone\": \"+14045458421\",\n \"email\": \"liza.test@test.com\",\n \"current_role\": \"customer\",\n \"is_eligible\": true,\n \"location\": {\n \"address\": \"3423 Piedmont Rd NE Suite 360\",\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"zip\": \"30305\",\n \"customer_name\": \"ShipCars Customer\"\n },\n \"teams\": []\n }\n}"}],"_postman_id":"e22129d2-c8c8-4338-bb88-b10151b3532b"},{"name":"Plugin Proxy","id":"5625ac48-031d-4708-9130-fad897f5524b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/plugin-proxy?path=/plugin/customer/me","description":"Safari blocks cross-site cookies, even when extensions use credentials: 'include'. This proxy endpoint allows browser extensions to make authenticated requests by routing them through the same domain as the API, making all requests appear as first-party to Safari.
URL: /plugin-proxy
Methods: GET, POST, PUT, PATCH, DELETE
Authentication: Required (auth:web middleware)
// Instead of calling the API directly:\n// fetch('https://yourdomain.com/plugin/customer/me', { credentials: 'include' })\n// Use the proxy:\nfetch('https://yourdomain.com/plugin-proxy?path=/plugin/customer/me', {\n credentials: 'include'\n})\n\nfetch('https://yourdomain.com/plugin-proxy?path=/plugin/customer/quote', {\n method: 'POST',\n credentials: 'include',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Requested-With': 'XMLHttpRequest'\n },\n body: JSON.stringify({\n origin: 'New York, NY',\n destination: 'Los Angeles, CA',\n vehicle_type: 'sedan'\n })\n})\n\nOnly allows paths starting with /plugin/
Blocks full URLs (http://, https://)
\nPrevents directory traversal attacks (../, ..\\\\)
Only allows: GET, POST, PUT, PATCH, DELETE
\nRejects: OPTIONS, TRACE, CONNECT, etc.
\nAllowed headers: content-type, authorization, x-requested-with, accept, accept-language, accept-encoding, user-agent
\nBlocked headers: cookie, host, origin, referer, x-forwarded-*, x-real-ip
\nFilters out Set-Cookie headers from API responses
Preserves API status codes and error messages
\nMaintains response body integrity
\n{\n \"error\": \"Invalid request parameters\",\n \"message\": \"Path parameter is required\"\n}\n\n{\n \"error\": \"Internal server error\", \n \"message\": \"The proxy request could not be completed\"\n}\n\nThe proxy relies on browser cookies for authentication. When Safari makes a request to the proxy:
\nSafari includes first-party cookies because the domain matches
\nLaravel's auth:web middleware validates the session
The proxy forwards the request internally (no cookies needed)
\nThe internal API uses the authenticated session context
\nA required query parameter that tells the proxy which internal TMS plugin endpoint to call e.g: /plugin/customer/me, /plugin/customer/quote, /plugin/customer/vin-lookup, etc.
\n","type":"text/plain"},"key":"path","value":"/plugin/customer/me"}],"variable":[]}},"response":[{"id":"4619a7a9-13a0-4808-9cde-2fdce0225b0c","name":"Plugin Proxy Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/plugin-proxy?path=/plugin/customer/me","host":["{{url}}"],"path":["plugin-proxy"],"query":[{"key":"path","value":"/plugin/customer/me"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.29"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"date","value":"Wed, 03 Dec 2025 11:47:44 GMT"},{"key":"content-type","value":"application/json"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, X-Requested-With, Authorization, X-CSRF-TOKEN, X-XSRF-TOKEN"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"*"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IkNxS3RxdENJaWVrNGFDd05pYUZqbEE9PSIsInZhbHVlIjoickRiOWpjYlRlbjg1ODdvbHBpMEhHYVdYL2lCK2N2ekkvSWpXbld0Y0ZGa0VHWnVHdDkrWnFVRCtmcXpkWFdiMGswUStqeEQyKytLYmcxazh5S0o1c0RtbXFwK2lLaWJCNnhNVnZJbWIvaWY5VVhGZTYySFpnTS9aWko2RlF0LzgiLCJtYWMiOiIxZGQzZmY1NzUzMjcxYzc3ZmJkODlkZWEzZjA2M2U2YWJhZDljZTU2ZTM0MzA3NDAwMmUzYTVjYmJjNGY3ODY4IiwidGFnIjoiIn0%3D; expires=Thu, 04 Dec 2025 11:47:44 GMT; Max-Age=86400; path=/; secure; samesite=none"},{"key":"Set-Cookie","value":"carpool_logistics_session=eyJpdiI6IkpXeDJBbzB4ZXErQkJWL0lqcVE2SEE9PSIsInZhbHVlIjoiNmgrZ2lEQ1lldUw5M2xiYkcvcC9QVGlYNjBnUXEyT2dGWXFzZkNYWnU3WEQvTEh1RDh0MmRPaXhhSXVmaCtqNm5xZS9mMGFTY21naFg4Mk11Z0FlN2Jrd3FCcEkrT01NS3pudlJ6STUwMnlhY0tsNUtRU3lRV05SN1diNEhkWVgiLCJtYWMiOiJhYjhhODY0MDY1ZDkyNzE2NTk1Y2JjODc2ODBhYTAzYThjYzhlZDYzODYwYjg3ZmU4NmIwNDc5ZGJkZTA1ZGNkIiwidGFnIjoiIn0%3D; expires=Thu, 04 Dec 2025 11:47:44 GMT; Max-Age=86400; path=/; secure; httponly; samesite=none"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 4163,\n \"customer_id\": 486,\n \"first_name\": \"Liza\",\n \"last_name\": \"Liza\",\n \"phone\": \"+14045458421\",\n \"email\": \"liza.test@test.com\",\n \"current_role\": \"customer\",\n \"is_eligible\": true,\n \"location\": {\n \"address\": \"3423 Piedmont Rd NE Suite 360\",\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"zip\": \"30305\",\n \"customer_name\": \"ShipCars Customer\"\n },\n \"teams\": []\n }\n}"}],"_postman_id":"5625ac48-031d-4708-9130-fad897f5524b"}],"id":"27e0a1d2-6e35-4c3d-b1a0-170d931f27ef","description":"Browser extension-related endpoints. These endpoints allow users to access key TMS functionality directly from their web browser without having to navigate to the main TMS application
\nAuthentication Required: This endpoint requires session cookies to be included.
JavaScript Example:
fetch('http://localhost/plugin/customer/me', {\n method: 'get',\n headers: {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json',\n },\n credentials: 'include', // ← Required for cookie authentication\n})\n\n