{
    "variable": [
        {
            "id": "baseUrl",
            "key": "baseUrl",
            "type": "string",
            "name": "string",
            "value": "https:\/\/my.carpoollogistics.com"
        }
    ],
    "info": {
        "name": "Carpool Logistics API Documentation",
        "_postman_id": "1ad21f15-9159-4775-9a8c-f8cc7eee2366",
        "description": "The Carpool Logistics API allows you to programmatically manage orders, vehicles, customers, quotes, and outbound webhooks.\n\n## Authentication\n\nAll API endpoints require authentication via a Bearer token. Include your token in the `Authorization` header:\n\n```\nAuthorization: Bearer {YOUR_AUTH_KEY}\n```\n\nYou can generate an API token from your dashboard.\n\n## Rate Limiting\n\nAPI requests are subject to rate limiting. If you exceed the limit, you will receive a `429 Too Many Requests` response.\n\n## Errors\n\nThe API uses standard HTTP status codes to indicate success or failure:\n\n- `200` - Success\n- `201` - Created\n- `204` - No Content\n- `400` - Bad Request\n- `401` - Unauthorized\n- `403` - Forbidden\n- `404` - Not Found\n- `422` - Validation Error\n- `429` - Too Many Requests\n- `500` - Internal Server Error",
        "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json"
    },
    "item": [
        {
            "name": "Customer Quotes",
            "description": "\nAPIs for creating and viewing customer quotes.",
            "item": [
                {
                    "name": "Create a customer quote.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/customer\/quote",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/customer\/quote"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"origin\":{\"city\":\"Orlando\",\"state\":\"FL\",\"postal_code\":32801},\"destination\":{\"city\":\"Miami\",\"state\":\"FL\",\"postal_code\":33101},\"location_type\":\"residential\",\"vehicles\":[{\"vin\":\"1HGCM82633A004352\",\"year\":2024,\"make\":\"Toyota\",\"model\":\"Camry\",\"type\":\"car\",\"inoperable\":false}]}"
                        },
                        "description": "Create a transport quote with pricing, transport time, pickup time, and checkout links for the requested origin, destination, and vehicles."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "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}",
                            "name": "Quote created"
                        },
                        {
                            "header": [],
                            "code": 422,
                            "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}",
                            "name": "Validation error"
                        },
                        {
                            "header": [],
                            "code": 500,
                            "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}",
                            "name": "Server error"
                        }
                    ]
                },
                {
                    "name": "Get a customer quote.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/customer\/quote\/:customerQuote_nano_id",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/customer\/quote\/:customerQuote_nano_id",
                            "variable": [
                                {
                                    "id": "customerQuote_nano_id",
                                    "key": "customerQuote_nano_id",
                                    "value": "1",
                                    "description": "The ID of the customerQuote nano."
                                },
                                {
                                    "id": "customerQuote",
                                    "key": "customerQuote",
                                    "value": "nZEWgx",
                                    "description": "The quote nano ID."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Retrieve a previously created customer quote by quote ID."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "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}",
                            "name": "Quote details"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "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}",
                            "name": "Quote not found"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Customers",
            "description": "\nAPIs for creating, viewing, and listing customers.",
            "item": [
                {
                    "name": "Create a customer.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/customers",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/customers"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"name\":\"Acme Auto Sales\",\"provider_id\":\"PROV-ACME-001\",\"external_id\":\"PROV-ACME-001\",\"address\":\"789 Commerce Blvd\",\"address_2\":\"Suite 100\",\"city\":\"Tampa\",\"state\":\"FL\",\"postal_code\":\"33601\",\"contact_firstname\":\"Bob\",\"contact_lastname\":\"Johnson\",\"phone_number\":\"813-555-0000\",\"email\":\"bob@acmeauto.com\",\"type\":\"franchise_dealer\",\"automatic_pricing_updates\":true,\"auto_rate_recalculation_enabled\":false,\"send_welcome_email\":false}"
                        },
                        "description": "Create a new child customer under the authenticated user's parent customer account.\nWhen provider-customer matching is active, a supplied `provider_id` or\n`external_id` (SAID) reuses the existing customer for that identifier. Lookalike creates still return 201 with\n`possible_duplicate` set. `possible_duplicate_of_id` is informational only and\nis included solely when this token can view that customer; it is not a billable\n`customer_id`. If the token cannot view the reused customer, the\n201 payload includes `id` (and `possible_duplicate`) only."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 201,
                            "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}",
                            "name": "Customer created"
                        },
                        {
                            "header": [],
                            "code": 201,
                            "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    \"possible_duplicate\": true\n  }\n}",
                            "name": "Possible duplicate created"
                        },
                        {
                            "header": [],
                            "code": 201,
                            "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    \"possible_duplicate\": true,\n    \"possible_duplicate_of_id\": \"2abb4b940dbf4bc3af74229fffa5ce9d\"\n  }\n}",
                            "name": "Possible duplicate of a customer this token can view"
                        },
                        {
                            "header": [],
                            "code": 201,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 201,\n  \"data\": {\n    \"id\": \"c220a277b6904bf082ee5b55ae89b286\",\n    \"possible_duplicate\": false\n  }\n}",
                            "name": "SAID reused but token cannot view the customer"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 404,\n  \"error\": {\n    \"code\": \"customer_not_found\",\n    \"message\": \"Customer not found for customer creation\",\n    \"details\": null,\n    \"timestamp\": \"2024-04-15 03:58:00\",\n    \"path\": \"\/api\/customers\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Customer identity left this API family"
                        },
                        {
                            "header": [],
                            "code": 422,
                            "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}",
                            "name": "Validation error"
                        },
                        {
                            "header": [],
                            "code": 500,
                            "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-13 02:58:42\",\n    \"path\": \"\/api\/customers\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Server error"
                        }
                    ]
                },
                {
                    "name": "Get a customer.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/customers\/:customer_slug",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/customers\/:customer_slug",
                            "variable": [
                                {
                                    "id": "customer_slug",
                                    "key": "customer_slug",
                                    "value": "1",
                                    "description": "The slug of the customer."
                                },
                                {
                                    "id": "customer",
                                    "key": "customer",
                                    "value": "2abb4b940dbf4bc3af74229fffa5ce9d",
                                    "description": "The customer ID."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Retrieve details for a customer by customer ID."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "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}",
                            "name": "Customer details"
                        },
                        {
                            "header": [],
                            "code": 403,
                            "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}",
                            "name": "Forbidden"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "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}",
                            "name": "Customer not found"
                        }
                    ]
                },
                {
                    "name": "List customers.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/customers",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "1",
                                    "description": "The page number.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/customers?page=1"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"page\":1}"
                        },
                        "description": "Retrieve a paginated list of customers for the authenticated user's organization."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "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}",
                            "name": "Customers list"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Orders",
            "description": "\nAPIs for creating, viewing, listing, and cancelling orders.",
            "item": [
                {
                    "name": "Create an order.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/orders",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/orders"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"customer_id\":\"cust-xyz789\",\"quote_id\":\"q1a2b3nanoid\",\"first_available_date\":\"2026-02-15\",\"price_option\":\"expedited\",\"origin\":{\"type\":\"dealer\",\"name\":\"Orlando Dealership\",\"address\":\"123 Main St\",\"city\":\"Orlando\",\"state\":\"FL\",\"postal_code\":\"32801\",\"contact_name\":\"John Doe\",\"contact_phone\":\"407-555-1234\",\"contact_email\":\"john@example.com\",\"external_notes\":\"Gate code: 1234\"},\"destination\":{\"type\":\"residence\",\"name\":\"Miami Auto Center\",\"address\":\"456 Ocean Dr\",\"city\":\"Miami\",\"state\":\"FL\",\"postal_code\":\"33101\",\"contact_name\":\"Jane Smith\",\"contact_phone\":\"305-555-6789\",\"contact_email\":\"jane@example.com\",\"external_notes\":\"Call before delivery\"},\"vehicles\":[{\"vehicle_type\":\"car\",\"year\":2024,\"make\":\"Toyota\",\"model\":\"Camry\",\"vin\":\"1HGCM82633A004352\",\"color\":\"white\",\"value\":25000,\"operable\":true,\"oversized\":false,\"gate_pass\":\"https:\\\/\\\/example.com\\\/gate-pass\\\/123.pdf\"}],\"provider_id\":\"PROV-001\",\"customer\":{\"name\":\"Acme Auto Sales\",\"provider_id\":\"PROV-ACME-001\",\"address\":\"789 Commerce Blvd\",\"address_2\":\"Suite 100\",\"city\":\"Tampa\",\"state\":\"FL\",\"postal_code\":\"33601\",\"contact_firstname\":\"Bob\",\"contact_lastname\":\"Johnson\",\"phone_number\":\"813-555-0000\",\"email\":\"bob@acmeauto.com\",\"type\":\"franchise_dealer\",\"send_welcome_email\":false}}"
                        },
                        "description": "Submit a new transport order using an existing customer ID, provider ID, or inline customer details. Orders may include gate pass URLs or base64 gate pass payloads."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 201,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 201,\n  \"data\": {\n    \"order_id\": \"3js1j9993rsnt\",\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    \"origin\": {\n      \"id\": \"s6xxuc3bn9koe\",\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    },\n    \"destination\": {\n      \"id\": \"if6yavmffq9bd\",\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    },\n    \"vehicles\": [\n      {\n        \"id\": \"slug\",\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\": \"http:\/\/example.com\"\n      }\n    ]\n  }\n}",
                            "name": "Created with existing customer ID"
                        },
                        {
                            "header": [],
                            "code": 201,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 201,\n  \"data\": {\n    \"order_id\": \"3js1j9993rsnt\",\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    \"origin\": {\n      \"id\": \"s6xxuc3bn9koe\",\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    },\n    \"destination\": {\n      \"id\": \"if6yavmffq9bd\",\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    },\n    \"vehicles\": [\n      {\n        \"id\": \"slug\",\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\": \"http:\/\/example.com\"\n      }\n    ]\n  }\n}",
                            "name": "Created with existing provider ID"
                        },
                        {
                            "header": [],
                            "code": 201,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 201,\n  \"data\": {\n    \"order_id\": \"3js1j9993rsnt\",\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    \"origin\": {\n      \"id\": \"s6xxuc3bn9koe\",\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    },\n    \"destination\": {\n      \"id\": \"if6yavmffq9bd\",\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    },\n    \"vehicles\": [\n      {\n        \"id\": \"slug\",\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\": \"http:\/\/example.com\"\n      }\n    ]\n  }\n}",
                            "name": "Created with base64 gate pass"
                        },
                        {
                            "header": [],
                            "code": 201,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 201,\n  \"data\": {\n    \"order_id\": \"3js1j9993rsnt\",\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    \"origin\": {\n      \"id\": \"s6xxuc3bn9koe\",\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    },\n    \"destination\": {\n      \"id\": \"if6yavmffq9bd\",\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    },\n    \"vehicles\": [\n      {\n        \"id\": \"slug\",\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\": \"http:\/\/example.com\"\n      }\n    ]\n  }\n}",
                            "name": "Created with new customer"
                        },
                        {
                            "header": [],
                            "code": 403,
                            "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:38:52\",\n    \"path\": \"\/api\/orders\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Forbidden"
                        },
                        {
                            "header": [],
                            "code": 422,
                            "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\/orders\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Validation error"
                        },
                        {
                            "header": [],
                            "code": 500,
                            "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\/orders\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Server error"
                        }
                    ]
                },
                {
                    "name": "Get an order.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/orders\/:order_slug",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/orders\/:order_slug",
                            "variable": [
                                {
                                    "id": "order_slug",
                                    "key": "order_slug",
                                    "value": "10002",
                                    "description": "The slug of the order."
                                },
                                {
                                    "id": "order",
                                    "key": "order",
                                    "value": "26fafe10c2e7422a88ecde74fb377134",
                                    "description": "The order ID."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Retrieve details for an existing order by order ID."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "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}",
                            "name": "Order details"
                        },
                        {
                            "header": [],
                            "code": 403,
                            "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}",
                            "name": "Forbidden"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "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}",
                            "name": "Order not found"
                        }
                    ]
                },
                {
                    "name": "List orders.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/orders",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "2",
                                    "description": "The page number.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/orders?page=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"page\":1}"
                        },
                        "description": "Retrieve a paginated list of orders for the authenticated user's customer account."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "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}",
                            "name": "Orders list"
                        }
                    ]
                },
                {
                    "name": "Cancel an order.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/orders\/:order_slug",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/orders\/:order_slug",
                            "variable": [
                                {
                                    "id": "order_slug",
                                    "key": "order_slug",
                                    "value": "10002",
                                    "description": "The slug of the order."
                                },
                                {
                                    "id": "order",
                                    "key": "order",
                                    "value": "26fafe10c2e7422a88ecde74fb377134",
                                    "description": "The order ID."
                                }
                            ]
                        },
                        "method": "DELETE",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Cancel an existing order by order ID. Returns no content when the cancellation succeeds."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 204,
                            "body": "",
                            "name": "No content"
                        },
                        {
                            "header": [],
                            "code": 400,
                            "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}",
                            "name": "Invalid order state"
                        },
                        {
                            "header": [],
                            "code": 403,
                            "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}",
                            "name": "Forbidden"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Outbound Webhooks",
            "description": "\nAPIs for managing outbound webhooks.",
            "item": [
                {
                    "name": "List webhooks for the authenticated user.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/webhooks",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/webhooks"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 200,\n  \"data\": {\n    \"data\": [\n      {\n        \"id\": \"abc123nanoid\",\n        \"url\": \"https:\/\/example.com\/webhooks\/receive\",\n        \"events\": [\"vehicle.created\", \"order.created\"],\n        \"is_active\": true,\n        \"description\": \"Production webhook\",\n        \"verified_at\": null,\n        \"created_at\": \"2026-02-08T12:00:00+00:00\",\n        \"updated_at\": \"2026-02-08T12:00:00+00:00\"\n      }\n    ],\n    \"links\": {\n      \"first\": \"http:\/\/localhost\/api\/webhooks?page=1\",\n      \"last\": \"http:\/\/localhost\/api\/webhooks?page=1\",\n      \"prev\": null,\n      \"next\": null\n    },\n    \"meta\": {\n      \"current_page\": 1,\n      \"last_page\": 1,\n      \"per_page\": 15,\n      \"total\": 1\n    }\n  }\n}",
                            "name": "Success"
                        }
                    ]
                },
                {
                    "name": "Register a new webhook.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/webhooks",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/webhooks"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"url\":\"https:\\\/\\\/example.com\\\/webhooks\\\/receive\",\"events\":[\"vehicle.created\"],\"description\":\"Production webhook for order events\"}"
                        },
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 201,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 201,\n  \"data\": {\n    \"id\": \"abc123nanoid\",\n    \"url\": \"https:\/\/example.com\/webhooks\/receive\",\n    \"secret\": \"a1b2c3d4e5f6g7h8i9j0kLmNoPqRsTuVwXyZ...\",\n    \"events\": [\"vehicle.created\", \"order.created\"],\n    \"is_active\": true,\n    \"description\": \"Production webhook\",\n    \"verified_at\": null,\n    \"created_at\": \"2026-02-08T12:00:00+00:00\",\n    \"updated_at\": \"2026-02-08T12:00:00+00:00\"\n  }\n}",
                            "name": "Success"
                        },
                        {
                            "header": [],
                            "code": 400,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 400,\n  \"error\": {\n    \"code\": \"bad_request\",\n    \"message\": \"Unable to determine organization context.\",\n    \"details\": null,\n    \"timestamp\": \"2026-02-08 12:00:00\",\n    \"path\": \"\/api\/webhooks\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "No organization context"
                        },
                        {
                            "header": [],
                            "code": 401,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 401,\n  \"error\": {\n    \"code\": \"unauthorized\",\n    \"message\": \"Unable to determine authentication context.\",\n    \"details\": null,\n    \"timestamp\": \"2026-02-08 12:00:00\",\n    \"path\": \"\/api\/webhooks\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "No authentication context"
                        },
                        {
                            "header": [],
                            "code": 422,
                            "body": "{\n  \"message\": \"The url field is required. (and 1 more error)\",\n  \"errors\": {\n    \"url\": [\"The url field is required.\"],\n    \"events\": [\"You must subscribe to at least one event.\"]\n  }\n}",
                            "name": "Validation error"
                        }
                    ]
                },
                {
                    "name": "Get webhook details.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/webhooks\/:webhook_nano_id",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/webhooks\/:webhook_nano_id",
                            "variable": [
                                {
                                    "id": "webhook_nano_id",
                                    "key": "webhook_nano_id",
                                    "value": "architecto",
                                    "description": "The ID of the webhook nano."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 200,\n  \"data\": {\n    \"id\": \"abc123nanoid\",\n    \"url\": \"https:\/\/example.com\/webhooks\/receive\",\n    \"events\": [\"vehicle.created\", \"order.created\"],\n    \"is_active\": true,\n    \"description\": \"Production webhook\",\n    \"verified_at\": null,\n    \"created_at\": \"2026-02-08T12:00:00+00:00\",\n    \"updated_at\": \"2026-02-08T12:00:00+00:00\"\n  }\n}",
                            "name": "Success"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 404,\n  \"error\": {\n    \"code\": \"resource_not_found\",\n    \"message\": \"Webhook not found.\",\n    \"details\": null,\n    \"timestamp\": \"2026-02-08 12:00:00\",\n    \"path\": \"\/api\/webhooks\/abc123nanoid\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Not found"
                        }
                    ]
                },
                {
                    "name": "Update a webhook.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/webhooks\/:webhook_nano_id",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/webhooks\/:webhook_nano_id",
                            "variable": [
                                {
                                    "id": "webhook_nano_id",
                                    "key": "webhook_nano_id",
                                    "value": "architecto",
                                    "description": "The ID of the webhook nano."
                                }
                            ]
                        },
                        "method": "PATCH",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"url\":\"https:\\\/\\\/example.com\\\/webhooks\\\/receive\",\"events\":[\"vehicle.created\"],\"description\":\"Production webhook for order events\",\"is_active\":true}"
                        },
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 200,\n  \"data\": {\n    \"id\": \"abc123nanoid\",\n    \"url\": \"https:\/\/example.com\/webhooks\/receive\",\n    \"events\": [\"vehicle.created\", \"order.created\"],\n    \"is_active\": true,\n    \"description\": \"Updated webhook description\",\n    \"verified_at\": null,\n    \"created_at\": \"2026-02-08T12:00:00+00:00\",\n    \"updated_at\": \"2026-02-08T13:00:00+00:00\"\n  }\n}",
                            "name": "Success"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 404,\n  \"error\": {\n    \"code\": \"resource_not_found\",\n    \"message\": \"Webhook not found.\",\n    \"details\": null,\n    \"timestamp\": \"2026-02-08 12:00:00\",\n    \"path\": \"\/api\/webhooks\/abc123nanoid\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Not found"
                        },
                        {
                            "header": [],
                            "code": 422,
                            "body": "{\n  \"message\": \"The url field must be a valid URL. (and 1 more error)\",\n  \"errors\": {\n    \"url\": [\"The url field must be a valid URL.\"],\n    \"events.0\": [\"The event invalid_event is not a valid webhook event.\"]\n  }\n}",
                            "name": "Validation error"
                        }
                    ]
                },
                {
                    "name": "Soft delete a webhook.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/webhooks\/:webhook_nano_id",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/webhooks\/:webhook_nano_id",
                            "variable": [
                                {
                                    "id": "webhook_nano_id",
                                    "key": "webhook_nano_id",
                                    "value": "architecto",
                                    "description": "The ID of the webhook nano."
                                }
                            ]
                        },
                        "method": "DELETE",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"status\": true,\n  \"message\": \"Webhook deleted.\"\n}",
                            "name": "Success"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 404,\n  \"error\": {\n    \"code\": \"resource_not_found\",\n    \"message\": \"Webhook not found.\",\n    \"details\": null,\n    \"timestamp\": \"2026-02-08 12:00:00\",\n    \"path\": \"\/api\/webhooks\/abc123nanoid\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Not found"
                        }
                    ]
                },
                {
                    "name": "List delivery history for a webhook.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/webhooks\/:webhook_nano_id\/deliveries",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/webhooks\/:webhook_nano_id\/deliveries",
                            "variable": [
                                {
                                    "id": "webhook_nano_id",
                                    "key": "webhook_nano_id",
                                    "value": "architecto",
                                    "description": "The ID of the webhook nano."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 200,\n  \"data\": {\n    \"data\": [\n      {\n        \"id\": \"del123nanoid\",\n        \"event_type\": \"vehicle.created\",\n        \"entity_type\": \"Vehicle\",\n        \"entity_id\": \"9f8b0e6c4d1e4b3aaf2c5d6e7f8a9b0c\",\n        \"status\": \"success\",\n        \"response_status\": 200,\n        \"attempt_count\": 1,\n        \"delivered_at\": \"2026-02-08T12:00:05+00:00\",\n        \"next_retry_at\": null,\n        \"created_at\": \"2026-02-08T12:00:00+00:00\"\n      }\n    ],\n    \"links\": {\n      \"first\": \"http:\/\/localhost\/api\/webhooks\/abc123nanoid\/deliveries?page=1\",\n      \"last\": \"http:\/\/localhost\/api\/webhooks\/abc123nanoid\/deliveries?page=1\",\n      \"prev\": null,\n      \"next\": null\n    },\n    \"meta\": {\n      \"current_page\": 1,\n      \"last_page\": 1,\n      \"per_page\": 15,\n      \"total\": 1\n    }\n  }\n}",
                            "name": "Success"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 404,\n  \"error\": {\n    \"code\": \"resource_not_found\",\n    \"message\": \"Webhook not found.\",\n    \"details\": null,\n    \"timestamp\": \"2026-02-08 12:00:00\",\n    \"path\": \"\/api\/webhooks\/abc123nanoid\/deliveries\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Not found"
                        }
                    ]
                },
                {
                    "name": "Send a test event to the webhook URL.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/webhooks\/:webhook_nano_id\/test",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/webhooks\/:webhook_nano_id\/test",
                            "variable": [
                                {
                                    "id": "webhook_nano_id",
                                    "key": "webhook_nano_id",
                                    "value": "architecto",
                                    "description": "The ID of the webhook nano."
                                }
                            ]
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 200,\n  \"data\": {\n    \"id\": \"del456nanoid\",\n    \"event_type\": \"vehicle.created\",\n    \"entity_type\": \"Vehicle\",\n    \"entity_id\": \"test-vehicle\",\n    \"status\": \"success\",\n    \"response_status\": 200,\n    \"attempt_count\": 1,\n    \"delivered_at\": \"2026-02-08T12:00:05+00:00\",\n    \"next_retry_at\": null,\n    \"created_at\": \"2026-02-08T12:00:00+00:00\"\n  }\n}",
                            "name": "Success"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 404,\n  \"error\": {\n    \"code\": \"resource_not_found\",\n    \"message\": \"Webhook not found.\",\n    \"details\": null,\n    \"timestamp\": \"2026-02-08 12:00:00\",\n    \"path\": \"\/api\/webhooks\/abc123nanoid\/test\"\n  },\n  \"documentation_url\": \"https:\/\/documentation.carpoollogistics.com\/\"\n}",
                            "name": "Not found"
                        }
                    ]
                },
                {
                    "name": "List all available webhook event types.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/webhook-events",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/webhook-events"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"status\": true,\n  \"status_code\": 200,\n  \"data\": [\n    {\"name\": \"vehicle.created\", \"label\": \"Vehicle Created\"},\n    {\"name\": \"vehicle.picked_up\", \"label\": \"Vehicle Picked Up\"},\n    {\"name\": \"vehicle.delivered\", \"label\": \"Vehicle Delivered\"},\n    {\"name\": \"vehicle.cancelled\", \"label\": \"Vehicle Cancelled\"},\n    {\"name\": \"vehicle.pickup_inspection_completed\", \"label\": \"Vehicle Pickup Inspection Completed\"},\n    {\"name\": \"vehicle.delivery_inspection_completed\", \"label\": \"Vehicle Delivery Inspection Completed\"},\n    {\"name\": \"order.created\", \"label\": \"Order Created\"},\n    {\"name\": \"order.picked_up\", \"label\": \"Order Picked Up\"},\n    {\"name\": \"order.delivered\", \"label\": \"Order Delivered\"},\n    {\"name\": \"order.cancelled\", \"label\": \"Order Cancelled\"}\n  ]\n}",
                            "name": "Success"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Vehicles",
            "description": "\nAPIs for listing vehicles the public API token can already see through its orders.",
            "item": [
                {
                    "name": "List vehicles.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/vehicles",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "2",
                                    "description": "The page number.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/vehicles?page=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"page\":1}"
                        },
                        "description": "Retrieve a paginated list of vehicles for the authenticated token's customer.\nEach item is one vehicle. A parent token includes vehicles on its child orders.\nA child token includes only vehicles on orders billed to that child.\nVehicles come newest first. There is no filter or sort. Pass `page` the same way as `GET \/orders`."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"data\": [\n    {\n      \"id\": \"9f8b0e6c4d1e4b3aaf2c5d6e7f8a9b0c\",\n      \"status\": \"ordered\",\n      \"year\": 2024,\n      \"make\": \"Honda\",\n      \"model\": \"Accord\",\n      \"vin\": \"1HGBH41JXMN109186\",\n      \"color\": \"black\",\n      \"value\": 25000,\n      \"operable\": true,\n      \"oversized\": false,\n      \"tracking_url\": \"https:\/\/my.carpoollogistics.com\/vehicle\/inspection\/share\/9f8b0e6c4d1e4b3aaf2c5d6e7f8a9b0c\",\n      \"order_id\": \"26fafe10c2e7422a88ecde74fb377134\",\n      \"customer_id\": \"8d5f037d3cb74822850dfdb2a68a3cdd\",\n      \"origin\": {\n        \"id\": \"loc-origin\",\n        \"name\": \"Vehicle Origin Yard\",\n        \"address\": \"100 Origin St\",\n        \"city\": \"Atlanta\",\n        \"state\": \"GA\",\n        \"postal_code\": \"30301\"\n      },\n      \"destination\": {\n        \"id\": \"loc-destination\",\n        \"name\": \"Vehicle Destination Lot\",\n        \"address\": \"200 Dest Ave\",\n        \"city\": \"Savannah\",\n        \"state\": \"GA\",\n        \"postal_code\": \"31401\"\n      },\n      \"distance\": 412,\n      \"order_date\": \"06\/15\/2026\",\n      \"first_available_date\": \"06\/14\/2026\",\n      \"due_date\": \"07\/31\/2026\",\n      \"pickup_eta\": \"05\/01\/2026\",\n      \"delivery_date\": \"08\/31\/2026\",\n      \"estimated_delivery_date\": \"06\/14\/2026\",\n      \"transport_fee\": 250.5,\n      \"bill_to\": \"Child Dealer\",\n      \"load_id\": 1001,\n      \"po_number\": \"PO-8841\",\n      \"check_in_name\": \"Westlake\"\n    }\n  ],\n  \"links\": {\n    \"first\": \"https:\/\/my.carpoollogistics.com\/api\/vehicles?page=1\",\n    \"last\": null,\n    \"prev\": null,\n    \"next\": null\n  },\n  \"meta\": {\n    \"current_page\": 1,\n    \"from\": 1,\n    \"path\": \"https:\/\/my.carpoollogistics.com\/api\/vehicles\",\n    \"per_page\": 15,\n    \"to\": 1\n  }\n}",
                            "name": "Vehicles list"
                        }
                    ]
                },
                {
                    "name": "Retrieve one vehicle.",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/vehicles\/:vehicle",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/vehicles\/:vehicle",
                            "variable": [
                                {
                                    "id": "vehicle",
                                    "key": "vehicle",
                                    "value": "9f8b0e6c4d1e4b3aaf2c5d6e7f8a9b0c",
                                    "description": "The vehicle public id."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Retrieve one vehicle by its public id when that vehicle would appear in `GET \/vehicles`\nfor the same token. The body is the same vehicle object nested on its single order.\nA missing id, an id outside that set, or an id shared by more than one vehicle in that set\nreturns 404."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"data\": {\n    \"id\": \"9f8b0e6c4d1e4b3aaf2c5d6e7f8a9b0c\",\n    \"status\": \"ordered\",\n    \"year\": 2024,\n    \"make\": \"Honda\",\n    \"model\": \"Accord\",\n    \"vin\": \"1HGBH41JXMN109186\",\n    \"color\": \"black\",\n    \"value\": 25000,\n    \"operable\": true,\n    \"oversized\": false,\n    \"tracking_url\": \"https:\/\/my.carpoollogistics.com\/vehicle\/inspection\/share\/9f8b0e6c4d1e4b3aaf2c5d6e7f8a9b0c\",\n    \"order_id\": \"26fafe10c2e7422a88ecde74fb377134\",\n    \"customer_id\": \"8d5f037d3cb74822850dfdb2a68a3cdd\",\n    \"origin\": {\n      \"id\": \"loc-origin\",\n      \"name\": \"Vehicle Origin Yard\",\n      \"address\": \"100 Origin St\",\n      \"city\": \"Atlanta\",\n      \"state\": \"GA\",\n      \"postal_code\": \"30301\"\n    },\n    \"destination\": {\n      \"id\": \"loc-destination\",\n      \"name\": \"Vehicle Destination Lot\",\n      \"address\": \"200 Dest Ave\",\n      \"city\": \"Savannah\",\n      \"state\": \"GA\",\n      \"postal_code\": \"31401\"\n    },\n    \"distance\": 412,\n    \"order_date\": \"06\/15\/2026\",\n    \"first_available_date\": \"06\/14\/2026\",\n    \"due_date\": \"07\/31\/2026\",\n    \"pickup_eta\": \"05\/01\/2026\",\n    \"delivery_date\": \"08\/31\/2026\",\n    \"estimated_delivery_date\": \"06\/14\/2026\",\n    \"transport_fee\": 250.5,\n    \"bill_to\": \"Child Dealer\",\n    \"load_id\": 1001,\n    \"po_number\": \"PO-8841\",\n    \"check_in_name\": \"Westlake\"\n  }\n}",
                            "name": "Vehicle"
                        },
                        {
                            "header": [],
                            "code": 404,
                            "body": "{\n  \"status\": false,\n  \"status_code\": 404,\n  \"error\": {\n    \"code\": \"resource_not_found\",\n    \"message\": \"The requested resource was not found.\"\n  }\n}",
                            "name": "Unknown, out-of-scope, or ambiguous id"
                        }
                    ]
                }
            ]
        }
    ],
    "auth": {
        "type": "bearer",
        "bearer": [
            {
                "key": "key",
                "type": "string"
            }
        ]
    }
}