v1 OpenAPI 3.0.1 # Dispatch API v1 Download OpenAPI Document json Download OpenAPI Document yaml # Quickstart Guide This Dispatch API provides RESTful endpoints that use standard HTTP verbs to send and receive data to and from the Dispatch system. - **GET**: Used to READ data from the Dispatch system. - **POST**: Used to CREATE data in the Dispatch system. ## Environments Dispatch has a testing and demo environment and a production environment. - **TEST / DEMO**: [`https://api.demo.dispatchit.com/v1`](https://api.demo.dispatchit.com/v1) - **PRODUCTION**: [`https://api.dispatchit.com/v1`](https://api.dispatchit.com/v1) * * * ## Authentication All calls to the Dispatch API must include an authorization header containing the credentials needed to authenticate with the Dispatch system. ### OAuth 2.0 The Dispatch API supports OAuth 2.0 authentication using the Client Credentials flow for server-to-server authentication. **Registering an OAuth2 Client:** - **PRODUCTION**: [https://app.dispatchit.com/developer\_settings/oauth\_clients](https://app.dispatchit.com/developer_settings/oauth_clients) - **TEST / DEMO**: [https://app.demo.dispatchit.com/developer\_settings/oauth\_clients](https://app.demo.dispatchit.com/developer_settings/oauth_clients) **Token Endpoints:** - **PRODUCTION**: `https://id.dispatchit.com/oauth2/token` - **TEST / DEMO**: `https://id.demo.dispatchit.com/oauth2/token` **Obtaining an Access Token:** Make a POST request to the token endpoint with your client credentials: ```properties POST /oauth2/token Content-Type: application/x-www-form-urlencoded grant_type=client_credentials&client_id=&client_secret= ``` **Example Authorization Header:** ```properties Authorization: Bearer ``` ### Basic Auth The HTTP Authorization header format is as follows: ```properties Authorization: Basic ``` You will use your Dispatch **API Key** and **API Token** to derive the authorization header. Most modern programming languages have libraries that can generate this automatically. **Manual Encoding:** Credentials are derived by base64 encoding your **API Key** and **API Token**, joined by a single colon: ```elixir : ``` **Example Authorization Header:** ```ini Authorization: Basic amFzb250ZXN0MTIzNCE6dDEYMw== ``` * * * ## Other Header Information The Dispatch API requires the following additional headers: ```properties Accept: */* Content-Type: application/json ``` * * * # Webhooks If you have webhooks configured for your organization, Dispatch will automatically send order status updates using the schema shown below. Additionally, any adjustments made to the order will also be sent. To configure webhooks, go to the [Developer Settings](https://app.dispatchit.com/developer_settings) page, scroll down to the Webhooks section and click Add / Update Webhooks. Choose Dispatch Marketplace for the product and enter the URL for Marketplace specific events. ## Orders Orders generally move through the statuses in the order listed below, ending at `delivered`. However, there are times when this is not the case, i.e. a driver accepts an order, and then changes their mind. In this case, an order has changed from `assigned` to `assigning`, and then back to `assigned` when a new driver accepted the order. In each case, both the current, and the previous status are listed in the JSON request body. ## Adjustments Adjustments are any changes made to the price of an order. There are a variety of reasons that this could happen. The established ones are order\_cancellation, misc, vehicle\_change, service\_change, mileage\_change, labor\_fee, driver\_bonus, toll, and needed\_assistance. For each adjustment there will be a comment line that will help further clarify the reason if needed. Note: For order\_cancellation a webhook will not be sent. This is handled differently and a separate notification is sent out for that with the relevant information. The adjustment webhook is only sent upon request. Please contact Dispatch if you'd like to receive it. Dispatch will re-try calling your webhook endpoint up to 5 times. After each failure, we will wait an increasing amount of time before trying again until the endpoint is reached, or we have received 5 failures. ## Verifying Requests The `X-Dispatch-Signature` and `X-Dispatch-Timestamp` headers may be used to verify the authenticity of webhook requests originating from Dispatch. The `X-Dispatch-Signature` header contains an HMAC using the SHA256 hash function, and the `X-Dispatch-Timestamp` header contains a timestamp in the form of the number of seconds since the [Unix Epoch](https://en.wikipedia.org/wiki/Unix_time). When configuring a Dispatch Marketplace webhook, Dispatch generates a random key which is used to compute the HMAC. The key is accessible on the [Developer Settings](https://app.dispatchit.com/developer_settings) page in the Webhooks section. To verify the authenticity of the request, you will use the timestamp header information and the body of the request to compute the HMAC, and compare it to the HMAC in the signature header. Identical values indicated the request is authentic. Compute the signature with the following steps: **Step 1** Extract the header information. **Step 2** Extract the raw contents of the body of the request. It is important to not process the body with a JSON parser for this step. **Step 3** Combine the contents of the request body with the `X-Dispatch-Timestamp` header, separated by the character . **Step 4** Compute the HMAC using the SHA256 hash function, your webhook key from the Developer Settings page, and the concatenated string from the previous step. **Step 5** Compare the computed hash with the contents from the `X-Dispatch-Signature` header. Secondarily, to prevent replay attacks, you can compute the difference between the current time and the timestamp you received from Dispatch. It is up to you to decide what your tolerance is for the difference between the times. ## Examples The statuses are listed below with a brief description of what each one means, along with an example of the JSON request body. **assigning** The order has been created and is waiting for a driver to be assigned to it or the order had a driver assigned previously that was unassigned from it. **JSON Example** Sample Request \| assigning ```json { "event": "order.status_change", "data": { "event_id": 987654, "public_url": "https://example.com/order/fa02aa718992f6f9", "created_at": "2025-02-28T13:23:51.918Z", "previous_status": "", "current_status": "assigning", "order_id": 12345 } } ``` **assigned** The order has been assigned to a driver and they are on the way to pick it up. Any attempt to cancel an order at or after this point will result in an error. **JSON Example** Sample Request \| assigned ```json { "event": "order.status_change", "data": { "event_id": 987654, "public_url": "https://example.com/order/fa02aa718992f6f9", "created_at": "2025-02-28T13:43:51.918Z", "previous_status": "assigning", "current_status": "assigned", "order_id": 12345 } } ``` **at\_pickup** The driver has arrived at the pickup location. **JSON Example** Sample Request \| at\_pickup ```json { "event": "order.status_change", "data": { "event_id": 987654, "public_url": "https://example.com/order/fa02aa718992f6f9", "created_at": "2025-02-28T14:02:51.918Z", "previous_status": "assigned", "current_status": "at_pickup", "order_id": 12345 } } ``` **out\_for\_delivery** The driver has picked up the order and is on the way to the drop-off location. **JSON Example** Sample Request \| out\_for\_delivery ```json { "event": "order.status_change", "data": { "event_id": 987654, "public_url": "https://example.com/order/fa02aa718992f6f9", "created_at": "2025-02-28T14:08:51.918Z", "previous_status": "at_pickup", "current_status": "out_for_delivery", "order_id": 12345 } } ``` **at\_drop\_off** The driver has arrived at the drop-off location. **JSON Example** Sample Request \| at\_drop\_off ```json { "event": "order.status_change", "data": { "event_id": 987654, "public_url": "https://example.com/order/fa02aa718992f6f9", "created_at": "2025-02-28T16:58:51.918Z", "previous_status": "out_for_delivery", "current_status": "at_drop_off", "order_id": 12345 } } ``` **delivered** The order has been delivered to the drop-off contact. **JSON Example** Sample Request \| delivered ```json { "event": "order.status_change", "data": { "event_id": 987654, "public_url": "https://example.com/order/fa02aa718992f6f9", "created_at": "2025-02-28T16:59:51.918Z", "previous_status": "at_drop_off", "current_status": "delivered", "order_id": 12345, "delivery_photos": ["http://s3.amazonaws.com/example.com/proof_of_delivery_photo.jpg"], "delivery_signee_name": "Ryan Andrews", "delivery_signature_photos": ["http://s3.amazonaws.com/example.com/delivery_signature_photo.jpg"] } } ``` **canceled** The order has been canceled. **JSON Example** Sample Request \| canceled ```json { "event": "order.status_change", "data": { "event_id": 987654, "public_url": "https://example.com/order/fa02aa718992f6f9", "created_at": "2025-02-28T13:31:51.918Z", "previous_status": "assigning", "current_status": "canceled", "order_id": 12345, "cancellation_reason": "Duplicate order" } } ``` **adjustment** An adjustment of price has been made to the order. **JSON Example** Sample Request \| adjustment ```json { "event": "order.adjustment", "data": { "event_id": 56306, "public_url": "https://example.com/order/47243e6dff7785ad", "created_at": "2025-02-28T13:31:51.918Z", "adjustment_amount": 12.56, "new_total_with_adjustment": 34.15, "reason": "service_change", "comments": "Service level change from standard to expedited", "order_id": 31068 } } ``` **JSON Example** Sample Request \| adjustment ```json { "event": "order.adjustment", "data": { "event_id": 56408, "public_url": "https://example.com/order/47243e6dff7785ad", "created_at": "2025-02-28T13:31:51.918Z", "adjustment_amount": -12.3, "new_total_with_adjustment": 17.5, "reason": "misc", "comments": "driver error adjustment", "order_id": 31068 } } ``` * * * ## Connect To configure webhooks, go to the [Developer Settings](https://app.dispatchit.com/developer_settings) page, scroll down to the Webhooks section and click Add / Update Webhooks. Choose Dispatch Connect for the product and enter the URL for Connect specific events. If you have webhooks configured for your organization, Dispatch will automatically send delivery status updates using the schema shown below. - **preparing**: A route is associated with a vehicle and in the process of being built, optimized, and validated on the Dashboard. - **sent\_to\_driver**: Route has been sent to the driver for pickup. - **en\_route**: Driver is currently completing stops on the route for today. - **complete**: All stops on the route have been completed, canceled, or marked as incomplete. - **canceled**: The delivery has been canceled. **JSON Example** Sample Event Object ```json { event: "delivery.status_change", data: { event_id: 123456, public_url: "https://example.com", created_at: "2021-05-11T19:08:01.030Z", previous_status: "sent_to_driver", current_status: "en_route", delivery_id: 12345 } } ``` Server Server:https://api.dispatchit.com/v1 Production server (uses live data) ## AuthenticationRequired Selected Auth Type: oauth2 Authorize | | | --- | | OAuth 2.0 authentication using Client Credentials flow.
Register a new OAuth2 client to obtain your client ID and client secret credentials at
[https://app.dispatchit.com/developer\_settings/oauth\_clients](https://app.dispatchit.com/developer_settings/oauth_clients) (production) or
[https://app.demo.dispatchit.com/developer\_settings/oauth\_clients](https://app.demo.dispatchit.com/developer_settings/oauth_clients) (test/demo).
Token URL for test/demo is [https://id.demo.dispatchit.com/oauth2/token](https://id.demo.dispatchit.com/oauth2/token).
More | | Token URL :
https://id.dispatchit.com/oauth2/token
Clear Value | | Client ID : | | Client Secret :
Show Password | | Credentials Location :
body
Clear Value | | No Scopes Defined
Add Scope | Client Libraries Shell Ruby Node.js PHP Python MoreSelect from all clients Shell Curl ## Orders ​Copy link Orders Operations - post/orders/estimates - post/orders - get/orders - get/orders/{id} - put/orders/{id} - get/orders/{id}/events - post/orders/multiple - post/orders/cancel ### Create an Estimate ​Copy link Auth Required Body application/json - drop\_off\_infoCopy link to drop\_off\_info Type: object required Show Child Attributesfor drop\_off\_info - pickup\_infoCopy link to pickup\_info Type: object required Show Child Attributesfor pickup\_info - vehicle\_typeCopy link to vehicle\_type Type: string required Example cargo\_van Type or size of vehicle needed (accepted values: car, midsize, cargo\_van, pickup\_truck, box\_truck) - add\_onsCopy link to add\_ons Type: array string\[\] Example \["dolly"\] List of add-ons to be included in the order - dedicated\_vehicleCopy link to dedicated\_vehicle Type: boolean Example false Whether the order should be placed on a dedicated vehicle - itemsCopy link to items Type: array object\[\] · item\[\] Optional. List of packages/items in the order. When provided, each item must include dimensions (length, width, height in inches) and weight (in lbs). Show Child Attributesfor items - organization\_idCopy link to organization\_id Type: number Example 25 Specify which organization the order should be placed under. Could be null if the organization is not a multi-tier organization Responses - 200 success application/json - 422 invalid request application/json Request Example for post/orders/estimates Shell Curl ```curl curl https://api.dispatchit.com/v1/orders/estimates \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "pickup_info": { "business_name": "Dispatch", "location": { "address": { "address_1": "1401 W 94th Street", "address_2": "", "city": "Bloomington", "state_province_code": "MN", "postal_code": "55431" } }, "pickup_date_time_utc": "2019-08-09T13:00:00.000Z" }, "drop_off_info": { "business_name": "the Nerdery", "estimated_weight": 1, "location": { "address": { "address_1": "9555 James Ave S", "address_2": "", "city": "Bloomington", "state_province_code": "MN", "postal_code": "55431" } }, "drop_off_date_time_utc": "2019-08-09T16:00:00.000Z" }, "organization_id": 25, "vehicle_type": "cargo_van", "add_ons": [\ "dolly"\ ], "dedicated_vehicle": false, "items": [\ {\ "name": "Cordless Power Drill",\ "description": "18V Lithium-Ion Cordless Drill Kit",\ "external_id": "DRILL-001",\ "scan_string": "DRILL-001",\ "sku": "DRILL-001",\ "quantity": 1,\ "weight": 200,\ "length": 25,\ "width": 25,\ "height": 25\ }\ ] }' ``` cURLCopy cURLCopy Test Request(post /orders/estimates) Status: 200Status: 422 Show Schema ```json { "available_order_options": [\ {\ "service_type": "asap",\ "estimated_delivery_time_utc": "2020-09-25T14:55:00.000Z",\ "estimated_order_cost": 35.45,\ "vehicle_type": "cargo_van",\ "pickup_location_info": {\ "google_place_id": "ChIJccOEgwIl9ocRxPMvVna7YYw",\ "lat": 44.8330852,\ "lng": -93.29837470000001\ },\ "drop_off_location_info": {\ "google_place_id": "ChIJb9qUiYQys1IRAt7Lxs19hgg",\ "lat": 44.9838208,\ "lng": -93.26709319999999\ },\ "estimate_info": {\ "service_type": "asap",\ "vehicle_type": "cargo_van",\ "toll_amount": "$0.00",\ "estimated_order_cost": "$35.45",\ "dedicated_vehicle_requested": false,\ "dedicated_vehicle_fee": "$0.00"\ },\ "add_ons": [\ "dolly"\ ]\ },\ {\ "service_type": "expedited",\ "estimated_delivery_time_utc": "2020-09-25T16:00:00.000Z",\ "estimated_order_cost": 32.4,\ "vehicle_type": "cargo_van",\ "pickup_location_info": {\ "google_place_id": "ChIJccOEgwIl9ocRxPMvVna7YYw",\ "lat": 44.8330852,\ "lng": -93.29837470000001\ },\ "drop_off_location_info": {\ "google_place_id": "ChIJb9qUiYQys1IRAt7Lxs19hgg",\ "lat": 44.9838208,\ "lng": -93.26709319999999\ },\ "estimate_info": {\ "service_type": "expedited",\ "vehicle_type": "cargo_van",\ "toll_amount": "$0.00",\ "estimated_order_cost": "$32.40",\ "dedicated_vehicle_requested": false,\ "dedicated_vehicle_fee": "$0.00"\ },\ "add_ons": [\ "dolly"\ ]\ }\ ] } ``` JSONCopy JSONCopy success ### Create an Order ​Copy link Auth Required Headers - Idempotency-KeyCopy link to Idempotency-Key Type: string max length: 255 Example 8e03978e-40d5-43e8-bc93-6894a57f9324 Optional client-supplied key, scoped per organization, that lets Dispatch safely deduplicate retries of the same order submission. If an order has already been created with this key for your organization, the request returns an error, so a retry never creates a duplicate. Body application/json - delivery\_infoCopy link to delivery\_info Type: object required Show Child Attributesfor delivery\_info - drop\_off\_infoCopy link to drop\_off\_info Type: object required Show Child Attributesfor drop\_off\_info - pickup\_infoCopy link to pickup\_info Type: object required Show Child Attributesfor pickup\_info - add\_onsCopy link to add\_ons Type: array string\[\] Example \["inside\_delivery"\] (beta feature) list of requested add ons. Reference add ons by their api name to include them in the order. If available, they will be added - itemsCopy link to items Type: array object\[\] · item\[\] Optional. List of packages/items in the order. When provided, each item must include dimensions (length, width, height in inches) and weight (in lbs). Show Child Attributesfor items Responses - 200 created application/json - 400 missing required fields application/json - 422 invalid fields application/json Request Example for post/orders Shell Curl ```curl curl https://api.dispatchit.com/v1/orders \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "delivery_info": { "reference_number": "ABC123", "organization_id": 25, "requester_user_id": "", "billing_notes": "HVAC supplies for installation of Project ABC123", "vehicle_type": "car", "quantity_of_packages": 4, "service_type": "asap", "needs_unloading_assistance": true, "pickup_date_time_utc": null, "drop_off_date_time_utc": "2019-08-13T23:00:00.000Z", "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com", "tracking_phone_numbers": "555-111-2222 555-222-3333, 555-444-3334", "dedicated_vehicle": false }, "pickup_info": { "business_name": "Dispatch", "contact_name": "David Reeves", "contact_phone_number": "123-123-1234", "location": { "address": { "address_1": "1401 W 94th Street", "address_2": "", "city": "Bloomington", "state_province_code": "MN", "postal_code": "55431" } }, "pickup_notes": null }, "drop_off_info": { "business_name": "The Nerdery", "contact_name": "Ian Carthey", "contact_phone_number": "123-123-1234", "estimated_weight": 1, "location": { "address": { "address_1": "9555 James Ave S", "address_2": "", "city": "Bloomington", "state_province_code": "MN", "postal_code": "55431" } }, "drop_off_notes": null, "options": { "signature_required": false } }, "add_ons": [\ "inside_delivery"\ ], "items": [\ {\ "name": "Cordless Power Drill",\ "description": "18V Lithium-Ion Cordless Drill Kit",\ "external_id": "DRILL-001",\ "scan_string": "DRILL-001",\ "sku": "DRILL-001",\ "quantity": 1,\ "weight": 200,\ "length": 25,\ "width": 25,\ "height": 25\ }\ ] }' ``` cURLCopy cURLCopy Test Request(post /orders) Status: 200Status: 400Status: 422 Show Schema ```json { "order_id": 1, "status": "string", "delivery_tracking_link": "string", "delivery_shareable_tracking_link": "string", "delivery_info": { "service_type": "string", "vehicle_type": "string", "toll_amount": "string", "estimated_order_cost": "string", "discount_amount": "string", "driver_current_coordinates": { "latitude": "string", "longitude": "string" }, "dedicated_vehicle_requested": true, "dedicated_vehicle_fee": "string", "estimated_miles": 1, "driver": { "id": 1, "first_name": "string" } }, "deliveries": [\ {\ "delivery_id": 1,\ "delivery_status": "string",\ "updated_at": "string",\ "reference_number": "string",\ "delivery_shareable_tracking_link": null,\ "drop_off_date_time_utc": "string",\ "tracking_email_addresses": "string",\ "tracking_phone_numbers": null,\ "delivery_photos": [\ "string"\ ],\ "delivery_signee_name": null,\ "delivery_signature_photos": null,\ "pickup_photos": [\ "https://example.com"\ ],\ "pickup_info": {\ "business_name": null,\ "contact_name": "string",\ "contact_phone_number": "string",\ "location": {\ "address": {\ "street": "string",\ "city": "string",\ "state_province_code": "string",\ "postal_code": "string"\ },\ "geo_coordinates": {\ "lng": "string",\ "lat": "string"\ }\ },\ "pickup_notes": null\ },\ "drop_off_info": {\ "business_name": null,\ "contact_name": "string",\ "contact_phone_number": "string",\ "location": {\ "address": {\ "street": "string",\ "city": "string",\ "state_province_code": "string",\ "postal_code": "string"\ },\ "geo_coordinates": {\ "lng": "string",\ "lat": "string"\ }\ },\ "drop_off_notes": null,\ "options": {\ "signature_required": null\ }\ }\ }\ ], "tags": [\ {\ "key": "string",\ "value": "string"\ }\ ] } ``` JSONCopy JSONCopy created ### Retrieve a List of Orders ​Copy link Auth Required The "updated\_after" parameter is optional. When "updated\_after=20230101" (format YYYYMMDD) is specified, the response body includes an array of orders objects that were updated after the date. Without "updated\_after" parameter, the response body will include the most recent orders. The "expand" parameter is optional. When the "expand=deliveries" is specified, the response body includes an array of delivery objects. When the "expand=tags" is specified, the response body includes an array of tag objects. Multiple expand options can be specified as a comma-separated list (e.g., "expand=deliveries,tags"). Without "expand" parameter, the response body only includes order object information. Each page has a maximum of 50 orders. Query Parameters - updated\_afterCopy link to updated\_after Type: string Example 20230101 - statusCopy link to status Type: string Example at\_pickup - pageCopy link to page Type: string Example 1 - expandCopy link to expand Type: string Example deliveries,tags Responses - 200 success application/json Request Example for get/orders Shell Curl ```curl curl https://api.dispatchit.com/v1/orders \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /orders) Status: 200 ```json { "current_page": 1, "total_pages": 1, "orders": [\ {\ "order_id": 1,\ "status": "unassigned",\ "delivery_tracking_link": "https://app.dispatchit.com/orders/1",\ "delivery_shareable_tracking_link": "https://app.dispatchit.com/order/a6fdb38dcb2a8177",\ "delivery_info": {\ "service_type": "multi_stop",\ "vehicle_type": "car",\ "toll_amount": "$0.00",\ "estimated_order_cost": "$29.70",\ "discount_amount": "$0.00",\ "dedicated_vehicle_requested": false,\ "dedicated_vehicle_fee": "$0.00",\ "estimated_miles": 10.1,\ "driver": {\ "id": 1,\ "first_name": "John"\ }\ }\ },\ {\ "order_id": 2,\ "status": "unassigned",\ "delivery_tracking_link": "https://app.dispatchit.com/orders/2",\ "delivery_shareable_tracking_link": "https://app.dispatchit.com/order/a6fdb38dcb2a8189",\ "delivery_info": {\ "service_type": "multi_stop",\ "vehicle_type": "car",\ "toll_amount": "$0.00",\ "estimated_order_cost": "$30.00",\ "discount_amount": "$0.00",\ "dedicated_vehicle_requested": false,\ "dedicated_vehicle_fee": "$0.00",\ "estimated_miles": 10.1,\ "driver": {\ "id": 2,\ "first_name": "Jane"\ }\ }\ }\ ] } ``` JSONCopy JSONCopy Without expand success ### Retrieve detail of an order ​Copy link Auth Required The "expand" parameter is optional. When the "expand=deliveries" is specified, the response body includes an array of delivery objects. When the "expand=tags" is specified, the response body includes an array of tag objects. Multiple expand options can be specified as a comma-separated list (e.g., "expand=deliveries,tags"). Without "expand" parameter, the response body only includes order object information. Path Parameters - idCopy link to id Type: string required Query Parameters - expandCopy link to expand Type: string Example deliveries,tags Responses - 200 success application/json - 404 order not found application/json Request Example for get/orders/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/orders/{id}' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /orders/{id}) Status: 200Status: 404 Show Schema ```json { "order_id": 534, "status": "unassigned", "delivery_tracking_link": "https://app.dispatchit.com/orders/534", "delivery_shareable_tracking_link": "https://app.dispatchit.com/order/a6fdb38dcb2a8177", "delivery_info": { "service_type": "multi_stop", "vehicle_type": "car", "toll_amount": "$0.00", "estimated_order_cost": "$29.70", "discount_amount": "$0.00", "estimated_miles": 10.1, "driver_current_coordinates": { "latitude": "39.9257629", "longitude": "-105.1357634" }, "dedicated_vehicle_requested": false, "dedicated_vehicle_fee": "$0.00", "driver": { "id": 1, "first_name": "John" } } } ``` JSONCopy JSONCopy Without expand success ### Edit an Order ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Body application/json - delivery\_infoCopy link to delivery\_info Type: object required Show Child Attributesfor delivery\_info - drop\_off\_infoCopy link to drop\_off\_info Type: object required Show Child Attributesfor drop\_off\_info - pickup\_infoCopy link to pickup\_info Type: object required Show Child Attributesfor pickup\_info Responses - 200 success application/json - 422 invalid\_request application/json Request Example for put/orders/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/orders/{id}' \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "delivery_info": { "reference_number": "ABC123", "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com", "tracking_phone_numbers": "555-111-2222 555-222-3333, 555-444-3334" }, "pickup_info": { "pickup_notes": "Pick there", "contact_name": "David Reeves", "contact_phone_number": "123-123-1234" }, "drop_off_info": { "drop_off_notes": "Drop here", "options": { "signature_required": false }, "contact_name": "Ian Carthey", "contact_phone_number": "123-123-1234" } }' ``` cURLCopy cURLCopy Test Request(put /orders/{id}) Status: 200Status: 422 ```json { "order_id": 537, "delivery_info": { "reference_number": "ABC123", "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com", "tracking_phone_numbers": "555-111-2222 555-222-3333, 555-444-3334" } } ``` JSONCopy JSONCopy success ### Retrieve order events ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 404 order not found application/json Request Example for get/orders/ _{id}_/events Shell Curl ```curl curl 'https://api.dispatchit.com/v1/orders/{id}/events' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /orders/{id}/events) Status: 200Status: 404 Show Schema ```json { "order_id": 1593921, "public_url": "https://staging.dispatchit.com/order/f8f7f96154acc7d1", "events": [\ {\ "current_status": "unassigned",\ "at": "2023-07-11T19:22:10.010Z",\ "previous_status": ""\ },\ {\ "current_status": "en_route_to_pickup",\ "at": "2023-07-11T19:22:21.860Z",\ "previous_status": "unassigned"\ },\ {\ "current_status": "at_pickup",\ "at": "2023-07-11T19:35:04.589Z",\ "previous_status": "en_route_to_pickup"\ },\ {\ "current_status": "en_route_to_drop_off",\ "at": "2023-07-11T19:35:52.413Z",\ "previous_status": "at_pickup"\ }\ ] } ``` JSONCopy JSONCopy success ### Create Multiple Orders ​Copy link Auth Required Body application/json - ordersCopy link to orders Type: array object\[\] required Show Child Attributesfor orders - asyncCopy link to async Type: boolean Example true When set to true orders will be created asynchronously in the background. The response will include a request id that can be used to get up to date information about the request status Responses - 200 partial success application/json - 201 created application/json - 400 all orders failed application/json Request Example for post/orders/multiple Shell Curl ```curl curl https://api.dispatchit.com/v1/orders/multiple \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "async": "true", "orders": [\ {\ "delivery_info": {\ "reference_number": "ABC123",\ "organization_id": 25,\ "requester_user_id": "",\ "billing_notes": "HVAC supplies for installation of Project ABC123",\ "vehicle_type": "car",\ "quantity_of_packages": 4,\ "service_type": "asap",\ "needs_unloading_assistance": true,\ "pickup_date_time_utc": null,\ "drop_off_date_time_utc": "2019-08-13T23:00:00.000Z",\ "tracking_email_addresses": "aaa@example.com, bbb@example.com",\ "tracking_phone_numbers": "555-111-2222, 555-222-3333",\ "dedicated_vehicle": false\ },\ "pickup_info": {\ "business_name": "Dispatch",\ "contact_name": "David Reeves",\ "contact_phone_number": "123-123-1234",\ "location": {\ "address": {\ "address_1": "1401 W 94th Street",\ "address_2": "",\ "city": "Bloomington",\ "state_province_code": "MN",\ "postal_code": "55431"\ }\ },\ "pickup_notes": null\ },\ "drop_off_info": {\ "business_name": "The Nerdery",\ "contact_name": "Ian Carthey",\ "contact_phone_number": "123-123-1234",\ "estimated_weight": 1,\ "location": {\ "address": {\ "address_1": "9555 James Ave S",\ "address_2": "",\ "city": "Bloomington",\ "state_province_code": "MN",\ "postal_code": "55431"\ }\ },\ "drop_off_notes": null\ },\ "add_ons": [\ "inside_delivery"\ ]\ }\ ] }' ``` cURLCopy cURLCopy Test Request(post /orders/multiple) Status: 200Status: 201Status: 400 ```json { "orders": [\ {\ "order_id": 538,\ "status": "unassigned",\ "delivery_tracking_link": "https://app.dispatchit.com/orders/538",\ "delivery_shareable_tracking_link": "https://app.dispatchit.com/order/7986479231dd6259",\ "delivery_info": {\ "service_type": "asap",\ "vehicle_type": "car",\ "toll_amount": "$0.00",\ "estimated_order_cost": "$19.70",\ "discount_amount": "$0.00",\ "dedicated_vehicle_requested": false,\ "dedicated_vehicle_fee": "$0.00"\ },\ "deliveries": [\ {\ "delivery_id": 541,\ "delivery_status": "unassigned",\ "updated_at": "2023-07-07T19:50:59Z",\ "reference_number": "Bulk-Create-0",\ "delivery_shareable_tracking_link": "https://app.dispatchit.com/delivery/3df78552-75c1-4d98-8986-457f7497dc2c",\ "drop_off_date_time_utc": "2019-08-13T23:00:00Z",\ "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com",\ "tracking_phone_numbers": "444-444-4444, 555-555-5555",\ "delivery_photos": null,\ "delivery_signee_name": "Amy Franco",\ "delivery_signature_photos": null,\ "pickup_info": {\ "business_name": "Dispatch",\ "contact_name": "Grace Murray",\ "contact_phone_number": "201-626-2211",\ "location": {\ "address": {\ "street": "2800 E 2nd Ave",\ "city": "Denver",\ "state_province_code": "CO",\ "postal_code": "80206"\ },\ "geo_coordinates": {\ "lng": "-104.9542084",\ "lat": "39.71925239999999"\ }\ },\ "pickup_notes": "Wait outside"\ },\ "drop_off_info": {\ "business_name": "Dispatchit, Inc.",\ "contact_name": "Grace Murray",\ "contact_phone_number": "551-200-9054",\ "location": {\ "address": {\ "street": "1744 E Evans Ave",\ "city": "Denver",\ "state_province_code": "CO",\ "postal_code": "80210"\ },\ "geo_coordinates": {\ "lng": "-104.9667679",\ "lat": "39.6782574"\ }\ },\ "drop_off_notes": "Leave on porch"\ }\ }\ ]\ },\ {\ "order_id": 539,\ "status": "unassigned",\ "delivery_tracking_link": "https://app.dispatchit.com/orders/539",\ "delivery_shareable_tracking_link": "https://app.dispatchit.com/order/6dca638b9bb9523d",\ "delivery_info": {\ "service_type": "asap",\ "vehicle_type": "midsize",\ "toll_amount": "$0.00",\ "estimated_order_cost": "$22.33",\ "discount_amount": "$0.00",\ "dedicated_vehicle_requested": false,\ "dedicated_vehicle_fee": "$0.00"\ },\ "deliveries": [\ {\ "delivery_id": 542,\ "delivery_status": "unassigned",\ "updated_at": "2023-07-07T19:51:03Z",\ "reference_number": "Bulk-Create-1",\ "delivery_shareable_tracking_link": "https://app.dispatchit.com/delivery/80ef2bab-db90-4014-984d-6831c0176580",\ "drop_off_date_time_utc": "2019-08-13T23:00:00Z",\ "tracking_email_addresses": "john@example.com",\ "tracking_phone_numbers": "123-456-7890",\ "delivery_photos": null,\ "delivery_signee_name": "Fred Marcos",\ "delivery_signature_photos": null,\ "pickup_info": {\ "business_name": "Wynkoop",\ "contact_name": "Adam Guy",\ "contact_phone_number": "201-626-2211",\ "location": {\ "address": {\ "street": "1634 18th St",\ "city": "Denver",\ "state_province_code": "CO",\ "postal_code": "80202"\ },\ "geo_coordinates": {\ "lng": "-104.9985353",\ "lat": "39.7534202"\ }\ },\ "pickup_notes": "Come to back door"\ },\ "drop_off_info": {\ "business_name": "Blue Moon Brewing RiNo.",\ "contact_name": "Jane Manager",\ "contact_phone_number": "551-200-9054",\ "location": {\ "address": {\ "street": "3750 Chestnut Pl",\ "city": "Denver",\ "state_province_code": "CO",\ "postal_code": "80216"\ },\ "geo_coordinates": {\ "lng": "-104.9769672",\ "lat": "39.77363039999999"\ }\ },\ "drop_off_notes": "Leave in mailbox"\ }\ }\ ]\ }\ ], "errors": [\ {\ "error": {\ "code": "invalid_drop_off_address",\ "message": "failed to geocode provided address",\ "order_info": {\ "delivery_info": {\ "reference_number": "Bulk-Create-2",\ "vehicle_type": "cargo_van",\ "quantity_of_packages": 4,\ "service_type": "asap",\ "pickup_date_time_utc": "2023-07-09T13:00:00.000Z",\ "drop_off_date_time_utc": "2019-08-13T23:00:00.000Z",\ "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com",\ "tracking_phone_numbers": "444-444-4444, 555-555-5555"\ },\ "pickup_info": {\ "business_name": "Denver Beer Co",\ "contact_name": "Brian Owner",\ "contact_phone_number": "201-626-2211",\ "pickup_notes": "Left on porch",\ "location": {\ "geo_coordinates": {\ "lat": null,\ "lng": null\ },\ "address": {\ "address_1": "1695 Platte St",\ "address_2": null,\ "city": "Denver",\ "state_province_code": "CO",\ "postal_code": "80202"\ }\ }\ },\ "drop_off_info": {\ "business_name": "LUKI Brewery",\ "contact_name": "Roger Supplier",\ "contact_phone_number": "551-200-9054",\ "drop_off_notes": "Bring to back door",\ "location": {\ "geo_coordinates": {\ "lat": null,\ "lng": null\ },\ "address": {\ "address_1": "",\ "address_2": "",\ "city": "",\ "state_province_code": "",\ "postal_code": ""\ }\ }\ }\ }\ },\ "code": null,\ "message": null\ }\ ] } ``` JSONCopy JSONCopy partial success ### Cancel an Order ​Copy link Auth Required Body application/json - order\_idCopy link to order\_id Type: integer required Example 123456 ID of the order to be canceled - cancellation\_commentCopy link to cancellation\_comment Type: string Example Accidentally created two of the same order. Comment about why the order is to be canceled - cancellation\_reasonCopy link to cancellation\_reason Type: string Example order\_not\_ready Reason for the order cancellation. Must be one of the following: took\_too\_long\_to\_assign\_driver; change\_in\_schedule; order\_not\_ready\_for\_pickup; input\_error\_need\_to\_edit; changed\_mind; other; no\_site\_contact\_or\_entry; bad\_conditions\_or\_site\_not\_cleared; wrong\_vehicle\_type\_arrived; duplicate\_order; vehicle\_at\_capacity; driver\_running\_behind\_schedule Responses - 200 success application/json - 400 missing required fields application/json - 422 order already canceled application/json Request Example for post/orders/cancel Shell Curl ```curl curl https://api.dispatchit.com/v1/orders/cancel \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "order_id": "123456", "cancellation_comment": "Accidentally created two of the same order.", "cancellation_reason": "order_not_ready" }' ``` cURLCopy cURLCopy Test Request(post /orders/cancel) Status: 200Status: 400Status: 422 Show Schema ```json { "order_id": 537, "status": "cancelled", "delivery_tracking_link": "https://app.dispatchit.com/orders/537", "delivery_shareable_tracking_link": "https://app.dispatchit.com/order/936bd63548b13122", "delivery_info": { "service_type": "asap", "vehicle_type": "car", "toll_amount": "$0.00", "estimated_order_cost": "$19.70" } } ``` JSONCopy JSONCopy success ## Organization ​Copy link Organization Operations - get/organizations ### Retrieve a list of organizations ​Copy link Auth Required Responses - 200 success application/json Request Example for get/organizations Shell Curl ```curl curl https://api.dispatchit.com/v1/organizations \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /organizations) Status: 200 ```json [\ {\ "id": 7,\ "name": "Dispatchit, Inc."\ },\ {\ "id": 8,\ "name": "Chocolate, Inc."\ },\ {\ "id": 9,\ "name": "Freud & Co."\ },\ {\ "id": 10,\ "name": "Unlimited Ltd."\ }\ ] ``` JSONCopy JSONCopy success ## Request ​Copy link Request Operations - get/requests/{id} ### Retrieve request information ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 404 request not found application/json Request Example for get/requests/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/requests/{id}' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /requests/{id}) Status: 200Status: 404 ```json { "id": "3be06c47-ea70-424e-b2e8-e7f50c828ba4", "status": "received", "request_data": { "orders": [\ {\ "pickup_info": {\ "location": {\ "address": {\ "city": " Aurora",\ "address_1": "9655 E Montview Blvd",\ "address_2": null,\ "postal_code": " 80010",\ "state_province_code": " CO"\ },\ "geo_coordinates": {\ "lat": null,\ "lng": null\ }\ },\ "contact_name": "Linn Grady DO",\ "pickup_notes": "Inverse 5th generation secured line deploy cutting-edge systems",\ "business_name": "Marquardt, Hyatt and Rath",\ "contact_phone_number": "401.641.3210"\ },\ "delivery_info": {\ "service_type": "asap",\ "vehicle_type": "midsize",\ "reference_number": "GEN-1-6k6tq",\ "pickup_date_time_utc": "2023-07-09T13:00:00.000Z",\ "quantity_of_packages": 9,\ "drop_off_date_time_utc": "2023-07-09T13:00:00.000Z",\ "tracking_phone_numbers": "333-333-3333, 444-444-4444 555-555-5555",\ "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com"\ },\ "drop_off_info": {\ "location": {\ "address": {\ "city": " Englewood",\ "address_1": "2796 S Broadway",\ "address_2": null,\ "postal_code": " 80113",\ "state_province_code": " CO"\ },\ "geo_coordinates": {\ "lat": null,\ "lng": null\ }\ },\ "contact_name": "Arnoldo Hickle",\ "business_name": "Nienow, Hackett and Gutmann",\ "drop_off_notes": "Distributed background hub cultivate interactive ROI",\ "contact_phone_number": "517-772-3593"\ }\ },\ {\ "pickup_info": {\ "location": {\ "address": {\ "city": " Englewood",\ "address_1": "3298 S Broadway B",\ "address_2": null,\ "postal_code": " 80113",\ "state_province_code": " CO"\ },\ "geo_coordinates": {\ "lat": null,\ "lng": null\ }\ },\ "contact_name": "Alexander Jerde",\ "pickup_notes": "Re-contextualized encompassing application drive frictionless initiatives",\ "business_name": "Schmeler, Orn and Denesik",\ "contact_phone_number": "419-719-3613"\ },\ "delivery_info": {\ "service_type": "asap",\ "vehicle_type": "pickup_truck",\ "reference_number": "GEN-2-3fbm5",\ "pickup_date_time_utc": "2023-07-09T13:00:00.000Z",\ "quantity_of_packages": 13,\ "drop_off_date_time_utc": "2023-07-09T13:00:00.000Z",\ "tracking_phone_numbers": "333-333-3333, 444-444-4444 555-555-5555",\ "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com"\ },\ "drop_off_info": {\ "location": {\ "address": {\ "city": " Denver",\ "address_1": "2434 W 44th Ave",\ "address_2": null,\ "postal_code": " 80211",\ "state_province_code": " CO"\ },\ "geo_coordinates": {\ "lat": null,\ "lng": null\ }\ },\ "contact_name": "Gordon Wisoky",\ "business_name": "Kihn-Keeling",\ "drop_off_notes": "Open-architected actuating encryption generate ubiquitous methodologies",\ "contact_phone_number": "561.808.3232"\ }\ },\ {\ "pickup_info": {\ "location": {\ "address": {\ "city": " Denver",\ "address_1": "2434 W 44th Ave",\ "address_2": null,\ "postal_code": " 80211",\ "state_province_code": " CO"\ },\ "geo_coordinates": {\ "lat": null,\ "lng": null\ }\ },\ "contact_name": "Maia Barrows",\ "pickup_notes": "Ameliorated modular installation transition out-of-the-box vortals",\ "business_name": "Flatley LLC",\ "contact_phone_number": "253-859-8813"\ },\ "delivery_info": {\ "service_type": "asap",\ "vehicle_type": "cargo_van",\ "reference_number": "GEN-3-qjd9g",\ "pickup_date_time_utc": "2023-07-09T13:00:00.000Z",\ "quantity_of_packages": 15,\ "drop_off_date_time_utc": "2023-07-10T13:00:00.000Z",\ "tracking_phone_numbers": "333-333-3333, 444-444-4444 555-555-5555",\ "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com"\ },\ "drop_off_info": {\ "location": {\ "address": {\ "city": " Denver",\ "address_1": "206 E 13th Ave",\ "address_2": null,\ "postal_code": " 80203",\ "state_province_code": " CO"\ },\ "geo_coordinates": {\ "lat": null,\ "lng": null\ }\ },\ "contact_name": "Dr. Bernardine Davis",\ "business_name": "Mosciski, Strosin and West",\ "drop_off_notes": "Extended scalable algorithm engage cross-media technologies",\ "contact_phone_number": "410-563-9661"\ }\ }\ ] } } ``` JSONCopy JSONCopy success ## Deliveries ​Copy link Deliveries Operations - get/deliveries/{id} - get/deliveries/{id}/events ### Retrieve detail of a delivery ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 404 delivery not found application/json Request Example for get/deliveries/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/deliveries/{id}' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /deliveries/{id}) Status: 200Status: 404 Show Schema ```json { "delivery_id": 562, "delivery_status": "unassigned", "updated_at": "2023-07-10T19:33:05Z", "reference_number": "API test", "delivery_shareable_tracking_link": "https://app.dispatchit.com/delivery/d33e9dbb-d398-4492-86f9-9b295564a2e5", "drop_off_date_time_utc": "2019-08-13T23:00:00Z", "tracking_email_addresses": "aaa@example.com, bbb@example.com ccc@example.com", "tracking_phone_numbers": "333-333-3333, 444-444-4444 555-555-5555", "delivery_photos": null, "delivery_signee_name": "Ted Denver", "delivery_signature_photos": null, "pickup_info": { "business_name": "Dispatch", "contact_name": "Grace Murray", "contact_phone_number": "201-626-2211", "location": { "address": { "street": "2800 E 2nd Ave", "city": "Denver", "state_province_code": "CO", "postal_code": "99999" }, "geo_coordinates": { "lng": "-104.9542084", "lat": "39.71925239999999" } }, "pickup_notes": "Come to back door" }, "drop_off_info": { "business_name": "Dispatchit, Inc.", "contact_name": "Grace Murray", "contact_phone_number": "551-200-9054", "location": { "address": { "street": "1744 E Evans Ave", "city": "Denver", "state_province_code": "CO", "postal_code": "99999" }, "geo_coordinates": { "lng": "-104.9667679", "lat": "39.6782574" } }, "drop_off_notes": "Leave on steps", "options": { "signature_required": false } } } ``` JSONCopy JSONCopy success ### Retrieve delivery events ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 404 delivery not found application/json Request Example for get/deliveries/ _{id}_/events Shell Curl ```curl curl 'https://api.dispatchit.com/v1/deliveries/{id}/events' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /deliveries/{id}/events) Status: 200Status: 404 ```json { "delivery_id": 1649496, "public_url": "https://staging.dispatchit.com/delivery/6e7dc686-4953-42d5-a47f-963c2361f6fe", "order_id": 1593921, "events": [\ {\ "current_status": "unassigned",\ "at": "2023-07-11T19:22:10.010Z",\ "previous_status": ""\ },\ {\ "current_status": "en_route_to_pickup",\ "at": "2023-07-11T19:22:21.860Z",\ "previous_status": "unassigned"\ },\ {\ "current_status": "at_pickup",\ "at": "2023-07-11T19:35:04.589Z",\ "previous_status": "en_route_to_pickup"\ },\ {\ "current_status": "en_route_to_drop_off",\ "at": "2023-07-11T19:35:52.413Z",\ "previous_status": "at_pickup"\ },\ {\ "current_status": "at_drop_off",\ "at": "2023-07-12T16:22:42.570Z",\ "previous_status": "en_route_to_drop_off"\ },\ {\ "current_status": "delivered",\ "at": "2023-07-12T16:23:22.915Z",\ "previous_status": "at_drop_off"\ }\ ] } ``` JSONCopy JSONCopy success ## Invoices ​Copy link Invoices Operations - get/invoices - get/invoices/{id} ### List invoices from user's organization ​Copy link Auth Required Query Parameters - per\_pageCopy link to per\_page Type: string The size of the result set. Default is 20 and max is 50 - pageCopy link to page Type: string This parameter will help page through large result sets. Default is 1. - invoice\_dateCopy link to invoice\_date Type: string Query Invoice by Invoice Date. eg, invoice\_date=2020-02-20 - statusCopy link to status Type: string Query Invoice status. eg. \[Posted,Paid,Draft,Reversed\] etc Responses - 200 success application/json - 401 not authorized application/json - 422 missing ordway customer id application/json Request Example for get/invoices Shell Curl ```curl curl https://api.dispatchit.com/v1/invoices \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /invoices) Status: 200Status: 401Status: 422 ```json { "page": 1, "per_page": 20, "invoices": [\ {\ "id": "INV-00728",\ "customer_id": "test_id",\ "billing_contact": {\ "zip": "51325",\ "city": "Somewhere",\ "email": "test@test.com",\ "phone": "354-153-2525",\ "state": "NE",\ "county": "",\ "mobile": "",\ "country": "United States",\ "address1": "7851 Test Ct",\ "address2": "",\ "job_title": "",\ "last_name": "test",\ "department": "",\ "first_name": "test",\ "display_name": "test"\ },\ "shipping_contact": {\ "zip": "",\ "city": "",\ "email": "",\ "phone": "",\ "state": "",\ "county": "",\ "mobile": "",\ "country": "",\ "address1": "",\ "address2": "",\ "job_title": "",\ "last_name": "",\ "department": "",\ "first_name": "",\ "display_name": "Marc Tomas"\ },\ "customer_name": "Ordway Testing",\ "invoice_date": "2023-01-31",\ "due_date": "2023-02-15",\ "start_date": "2023-01-01",\ "end_date": "2023-01-31",\ "billing_run_id": "BR-01606",\ "discount_display_name": "Net 15",\ "subtotal": "70.00",\ "invoice_tax": "0.00",\ "invoice_amount": "70.00",\ "paid_amount": "20.00",\ "balance": "50.0",\ "status": "Partially paid",\ "notes": "",\ "invoice_pdf_url": "https://test.com",\ "currency": "USD",\ "exchange_rate": 1,\ "payment_term_id": 165,\ "payment_terms": "Net 15",\ "created_date": "2023-11-03T01:00:04.899Z",\ "updated_date": "2023-11-03T01:11:37.657Z",\ "emailed": false,\ "reversal_email": false,\ "created_by": "user.one@ordwaylabs.com",\ "updated_by": "user.one@ordwaylabs.com",\ "line_items": [\ {\ "line_no": "1",\ "subscription_id": "S-00309",\ "customer_id": "C787",\ "customer_name": "Ordway Testing",\ "product_id": "P-00087",\ "product_name": "Truck Subscription Service",\ "plan_id": "PLN-00006",\ "plan_name": "Connect Starter Monthly Truck Subscription Service",\ "charge_id": "CHG-00008",\ "subscription_line_id": "SCHG-01",\ "charge_name": "Monthly Truck Subscription",\ "charge_type": "recurring",\ "description": "Monthly Truck Subscription",\ "start_date": "2023-01-01",\ "end_date": "2023-01-31",\ "unit_price": "70.00",\ "list_price": "70.00",\ "list_price_base": "Billing Period",\ "taxable": false,\ "quantity": 1,\ "included_quantity": 0,\ "discount": "0.0",\ "effective_price": "70.00",\ "line_tax": "0.00",\ "tax_lines": [],\ "applied_tiers": "",\ "custom_fields": {\ "public_order_url": "",\ "pickup_wait_time_minutes": "",\ "pickup_wait_time_fee": "",\ "drop_off_location": "",\ "pickup_location": "",\ "job_name": "",\ "order_url": "",\ "dispatch_order_id": "",\ "order_notes": "",\ "is_additional_charge": false,\ "dispatch_adjustment_id": "",\ "dedicated_vehicle_fee": "",\ "customer_discount_percentage": ""\ },\ "public_order_url": "",\ "pickup_wait_time_minutes": "",\ "pickup_wait_time_fee": "",\ "drop_off_location": "",\ "pickup_location": "",\ "job_name": "",\ "order_url": "",\ "dispatch_order_id": "",\ "order_notes": "",\ "is_additional_charge": false,\ "dispatch_adjustment_id": "",\ "dedicated_vehicle_fee": "",\ "customer_discount_percentage": ""\ }\ ],\ "subtotals": [],\ "payments": [\ {\ "id": "PMT-00118",\ "customer_id": "C787",\ "customer_name": "Ordway Testing",\ "payment_date": "2023-11-02",\ "notes": "",\ "status": "Processed",\ "payment_amount": "300.00",\ "fee_amount": "0.00",\ "applied_amount": "20.00",\ "unapplied_amount": "260.00",\ "refunded_amount": "0.00",\ "payment_type": "External",\ "payment_method": "Other",\ "currency": "USD",\ "conversion_rate": 1,\ "reference_number": "",\ "auto_apply": false,\ "created_by": "user.one@ordwaylabs.com",\ "updated_by": "user.one@ordwaylabs.com",\ "created_date": "2023-11-03T01:11:35.765Z",\ "updated_date": "2023-11-03T01:11:35.696Z",\ "failed_attempt": 0,\ "failure_reason": "",\ "refunds": [],\ "retried_attempts": 0,\ "gl_account": "Checking",\ "email_status": false,\ "payment_run_id": "",\ "opt": {},\ "custom_fields": {\ "quickbooks_id": ""\ },\ "quickbooks_id": ""\ }\ ],\ "credits": [],\ "refunds": [],\ "custom_fields": {\ "market": "Twin Cities",\ "po_number": "",\ "invoicecustomer_id": "C787",\ "subscripton_id": "",\ "quickbooks_id": ""\ },\ "market": "Twin Cities",\ "po_number": "",\ "invoicecustomer_id": "C787",\ "subscripton_id": "",\ "quickbooks_id": ""\ }\ ] } ``` JSONCopy JSONCopy success ### Get invoice details ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 401 not authorized when trying to access an invoice from another organization application/json - 404 invoice not found application/json - 422 missing ordway customer id application/json Request Example for get/invoices/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/invoices/{id}' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /invoices/{id}) Status: 200Status: 401Status: 404Status: 422 Show Schema ```json { "id": "INV-00728", "customer_id": "test_id", "billing_contact": { "zip": "51325", "city": "Somewhere", "email": "test@test.com", "phone": "354-153-2525", "state": "NE", "county": "", "mobile": "", "country": "United States", "address1": "7851 Test Ct", "address2": "", "job_title": "", "last_name": "test", "department": "", "first_name": "test", "display_name": "test" }, "shipping_contact": { "zip": "", "city": "", "email": "", "phone": "", "state": "", "county": "", "mobile": "", "country": "", "address1": "", "address2": "", "job_title": "", "last_name": "", "department": "", "first_name": "", "display_name": "Marc Tomas" }, "customer_name": "Ordway Testing", "invoice_date": "2023-01-31", "due_date": "2023-02-15", "start_date": "2023-01-01", "end_date": "2023-01-31", "billing_run_id": "BR-01606", "discount_display_name": "Net 15", "subtotal": "70.00", "invoice_tax": "0.00", "invoice_amount": "70.00", "paid_amount": "20.00", "balance": "50.0", "status": "Partially paid", "notes": "", "invoice_pdf_url": "https://test.com", "currency": "USD", "exchange_rate": 1, "payment_term_id": 165, "payment_terms": "Net 15", "created_date": "2023-11-03T01:00:04.899Z", "updated_date": "2023-11-03T01:11:37.657Z", "emailed": false, "reversal_email": false, "created_by": "user.one@ordwaylabs.com", "updated_by": "user.one@ordwaylabs.com", "line_items": [\ {\ "line_no": "1",\ "subscription_id": "S-00309",\ "customer_id": "C787",\ "customer_name": "Ordway Testing",\ "product_id": "P-00087",\ "product_name": "Truck Subscription Service",\ "plan_id": "PLN-00006",\ "plan_name": "Connect Starter Monthly Truck Subscription Service",\ "charge_id": "CHG-00008",\ "subscription_line_id": "SCHG-01",\ "charge_name": "Monthly Truck Subscription",\ "charge_type": "recurring",\ "description": "Monthly Truck Subscription",\ "start_date": "2023-01-01",\ "end_date": "2023-01-31",\ "unit_price": "70.00",\ "list_price": "70.00",\ "list_price_base": "Billing Period",\ "taxable": false,\ "quantity": 1,\ "included_quantity": 0,\ "discount": "0.0",\ "effective_price": "70.00",\ "line_tax": "0.00",\ "tax_lines": [],\ "applied_tiers": "",\ "custom_fields": {\ "public_order_url": "",\ "pickup_wait_time_minutes": "",\ "pickup_wait_time_fee": "",\ "drop_off_location": "",\ "pickup_location": "",\ "job_name": "",\ "order_url": "",\ "dispatch_order_id": "",\ "order_notes": "",\ "is_additional_charge": false,\ "dispatch_adjustment_id": "",\ "dedicated_vehicle_fee": "",\ "customer_discount_percentage": ""\ },\ "public_order_url": "",\ "pickup_wait_time_minutes": "",\ "pickup_wait_time_fee": "",\ "drop_off_location": "",\ "pickup_location": "",\ "job_name": "",\ "order_url": "",\ "dispatch_order_id": "",\ "order_notes": "",\ "is_additional_charge": false,\ "dispatch_adjustment_id": "",\ "dedicated_vehicle_fee": "",\ "customer_discount_percentage": ""\ }\ ], "subtotals": [], "payments": [\ {\ "id": "PMT-00118",\ "customer_id": "C787",\ "customer_name": "Ordway Testing",\ "payment_date": "2023-11-02",\ "notes": "",\ "status": "Processed",\ "payment_amount": "300.00",\ "fee_amount": "0.00",\ "applied_amount": "20.00",\ "unapplied_amount": "260.00",\ "refunded_amount": "0.00",\ "payment_type": "External",\ "payment_method": "Other",\ "currency": "USD",\ "conversion_rate": 1,\ "reference_number": "",\ "auto_apply": false,\ "created_by": "user.one@ordwaylabs.com",\ "updated_by": "user.one@ordwaylabs.com",\ "created_date": "2023-11-03T01:11:35.765Z",\ "updated_date": "2023-11-03T01:11:35.696Z",\ "failed_attempt": 0,\ "failure_reason": "",\ "refunds": [],\ "retried_attempts": 0,\ "gl_account": "Checking",\ "email_status": false,\ "payment_run_id": "",\ "opt": {},\ "custom_fields": {\ "quickbooks_id": ""\ },\ "quickbooks_id": ""\ }\ ], "credits": [], "refunds": [], "custom_fields": { "market": "Twin Cities", "po_number": "", "invoicecustomer_id": "C787", "subscripton_id": "", "quickbooks_id": "" }, "market": "Twin Cities", "po_number": "", "invoicecustomer_id": "C787", "subscripton_id": "", "quickbooks_id": "" } ``` JSONCopy JSONCopy success ## Connect ​Copy link Connect Operations - get/connect/deliveries - post/connect/deliveries - get/connect/deliveries/{id} - put/connect/deliveries/{id} - put/connect/cancel\_delivery/{id} - put/connect/deliveries/{id}/assign\_delivery\_to\_vehicle - get/connect/organization - get/connect/organizations/list\_branches - get/connect/vehicles/{id} - delete/connect/vehicles/{id} - get/connect/vehicles - post/connect/vehicles - put/connect/vehicles/{id}/send\_to\_driver - put/connect/vehicles/{id}/assign\_driver - get/connect/drivers - get/connect/manifests - get/connect/users ### Retrieve All Deliveries for a Date ​Copy link Auth Required If not passed a "date" query parameter (format YYYYMMDD), defaults to today Query Parameters - dateCopy link to date Type: string Example 20200101 Responses - 200 Deliveries for a specific date application/json - 422 Bad date application/json Request Example for get/connect/deliveries Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/deliveries \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/deliveries) Status: 200Status: 422 ```json [\ {\ "id": "1",\ "job_name": "1234",\ "delivery_size": 1,\ "status": "unassigned",\ "pickup_contact": "Connect",\ "pickup_phone_number": "555-111-0000",\ "pickup_notes": "Pickup Notes",\ "drop_off_contact": "Alpha Dropoff Contact @ Somewhere",\ "drop_off_phone_number": "555-111-0000",\ "drop_off_notes": "Drop-Off Notes",\ "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com",\ "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555",\ "pickup_window_start_at": "2023-07-03T14:00:00.000Z",\ "pickup_window_end_at": "2023-07-03T20:00:00.000Z",\ "drop_off_window_start_at": "2023-07-03T22:00:00.000Z",\ "drop_off_window_end_at": "2023-07-04T02:00:00.000Z",\ "pickup_address": {\ "id": 2,\ "name": "Victor's 1959 Cafe",\ "street": "3756 Grand Ave S",\ "city": "Minneapolis",\ "state": "MN",\ "postal_code": "55409",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:51:11.426Z",\ "updated_at": "2023-07-03T15:51:11.426Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.9342239",\ "geo_lng": "-93.2847127",\ "google_place_id": "ChIJAzVY9b0n9ocR4J7ffirBPLI",\ "is_draft": false,\ "lonlat": "POINT (-93.2847127 44.9342239)",\ "description": "Victor's 1959 Cafe, Grand Avenue South, Minneapolis, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "King Field",\ "manual_location": null\ },\ "drop_off_address": {\ "id": 8,\ "name": "Pho 79",\ "street": "2529 Nicollet Ave",\ "city": "Minneapolis",\ "state": "MN",\ "postal_code": "55404",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:51:11.487Z",\ "updated_at": "2023-07-03T15:51:11.487Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.9562889",\ "geo_lng": "-93.2776083",\ "google_place_id": "ChIJse3VlbUys1IRy3MSgozQXuo",\ "is_draft": false,\ "lonlat": "POINT (-93.2776083 44.9562889)",\ "description": "Pho 79, Nicollet Avenue, Minneapolis, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "Powderhorn",\ "manual_location": null\ },\ "pickup_duration_in_minutes": 5,\ "drop_off_duration_in_minutes": null,\ "organization_id": "1",\ "connect_organization_id": "1",\ "shareable_link": "https://app.dispatchit.com/connect/delivery/0aee25ca-d514-4235-bc9c-0a39934754f8",\ "will_call": false\ },\ {\ "id": "2",\ "job_name": "1234",\ "delivery_size": 4,\ "status": "unassigned",\ "pickup_contact": "Connect",\ "pickup_phone_number": "555-111-0000",\ "pickup_notes": "Pickup Notes",\ "drop_off_contact": "Alpha Dropoff Contact @ Somewhere",\ "drop_off_phone_number": "555-111-0000",\ "drop_off_notes": "Drop-Off Notes",\ "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com",\ "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555",\ "pickup_window_start_at": "2023-07-03T13:00:00.000Z",\ "pickup_window_end_at": "2023-07-03T14:00:00.000Z",\ "drop_off_window_start_at": "2023-07-03T23:00:00.000Z",\ "drop_off_window_end_at": "2023-07-04T00:00:00.000Z",\ "pickup_address": {\ "id": 5,\ "name": "Stella's Fish Café & Prestige Oyster Bar",\ "street": "1400 W Lake St",\ "city": "Minneapolis",\ "state": "MN",\ "postal_code": "55408",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:51:11.459Z",\ "updated_at": "2023-07-03T15:51:11.459Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.948645",\ "geo_lng": "-93.29729999999999",\ "google_place_id": "ChIJmwWYkoEn9ocRRN4pdA7cUwo",\ "is_draft": false,\ "lonlat": "POINT (-93.29729999999999 44.948645)",\ "description": "Stella's Fish Café & Prestige Oyster Bar, West Lake Street, Minneapolis, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "Lowry Hill East",\ "manual_location": null\ },\ "drop_off_address": {\ "id": 1,\ "name": "Dispatch",\ "street": "1401 W 94th St",\ "city": "Bloomington",\ "state": "MN",\ "postal_code": "55431",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:46:33.443Z",\ "updated_at": "2023-07-03T15:46:33.443Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.83247",\ "geo_lng": "-93.29798799999999",\ "google_place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o",\ "is_draft": false,\ "lonlat": "POINT (-93.29798799999999 44.83247)",\ "description": "Dispatch, West 94th Street, Bloomington, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "West Bloomington",\ "manual_location": null\ },\ "pickup_duration_in_minutes": 5,\ "drop_off_duration_in_minutes": null,\ "organization_id": "1",\ "connect_organization_id": "1",\ "shareable_link": "https://app.dispatchit.com/connect/delivery/fd8f04a0-0fdb-48f5-9600-a77090cceff0",\ "will_call": false\ },\ {\ "id": "3",\ "job_name": "1234",\ "delivery_size": 4,\ "status": "unassigned",\ "pickup_contact": "Connect",\ "pickup_phone_number": "555-111-0000",\ "pickup_notes": "Pickup Notes",\ "drop_off_contact": "Alpha Dropoff Contact @ Somewhere",\ "drop_off_phone_number": "555-111-0000",\ "drop_off_notes": "Drop-Off Notes",\ "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com",\ "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555",\ "pickup_window_start_at": "2023-07-03T15:00:00.000Z",\ "pickup_window_end_at": "2023-07-03T17:00:00.000Z",\ "drop_off_window_start_at": "2023-07-03T22:00:00.000Z",\ "drop_off_window_end_at": "2023-07-04T02:00:00.000Z",\ "pickup_address": {\ "id": 7,\ "name": "The Lowbrow",\ "street": "4244 Nicollet Ave",\ "city": "Minneapolis",\ "state": "MN",\ "postal_code": "55409",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:51:11.478Z",\ "updated_at": "2023-07-03T15:51:11.478Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.9254287",\ "geo_lng": "-93.2781287",\ "google_place_id": "ChIJUwlN-scn9ocRtDZXalhHYw4",\ "is_draft": false,\ "lonlat": "POINT (-93.2781287 44.9254287)",\ "description": "The Lowbrow, Nicollet Avenue, Minneapolis, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "King Field",\ "manual_location": null\ },\ "drop_off_address": {\ "id": 1,\ "name": "Dispatch",\ "street": "1401 W 94th St",\ "city": "Bloomington",\ "state": "MN",\ "postal_code": "55431",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:46:33.443Z",\ "updated_at": "2023-07-03T15:46:33.443Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.83247",\ "geo_lng": "-93.29798799999999",\ "google_place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o",\ "is_draft": false,\ "lonlat": "POINT (-93.29798799999999 44.83247)",\ "description": "Dispatch, West 94th Street, Bloomington, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "West Bloomington",\ "manual_location": null\ },\ "pickup_duration_in_minutes": 5,\ "drop_off_duration_in_minutes": null,\ "organization_id": "1",\ "connect_organization_id": "1",\ "shareable_link": "https://app.dispatchit.com/connect/delivery/9145306b-b1f4-48ad-818a-8a36bf0dc350",\ "will_call": false\ },\ {\ "id": "4",\ "job_name": "1234",\ "delivery_size": 4,\ "status": "unassigned",\ "pickup_contact": "Connect",\ "pickup_phone_number": "555-111-0000",\ "pickup_notes": "Pickup Notes",\ "drop_off_contact": "Alpha Dropoff Contact @ Somewhere",\ "drop_off_phone_number": "555-111-0000",\ "drop_off_notes": "Drop-Off Notes",\ "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com",\ "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555",\ "pickup_window_start_at": "2023-07-03T12:00:00.000Z",\ "pickup_window_end_at": "2023-07-03T16:00:00.000Z",\ "drop_off_window_start_at": "2023-07-03T22:00:00.000Z",\ "drop_off_window_end_at": "2023-07-04T01:00:00.000Z",\ "pickup_address": {\ "id": 5,\ "name": "Stella's Fish Café & Prestige Oyster Bar",\ "street": "1400 W Lake St",\ "city": "Minneapolis",\ "state": "MN",\ "postal_code": "55408",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:51:11.459Z",\ "updated_at": "2023-07-03T15:51:11.459Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.948645",\ "geo_lng": "-93.29729999999999",\ "google_place_id": "ChIJmwWYkoEn9ocRRN4pdA7cUwo",\ "is_draft": false,\ "lonlat": "POINT (-93.29729999999999 44.948645)",\ "description": "Stella's Fish Café & Prestige Oyster Bar, West Lake Street, Minneapolis, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "Lowry Hill East",\ "manual_location": null\ },\ "drop_off_address": {\ "id": 8,\ "name": "Pho 79",\ "street": "2529 Nicollet Ave",\ "city": "Minneapolis",\ "state": "MN",\ "postal_code": "55404",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:51:11.487Z",\ "updated_at": "2023-07-03T15:51:11.487Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.9562889",\ "geo_lng": "-93.2776083",\ "google_place_id": "ChIJse3VlbUys1IRy3MSgozQXuo",\ "is_draft": false,\ "lonlat": "POINT (-93.2776083 44.9562889)",\ "description": "Pho 79, Nicollet Avenue, Minneapolis, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "Powderhorn",\ "manual_location": null\ },\ "pickup_duration_in_minutes": 5,\ "drop_off_duration_in_minutes": null,\ "organization_id": "1",\ "connect_organization_id": "1",\ "shareable_link": "https://app.dispatchit.com/connect/delivery/78041e74-8be4-49bf-b247-06b80a517dbe",\ "will_call": false\ },\ {\ "id": "5",\ "job_name": "1234",\ "delivery_size": 2,\ "status": "unassigned",\ "pickup_contact": "Connect",\ "pickup_phone_number": "555-111-0000",\ "pickup_notes": "Pickup Notes",\ "drop_off_contact": "Alpha Dropoff Contact @ Somewhere",\ "drop_off_phone_number": "555-111-0000",\ "drop_off_notes": "Drop-Off Notes",\ "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com",\ "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555",\ "pickup_window_start_at": "2023-07-03T14:00:00.000Z",\ "pickup_window_end_at": "2023-07-03T16:00:00.000Z",\ "drop_off_window_start_at": "2023-07-04T00:00:00.000Z",\ "drop_off_window_end_at": "2023-07-04T01:00:00.000Z",\ "pickup_address": {\ "id": 6,\ "name": "French Meadow Cafe & Bluestem Bar",\ "street": "2610 Lyndale Ave S",\ "city": "Minneapolis",\ "state": "MN",\ "postal_code": "55408",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:51:11.469Z",\ "updated_at": "2023-07-03T15:51:11.469Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.95499",\ "geo_lng": "-93.288477",\ "google_place_id": "ChIJwQzEd80ys1IRMqr4uqdRbUM",\ "is_draft": false,\ "lonlat": "POINT (-93.288477 44.95499)",\ "description": "French Meadow Cafe & Bluestem Bar, Lyndale Avenue South, Minneapolis, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "Lowry Hill East",\ "manual_location": null\ },\ "drop_off_address": {\ "id": 1,\ "name": "Dispatch",\ "street": "1401 W 94th St",\ "city": "Bloomington",\ "state": "MN",\ "postal_code": "55431",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:46:33.443Z",\ "updated_at": "2023-07-03T15:46:33.443Z",\ "phone_number": "555-555-5555",\ "active_in_system": true,\ "geo_lat": "44.83247",\ "geo_lng": "-93.29798799999999",\ "google_place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o",\ "is_draft": false,\ "lonlat": "POINT (-93.29798799999999 44.83247)",\ "description": "Dispatch, West 94th Street, Bloomington, MN, USA",\ "default_notes": "Come to back door",\ "saved_location_label": null,\ "neighborhood": "West Bloomington",\ "manual_location": null\ },\ "pickup_duration_in_minutes": 5,\ "drop_off_duration_in_minutes": null,\ "organization_id": "1",\ "connect_organization_id": "1",\ "shareable_link": "https://app.dispatchit.com/connect/delivery/080ade6d-00a5-462d-86e7-46da9e4dde5c",\ "will_call": false\ }\ ] ``` JSONCopy JSONCopy Deliveries for a specific date ### Create a Delivery ​Copy link Auth Required Body application/json - delivery\_sizeCopy link to delivery\_size Type: number required Example 2 The amount of units the delivery contains. Used to measure how full a vehicle is. - drop\_off\_addressCopy link to drop\_off\_address Type: object required Show Child Attributesfor drop\_off\_address - drop\_off\_window\_end\_atCopy link to drop\_off\_window\_end\_at Type: string required Example 2021-01-22T17:30:00-06:00 The latest time the delivery should be dropped off by, formatted as datetime ISO 8601. NOTE: If no time windows are provided, will use organization default. - drop\_off\_window\_start\_atCopy link to drop\_off\_window\_start\_at Type: string required Example 2021-01-22T17:00:00-06:00 The earliest time the delivery should be dropped off by, formatted as datetime ISO 8601. NOTE: If no time windows are provided, will use organization default. - job\_nameCopy link to job\_name Type: string required Example Api job The unique job name or reference ID for any given delivery. - pickup\_addressCopy link to pickup\_address Type: object required Show Child Attributesfor pickup\_address - pickup\_window\_end\_atCopy link to pickup\_window\_end\_at Type: string required Example 2021-01-23T13:30:00-06:00 The latest time the delivery can be picked up, formatted as datetime ISO 8601. NOTE: If no time windows are provided, will use organization default. - pickup\_window\_start\_atCopy link to pickup\_window\_start\_at Type: string required Example 2021-01-23T13:00:00-06:00 The earliest time the delivery can be picked up, formatted as datetime ISO 8601. NOTE: If no time windows are provided, will use organization default. - drop\_off\_contactCopy link to drop\_off\_contact Type: string Example Bob Iger Name of the contact at the drop off location that is expecting the delivery. - drop\_off\_customer\_nameCopy link to drop\_off\_customer\_name Type: string Example Acme Corp Name of the organization at the drop off location that is expecting the delivery. - drop\_off\_duration\_in\_minutesCopy link to drop\_off\_duration\_in\_minutes Type: number Example 15 Amount of time allocated for the driver to spend at the drop-off location. If not provided, will use organization default. - drop\_off\_emailCopy link to drop\_off\_email Type: string Example bob@example.com Email for the drop off contact to enable easy communication if there are issues at drop off. Show additional properties for Request Body Responses - 201 created application/json - 400 missing required fields applciation/json Request Example for post/connect/deliveries Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/deliveries \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "organization_id": "24", "job_name": "Api job", "will_call": false, "delivery_size": "2", "pickup_window_start_at": "2021-01-23T13:00:00-06:00", "pickup_window_end_at": "2021-01-23T13:30:00-06:00", "drop_off_window_start_at": "2021-01-22T17:00:00-06:00", "drop_off_window_end_at": "2021-01-22T17:30:00-06:00", "pickup_customer_name": "Acme Corp", "pickup_contact": "Bob Hope", "pickup_notifications": "email", "pickup_phone_number": "333-111-2222", "pickup_email": "bob@example.com", "pickup_notes": "The pickup door is heavy", "drop_off_customer_name": "Acme Corp", "drop_off_contact": "Bob Iger", "drop_off_notifications": "sms", "drop_off_phone_number": "592-242-5235", "drop_off_email": "bob@example.com", "drop_off_notes": "The drop off is in the locker", "pickup_duration_in_minutes": 15, "drop_off_duration_in_minutes": 15, "email_contacts": "emma@example.com", "sms_contacts": "321-321-2222,321-321-4444", "pickup_address": { "street": "1401 W 94th Street", "city": "Bloomington", "state": "MN", "postal_code": "55431", "geo_lat": "44.8324699", "geo_lng": "-93.2979876", "google_place_id": "ChIJDarrczIu9ocR8xqI5UMILkE" }, "drop_off_address": { "street": "1401 W 94th Street", "city": "Bloomington", "state": "MN", "postal_code": "55431", "geo_lat": "44.8324699", "geo_lng": "-93.2979876", "google_place_id": "ChIJDarrczIu9ocR8xqI5UMILkE" } }' ``` cURLCopy cURLCopy Test Request(post /connect/deliveries) Status: 201Status: 400 ```json { "id": "27", "job_name": "API-Test", "delivery_size": 5, "status": "unassigned", "pickup_contact": "Bob Pickup", "pickup_phone_number": "333-222-1111", "pickup_notes": "The pickup door is heavy", "drop_off_contact": "Alice Drop-Off", "drop_off_phone_number": "555-444-3333", "drop_off_notes": "The drop-off is in locker 42", "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com", "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555", "pickup_window_start_at": "2023-07-13T20:25:29.000Z", "pickup_window_end_at": "2023-07-13T20:55:29.000Z", "drop_off_window_start_at": "2023-07-13T21:25:29.000Z", "drop_off_window_end_at": "2023-07-13T22:25:29.000Z", "pickup_address": { "id": 89, "name": "Sunny Supermarket", "street": "2800 E 2nd Ave", "city": "Denver", "state": "CO", "postal_code": "80206", "country": "US", "iso_country_code": "US", "created_at": "2023-07-13T20:25:32.144Z", "updated_at": "2023-07-13T20:25:32.144Z", "phone_number": "333-222-1111", "active_in_system": true, "geo_lat": "39.71925239999999", "geo_lng": "-104.9542084", "google_place_id": "ChIJdWW18ZZ-bIcRZYqPHLhYAsw", "is_draft": false, "lonlat": "POINT (-104.9542084 39.71925239999999)", "description": "2800 E 2nd Ave, Denver, CO 80206, USA", "default_notes": "Come to back door", "saved_location_label": null, "neighborhood": "Cherry Creek", "manual_location": null }, "drop_off_address": { "id": 90, "name": "Sunny Supermarket", "street": "1744 E Evans Ave", "city": "Denver", "state": "CO", "postal_code": "80210", "country": "US", "iso_country_code": "US", "created_at": "2023-07-13T20:25:32.168Z", "updated_at": "2023-07-13T20:25:32.168Z", "phone_number": "555-444-3333", "active_in_system": true, "geo_lat": "39.6782574", "geo_lng": "-104.9667679", "google_place_id": "ChIJ_fRnIj9-bIcR7yLw7CN5jK8", "is_draft": false, "lonlat": "POINT (-104.9667679 39.6782574)", "description": "1744 E Evans Ave, Denver, CO 80210, USA", "default_notes": "Come to back door", "saved_location_label": null, "neighborhood": "University", "manual_location": null }, "pickup_duration_in_minutes": 15, "drop_off_duration_in_minutes": 15, "organization_id": "1", "connect_organization_id": "1", "shareable_link": "https://app.dispatchit.com/connect/delivery/21dff6dd-5b4a-477a-86dc-4980ab5ff348", "will_call": false } ``` JSONCopy JSONCopy created ### Retrieve a Delivery ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 404 delivery not found application/json Request Example for get/connect/deliveries/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/connect/deliveries/{id}' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/deliveries/{id}) Status: 200Status: 404 ```json { "id": "31", "job_name": "API-Test", "delivery_size": 5, "status": "scheduled", "pickup_contact": "Bob Pickup", "pickup_phone_number": "333-222-1111", "pickup_notes": "The pickup door is heavy", "drop_off_contact": "Frank Drop-Off", "drop_off_phone_number": "555-444-3333", "drop_off_notes": "The drop-off is in locker 42", "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com", "sms_contacts": "111-111-1111, 222-222-2222 333-333-3333", "pickup_window_start_at": "2023-07-13T20:33:50.000Z", "pickup_window_end_at": "2023-07-13T21:03:50.000Z", "drop_off_window_start_at": "2023-07-13T21:33:50.000Z", "drop_off_window_end_at": "2023-07-13T22:33:50.000Z", "pickup_address": { "id": 96, "name": "Target", "street": "2800 E 2nd Ave", "city": "Denver", "state": "CO", "postal_code": "80206", "country": "US", "iso_country_code": "US", "created_at": "2023-07-13T20:33:51.204Z", "updated_at": "2023-07-13T20:33:51.204Z", "phone_number": "333-222-1111", "active_in_system": true, "geo_lat": "39.71925239999999", "geo_lng": "-104.9542084", "google_place_id": "ChIJdWW18ZZ-bIcRZYqPHLhYAsw", "is_draft": false, "lonlat": "POINT (-104.9542084 39.71925239999999)", "description": "2800 E 2nd Ave, Denver, CO 80206, USA", "default_notes": "SOme notes", "saved_location_label": null, "neighborhood": "Cherry Creek", "manual_location": null }, "drop_off_address": { "id": 97, "name": "Walmart", "street": "1744 E Evans Ave", "city": "Denver", "state": "CO", "postal_code": "80210", "country": "US", "iso_country_code": "US", "created_at": "2023-07-13T20:33:51.212Z", "updated_at": "2023-07-13T20:33:51.212Z", "phone_number": "555-444-3333", "active_in_system": true, "geo_lat": "39.6782574", "geo_lng": "-104.9667679", "google_place_id": "ChIJ_fRnIj9-bIcR7yLw7CN5jK8", "is_draft": false, "lonlat": "POINT (-104.9667679 39.6782574)", "description": "1744 E Evans Ave, Denver, CO 80210, USA", "default_notes": "Some notes", "saved_location_label": null, "neighborhood": "University", "manual_location": null }, "pickup_duration_in_minutes": 15, "drop_off_duration_in_minutes": 15, "organization_id": "1", "connect_organization_id": "1", "shareable_link": "https://app.dispatchit.com/connect/delivery/03812b67-41cf-44e7-ad65-883c647b85e8", "will_call": false } ``` JSONCopy JSONCopy success ### Update a Delivery ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Body application/json - delivery\_sizeCopy link to delivery\_size Type: number Example 2 The amount of units the delivery contains. Used to measure how full a vehicle is. - drop\_off\_addressCopy link to drop\_off\_address Type: object Show Child Attributesfor drop\_off\_address - drop\_off\_contactCopy link to drop\_off\_contact Type: string Example Bob Iger Name of the contact at the drop off location that is expecting the delivery. - drop\_off\_duration\_in\_minutesCopy link to drop\_off\_duration\_in\_minutes Type: number Example 15 Amount of time allocated for the driver to spend at the drop-off location. If not provided, will use organization default. - drop\_off\_notesCopy link to drop\_off\_notes Type: string Example The drop off is in the locker Notes pertaining to the drop off location to enabled the driver to have an easy drop off experience. - drop\_off\_phone\_numberCopy link to drop\_off\_phone\_number Type: string Example 592-242-5235 Phone number for the drop off contact to enable easy communication if there are issues at drop off. - drop\_off\_window\_end\_atCopy link to drop\_off\_window\_end\_at Type: string Example 2021-01-22T17:30:00-06:00 The latest time the delivery should be dropped off by, formatted as datetime ISO 8601. - drop\_off\_window\_start\_atCopy link to drop\_off\_window\_start\_at Type: string Example 2021-01-22T17:00:00-06:00 The earliest time the delivery should be dropped off by, formatted as datetime ISO 8601. - email\_contactsCopy link to email\_contacts Type: string Example emma@example.com Comma separated list of email addresses that will receive notifications for the delivery as the status updates - job\_nameCopy link to job\_name Type: string Example Api job The unique job name or reference ID for any given delivery. - pickup\_addressCopy link to pickup\_address Type: object Show Child Attributesfor pickup\_address - pickup\_contactCopy link to pickup\_contact Type: string Example Bob Hope Name of the contact at the pickup location responsible for delivery management. Show additional properties for Request Body Responses - 200 success application/json - 404 delivery not found application/json - 422 unprocessable entity application/json Request Example for put/connect/deliveries/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/connect/deliveries/{id}' \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "job_name": "Api job", "delivery_size": "2", "pickup_window_start_at": "2021-01-23T13:00:00-06:00", "pickup_window_end_at": "2021-01-23T13:30:00-06:00", "drop_off_window_start_at": "2021-01-22T17:00:00-06:00", "drop_off_window_end_at": "2021-01-22T17:30:00-06:00", "pickup_contact": "Bob Hope", "pickup_phone_number": "333-111-2222", "pickup_notes": "The pickup door is heavy", "drop_off_contact": "Bob Iger", "drop_off_phone_number": "592-242-5235", "drop_off_notes": "The drop off is in the locker", "pickup_duration_in_minutes": 15, "drop_off_duration_in_minutes": 15, "email_contacts": "emma@example.com", "sms_contacts": "321-321-2222,321-321-4444", "pickup_address": { "street": "1401 W 94th Street", "city": "Bloomington", "state": "MN", "postal_code": "55431", "geo_lat": "44.8324699", "geo_lng": "-93.2979876", "google_place_id": "ChIJDarrczIu9ocR8xqI5UMILkE" }, "drop_off_address": { "street": "1401 W 94th Street", "city": "Bloomington", "state": "MN", "postal_code": "55431", "geo_lat": "44.8324699", "geo_lng": "-93.2979876", "google_place_id": "ChIJDarrczIu9ocR8xqI5UMILkE" } }' ``` cURLCopy cURLCopy Test Request(put /connect/deliveries/{id}) Status: 200Status: 404Status: 422 ```json { "id": "31", "job_name": "API-Test", "delivery_size": 5, "status": "unassigned", "pickup_contact": "Bob Pickup", "pickup_phone_number": "333-222-1111", "pickup_notes": "The pickup door is heavy", "drop_off_contact": "Frank Drop-Off", "drop_off_phone_number": "555-444-3333", "drop_off_notes": "The drop-off is in locker 42", "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com", "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555", "pickup_window_start_at": "2023-07-13T20:33:50.000Z", "pickup_window_end_at": "2023-07-13T21:03:50.000Z", "drop_off_window_start_at": "2023-07-13T21:33:50.000Z", "drop_off_window_end_at": "2023-07-13T22:33:50.000Z", "pickup_address": { "id": 96, "name": "Sunny Supermarket", "street": "2800 E 2nd Ave", "city": "Denver", "state": "CO", "postal_code": "80206", "country": "US", "iso_country_code": "US", "created_at": "2023-07-13T20:33:51.204Z", "updated_at": "2023-07-13T20:33:51.204Z", "phone_number": "333-222-1111", "active_in_system": true, "geo_lat": "39.71925239999999", "geo_lng": "-104.9542084", "google_place_id": "ChIJdWW18ZZ-bIcRZYqPHLhYAsw", "is_draft": false, "lonlat": "POINT (-104.9542084 39.71925239999999)", "description": "2800 E 2nd Ave, Denver, CO 80206, USA", "default_notes": "Come to back door", "saved_location_label": null, "neighborhood": "Cherry Creek", "manual_location": null }, "drop_off_address": { "id": 97, "name": "Sunny Supermarket", "street": "1744 E Evans Ave", "city": "Denver", "state": "CO", "postal_code": "80210", "country": "US", "iso_country_code": "US", "created_at": "2023-07-13T20:33:51.212Z", "updated_at": "2023-07-13T20:33:51.212Z", "phone_number": "555-444-3333", "active_in_system": true, "geo_lat": "39.6782574", "geo_lng": "-104.9667679", "google_place_id": "ChIJ_fRnIj9-bIcR7yLw7CN5jK8", "is_draft": false, "lonlat": "POINT (-104.9667679 39.6782574)", "description": "1744 E Evans Ave, Denver, CO 80210, USA", "default_notes": "Come to back door", "saved_location_label": null, "neighborhood": "University", "manual_location": null }, "pickup_duration_in_minutes": 15, "drop_off_duration_in_minutes": 15, "organization_id": "1", "connect_organization_id": "1", "shareable_link": "https://app.dispatchit.com/connect/delivery/03812b67-41cf-44e7-ad65-883c647b85e8", "will_call": false } ``` JSONCopy JSONCopy success ### Cancel a Delivery ​Copy link Auth Required Note: Given the delivery is the last incomplete delivery on a manifest then the manifest will be completed Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 404 delivery not found application/json - 422 unprocessable entity Request Example for put/connect/cancel\_delivery/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/connect/cancel_delivery/{id}' \ --request PUT \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(put /connect/cancel\_delivery/{id}) Status: 200Status: 404Status: 422 ```json { "id": "5", "job_name": "1234", "delivery_size": 2, "status": "unassigned", "pickup_contact": "Connect", "pickup_phone_number": "555-111-0000", "pickup_notes": "Pickup Notes", "drop_off_contact": "Alpha Dropoff Contact @ Somewhere", "drop_off_phone_number": "555-111-0000", "drop_off_notes": "Drop-Off Notes", "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com", "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555", "pickup_window_start_at": "2023-07-03T14:00:00.000Z", "pickup_window_end_at": "2023-07-03T16:00:00.000Z", "drop_off_window_start_at": "2023-07-04T00:00:00.000Z", "drop_off_window_end_at": "2023-07-04T01:00:00.000Z", "pickup_address": { "id": 6, "name": "French Meadow Cafe & Bluestem Bar", "street": "2610 Lyndale Ave S", "city": "Minneapolis", "state": "MN", "postal_code": "55408", "country": "US", "iso_country_code": "US", "created_at": "2023-07-03T15:51:11.469Z", "updated_at": "2023-07-03T15:51:11.469Z", "phone_number": "555-555-5555", "active_in_system": true, "geo_lat": "44.95499", "geo_lng": "-93.288477", "google_place_id": "ChIJwQzEd80ys1IRMqr4uqdRbUM", "is_draft": false, "lonlat": "POINT (-93.288477 44.95499)", "description": "French Meadow Cafe & Bluestem Bar, Lyndale Avenue South, Minneapolis, MN, USA", "default_notes": "Come to back door", "saved_location_label": null, "neighborhood": "Lowry Hill East", "manual_location": null }, "drop_off_address": { "id": 1, "name": "Dispatch", "street": "1401 W 94th St", "city": "Bloomington", "state": "MN", "postal_code": "55431", "country": "US", "iso_country_code": "US", "created_at": "2023-07-03T15:46:33.443Z", "updated_at": "2023-07-03T15:46:33.443Z", "phone_number": "555-555-5555", "active_in_system": true, "geo_lat": "44.83247", "geo_lng": "-93.29798799999999", "google_place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o", "is_draft": false, "lonlat": "POINT (-93.29798799999999 44.83247)", "description": "Dispatch, West 94th Street, Bloomington, MN, USA", "default_notes": "Come to back door", "saved_location_label": null, "neighborhood": "West Bloomington", "manual_location": null }, "pickup_duration_in_minutes": 5, "drop_off_duration_in_minutes": null, "organization_id": "1", "connect_organization_id": "1", "shareable_link": "https://app.dispatchit.com/connect/delivery/080ade6d-00a5-462d-86e7-46da9e4dde5c", "will_call": false } ``` JSONCopy JSONCopy success ### Assign a Delivery to a Vehicle ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Body application/json - vehicle\_idCopy link to vehicle\_id Type: number required Example 12 ID of the vehicle you want to assign the delivery to. Responses - 200 success application/json - 404 not found - 409 conflict - 422 unprocessable entity Request Example for put/connect/deliveries/ _{id}_/assign\_delivery\_to\_vehicle Shell Curl ```curl curl 'https://api.dispatchit.com/v1/connect/deliveries/{id}/assign_delivery_to_vehicle' \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "vehicle_id": 12 }' ``` cURLCopy cURLCopy Test Request(put /connect/deliveries/{id}/assign\_delivery\_to\_vehicle) Status: 200Status: 404Status: 409Status: 422 ```json { "id": "31", "job_name": "API-Test", "delivery_size": 5, "status": "assigned", "pickup_contact": "Bob Pickup", "pickup_phone_number": "333-222-1111", "pickup_notes": "The pickup door is heavy", "drop_off_contact": "Frank Drop-Off", "drop_off_phone_number": "555-444-3333", "drop_off_notes": "The drop-off is in locker 42", "email_contacts": "aaa@example.com, bbb@example.com ccc@example.com", "sms_contacts": "333-333-3333, 444-444-4444 555-555-5555", "pickup_window_start_at": "2023-07-13T20:33:50.000Z", "pickup_window_end_at": "2023-07-13T21:03:50.000Z", "drop_off_window_start_at": "2023-07-13T21:33:50.000Z", "drop_off_window_end_at": "2023-07-13T22:33:50.000Z", "pickup_address": { "id": 96, "name": "Sunny Supermarket", "street": "2800 E 2nd Ave", "city": "Denver", "state": "CO", "postal_code": "80206", "country": "US", "iso_country_code": "US", "created_at": "2023-07-13T20:33:51.204Z", "updated_at": "2023-07-13T20:33:51.204Z", "phone_number": "333-222-1111", "active_in_system": true, "geo_lat": "39.71925239999999", "geo_lng": "-104.9542084", "google_place_id": "ChIJdWW18ZZ-bIcRZYqPHLhYAsw", "is_draft": false, "lonlat": "POINT (-104.9542084 39.71925239999999)", "description": "2800 E 2nd Ave, Denver, CO 80206, USA", "default_notes": "Come to back door", "saved_location_label": null, "neighborhood": "Cherry Creek", "manual_location": null }, "drop_off_address": { "id": 97, "name": "Sunny Supermarket", "street": "1744 E Evans Ave", "city": "Denver", "state": "CO", "postal_code": "80210", "country": "US", "iso_country_code": "US", "created_at": "2023-07-13T20:33:51.212Z", "updated_at": "2023-07-13T20:33:51.212Z", "phone_number": "555-444-3333", "active_in_system": true, "geo_lat": "39.6782574", "geo_lng": "-104.9667679", "google_place_id": "ChIJ_fRnIj9-bIcR7yLw7CN5jK8", "is_draft": false, "lonlat": "POINT (-104.9667679 39.6782574)", "description": "1744 E Evans Ave, Denver, CO 80210, USA", "default_notes": "Come to back door", "saved_location_label": null, "neighborhood": "University", "manual_location": null }, "pickup_duration_in_minutes": 15, "drop_off_duration_in_minutes": 15, "organization_id": "1", "connect_organization_id": "1", "shareable_link": "https://app.dispatchit.com/connect/delivery/03812b67-41cf-44e7-ad65-883c647b85e8", "will_call": false } ``` JSONCopy JSONCopy success ### Get Organization Details ​Copy link Auth Required Responses - 200 success application/json Request Example for get/connect/organization Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/organization \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/organization) Status: 200 ```json { "id": "1", "name": "Dispatchit, Inc.", "can_send_to_dispatch": true, "unit_description": "Lorem ipsum dolor sit amet", "archived": false, "vehicle_capacity_unit": "skid", "vehicle_capacity_units": "skids", "vehicle_limit": 20, "trial_ends_in": null, "trial_expired": null, "trial_end_date": null, "service_end_date": null, "pay_now_url": "http://example.com", "working_hours_start_at": "2021-04-05T13:00:00.000Z", "working_hours_end_at": "2021-04-05T23:00:00.000Z", "time_zone": "Central Time (US & Canada)", "duration_at_pickup_in_minutes": 15, "duration_at_drop_off_in_minutes": 15, "trial_agreed": false, "plan_it_status": null, "max_deliveries_per_route": null, "organization_id": "1", "subscription_id": "1", "subscription_tier": "Trial", "subscription_paid_for": false, "subscription_billing_cycle": "annual", "subscription_vehicle_payment_pending": false, "address": { "id": "1", "active_in_system": true, "city": "Bloomington", "country": "US", "created_at": "2023-07-03T15:46:33.443Z", "default_notes": null, "description": "Dispatch, West 94th Street, Bloomington, MN, USA", "geo_lat": "44.83247", "geo_lng": "-93.29798799999999", "google_place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o", "is_draft": false, "iso_country_code": "US", "lonlat": "POINT (-93.29798799999999 44.83247)", "manual_location": null, "name": "Dispatch", "neighborhood": "West Bloomington", "phone_number": null, "postal_code": "55431", "saved_location_label": null, "state": "MN", "street": "1401 W 94th St", "updated_at": "2023-07-03T15:46:33.443Z", "formatted_one_line": "1401 W 94th St, Bloomington, MN 55431, US", "place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o" }, "bypass_billing_enabled": true } ``` JSONCopy JSONCopy success ### List Organization Branches ​Copy link Auth Required Responses - 200 success application/json Request Example for get/connect/organizations/list\_branches Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/organizations/list_branches \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/organizations/list\_branches) Status: 200 ```json [\ {\ "id": "20",\ "organization_id": null,\ "connect_enabled": false,\ "name": "QA API Organization",\ "address": {\ "id": 15,\ "name": "Dispatch",\ "street": "1401 W 94th St",\ "city": "Bloomington",\ "state": "MN",\ "postal_code": "55431",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:53:19.031Z",\ "updated_at": "2023-07-03T15:53:19.031Z",\ "phone_number": null,\ "active_in_system": true,\ "geo_lat": "44.83247",\ "geo_lng": "-93.29798799999999",\ "google_place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o",\ "is_draft": false,\ "lonlat": "POINT (-93.29798799999999 44.83247)",\ "description": "Dispatch, West 94th Street, Bloomington, MN, USA",\ "default_notes": null,\ "saved_location_label": null,\ "neighborhood": "West Bloomington",\ "manual_location": null\ }\ },\ {\ "id": "21",\ "organization_id": null,\ "connect_enabled": false,\ "name": "QA Performance Org",\ "address": {\ "id": 15,\ "name": "Dispatch",\ "street": "1401 W 94th St",\ "city": "Bloomington",\ "state": "MN",\ "postal_code": "55431",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:53:19.031Z",\ "updated_at": "2023-07-03T15:53:19.031Z",\ "phone_number": null,\ "active_in_system": true,\ "geo_lat": "44.83247",\ "geo_lng": "-93.29798799999999",\ "google_place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o",\ "is_draft": false,\ "lonlat": "POINT (-93.29798799999999 44.83247)",\ "description": "Dispatch, West 94th Street, Bloomington, MN, USA",\ "default_notes": null,\ "saved_location_label": null,\ "neighborhood": "West Bloomington",\ "manual_location": null\ }\ },\ {\ "id": "22",\ "organization_id": null,\ "connect_enabled": false,\ "name": "Adjustment Org",\ "address": {\ "id": 15,\ "name": "Dispatch",\ "street": "1401 W 94th St",\ "city": "Bloomington",\ "state": "MN",\ "postal_code": "55431",\ "country": "US",\ "iso_country_code": "US",\ "created_at": "2023-07-03T15:53:19.031Z",\ "updated_at": "2023-07-03T15:53:19.031Z",\ "phone_number": null,\ "active_in_system": true,\ "geo_lat": "44.83247",\ "geo_lng": "-93.29798799999999",\ "google_place_id": "ChIJqb7XmQIl9ocRtTqO2FzeL2o",\ "is_draft": false,\ "lonlat": "POINT (-93.29798799999999 44.83247)",\ "description": "Dispatch, West 94th Street, Bloomington, MN, USA",\ "default_notes": null,\ "saved_location_label": null,\ "neighborhood": "West Bloomington",\ "manual_location": null\ }\ }\ ] ``` JSONCopy JSONCopy success ### Retrieve a Vehicle ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 404 vehicle not found application/json Request Example for get/connect/vehicles/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/connect/vehicles/{id}' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/vehicles/{id}) Status: 200Status: 404 ```json { "id": "5", "color": "#002D9C", "name": "Blue Cargo Van", "vehicle_type": "Cargo Van", "max_units": 20, "notes": "Squeaky brakes", "weight_limit": 3000, "weight_per_axle": 1500, "height": 72, "width": 48, "length": 108, "organization_id": "2", "date": "2023-07-14", "status": "active", "driver_id": 5 } ``` JSONCopy JSONCopy success ### Delete a Vehicle ​Copy link Auth Required All previous data relationships will remain intact, but you will no longer be able to use this vehicle. If you use this in the API it will automatically unassign deliveries and delete vehicle. Path Parameters - idCopy link to id Type: string required Responses - 200 success application/json - 404 not found application/json - 409 conflict Request Example for delete/connect/vehicles/ _{id}_ Shell Curl ```curl curl 'https://api.dispatchit.com/v1/connect/vehicles/{id}' \ --request DELETE \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(delete /connect/vehicles/{id}) Status: 200Status: 404Status: 409 ```json { "id": 7, "name": "API-Vehicle (deleted at 7/20/2023 5:14:36PM UTC)" } ``` JSONCopy JSONCopy success ### Retrieve all Vehicles ​Copy link Auth Required Responses - 200 success application/json Request Example for get/connect/vehicles Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/vehicles \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/vehicles) Status: 200 ```json [\ {\ "id": "1",\ "color": "#5243AA",\ "name": "Alpha Mini Van",\ "vehicle_type": "mini van",\ "max_units": 20,\ "notes": null,\ "weight_limit": 3000,\ "weight_per_axle": 1500,\ "height": 72,\ "width": 48,\ "length": 108,\ "organization_id": "1",\ "date": "2023-07-14",\ "status": "active",\ "driver_id": 3\ },\ {\ "id": "2",\ "color": "#002D9C",\ "name": "Beta Pickup Truck",\ "vehicle_type": "pickup truck",\ "max_units": 10,\ "notes": "Squeaky brakes",\ "weight_limit": 3000,\ "weight_per_axle": 1500,\ "height": 72,\ "width": 48,\ "length": 108,\ "organization_id": "1",\ "date": "2023-07-14",\ "status": "active",\ "driver_id": 1\ },\ {\ "id": "3",\ "color": "#EE5396",\ "name": "Gamma Sedan",\ "vehicle_type": "sedan",\ "max_units": 30,\ "notes": "John's favorite",\ "weight_limit": 3000,\ "weight_per_axle": 1500,\ "height": 72,\ "width": 48,\ "length": 108,\ "organization_id": "1",\ "date": "2023-07-14",\ "status": "active",\ "driver_id": 2\ },\ {\ "id": "4",\ "color": "#009D9A",\ "name": "Delta Coupe",\ "vehicle_type": "coupe",\ "max_units": 40,\ "notes": null,\ "weight_limit": 3000,\ "weight_per_axle": 1500,\ "height": 72,\ "width": 48,\ "length": 108,\ "organization_id": "1",\ "date": "2023-07-14",\ "status": "active",\ "driver_id": 5\ }\ ] ``` JSONCopy JSONCopy success ### Create a Vehicle ​Copy link Auth Required Body application/json - colorCopy link to color Type: string required Example Dark Purple Color for the vehicle. The color selected will designate the route color on the map. Valid colors: Dark Purple, Cyan, Dark Teal, Magenta, Red, Green, Blue, Pink, Light Purple, Light Teal. - max\_unitsCopy link to max\_units Type: integer required Example 24 Max units per vehicle. The number of units that could be hauled in the vehicle. - nameCopy link to name Type: string required Example Mystery Machine Name of the vehicle. Choose a unique name that will identify this vehicle from the fleet. - vehicle\_typeCopy link to vehicle\_type Type: string required Example Cargo Van Type of vehicle. - heightCopy link to height Type: integer Example 120 Height of vehicle in cm (max 5000) - lengthCopy link to length Type: integer Example 240 Length of vehicle in cm (max 30000) - notesCopy link to notes Type: string Example This vehicle has 3 seats Notes you would like attached to the vehicle. - weight\_limitCopy link to weight\_limit Type: integer Example 200 Vehicle max weight in kg - weight\_per\_axleCopy link to weight\_per\_axle Type: integer Example 50 Vehicle weight per axle in kg - widthCopy link to width Type: integer Example 60 Width of vehicle in cm (max 5000) Responses - 201 created application/json - 400 missing required fields application/json Request Example for post/connect/vehicles Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/vehicles \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "color": "Dark Purple", "name": "Mystery Machine", "vehicle_type": "Cargo Van", "max_units": 24, "notes": "This vehicle has 3 seats", "weight_limit": 200, "weight_per_axle": 50, "height": 120, "width": 60, "length": 240 }' ``` cURLCopy cURLCopy Test Request(post /connect/vehicles) Status: 201Status: 400 ```json { "id": "7", "color": "#002D9C", "name": "API-Vehicle", "vehicle_type": "E-350", "max_units": 50, "notes": "squeaky brakes", "weight_limit": 3500, "weight_per_axle": 1750, "height": 84, "width": 79, "length": 236, "organization_id": "1", "date": "2023-07-20", "status": "active", "driver_id": 3 } ``` JSONCopy JSONCopy created ### Send Vehicle Manifest to the assigned Driver ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Body application/json - dateCopy link to date Type: string Example 2022-02-28 Date of the vehicle manifest you want to send to the assigned driver Responses - 200 success application/json - 404 not found application/json - 409 conflict Request Example for put/connect/vehicles/ _{id}_/send\_to\_driver Shell Curl ```curl curl 'https://api.dispatchit.com/v1/connect/vehicles/{id}/send_to_driver' \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "date": "2022-02-28" }' ``` cURLCopy cURLCopy Test Request(put /connect/vehicles/{id}/send\_to\_driver) Status: 200Status: 404Status: 409 ```json { "id": "5", "color": "#002D9C", "name": "Blue Cargo Van", "vehicle_type": "Cargo Van", "max_units": 20, "notes": null, "weight_limit": 3000, "weight_per_axle": 1500, "height": 72, "width": 48, "length": 108, "organization_id": "2", "date": "2022-02-28", "status": "active", "driver_id": null } ``` JSONCopy JSONCopy success ### Assign a driver to a vehicle ​Copy link Auth Required Path Parameters - idCopy link to id Type: string required Body application/json - dateCopy link to date Type: string required Example 2022-02-28 Date you want the driver assigned to this vehicle. - driver\_idCopy link to driver\_id Type: number required Example 12 ID of the driver you want to assign to this vehicle. Responses - 200 success application/json - 400 missing required fields application/json - 409 conflict - 422 unprocessable entity application/json Request Example for put/connect/vehicles/ _{id}_/assign\_driver Shell Curl ```curl curl 'https://api.dispatchit.com/v1/connect/vehicles/{id}/assign_driver' \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "driver_id": 12, "date": "2022-02-28" }' ``` cURLCopy cURLCopy Test Request(put /connect/vehicles/{id}/assign\_driver) Status: 200Status: 400Status: 409Status: 422 ```json { "id": 5, "date": "2022-02-28", "driver_id": 7 } ``` JSONCopy JSONCopy success ### Retrieve Drivers ​Copy link Auth Required Responses - 200 success application/json Request Example for get/connect/drivers Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/drivers \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/drivers) Status: 200 ```json [\ {\ "id": "1",\ "email": "connectdrivertest@example.com",\ "name": "Connect Driver"\ },\ {\ "id": "2",\ "email": "calvinpowell@example1.com",\ "name": "Calvin Powell"\ },\ {\ "id": "3",\ "email": "yasinhunt@example1.com",\ "name": "Yasin Hunt"\ },\ {\ "id": "4",\ "email": "rhysemmanuel@example1.com",\ "name": "Rhys Emmanuel"\ },\ {\ "id": "6",\ "email": "calvinpowell@example.com",\ "name": "Calvin Powell"\ },\ {\ "id": "7",\ "email": "yasinhunt@example.com",\ "name": "Yasin Hunt"\ },\ {\ "id": "8",\ "email": "rhysemmanuel@example.com",\ "name": "Rhys Emmanuel"\ },\ {\ "id": "10",\ "email": "connectmobileuser@example.com",\ "name": "Mobile AutomationUser"\ }\ ] ``` JSONCopy JSONCopy success ### Retrieve All Manifests for a Date ​Copy link Auth Required If not passed a "date" query parameter (format YYYYMMDD), defaults to today Query Parameters - dateCopy link to date Type: string Example 20200101 Responses - 200 Manifests for a specific date application/json Request Example for get/connect/manifests Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/manifests \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/manifests) Status: 200 ```json [\ {\ "id": "4",\ "status": "complete",\ "route_updated_at": "2023-07-14T17:32:13.190Z",\ "name": "Example Manifest",\ "optimization_status": "eligible",\ "active_on": "2023-07-14",\ "created_at": "2023-07-14T17:31:54.027Z",\ "updated_at": "2023-07-14T17:35:54.027Z",\ "sent_to_driver_at": "2023-07-14T17:34:13.190Z",\ "saved_manifest_id": "2023-07-14T17:32:13.190Z",\ "vehicle_id": "5",\ "current_capacity": 0\ },\ {\ "id": "5",\ "status": "scheduled",\ "route_updated_at": "2023-07-14T17:32:13.190Z",\ "name": "Another Manifest",\ "optimization_status": "confirmed",\ "active_on": "2023-07-14",\ "created_at": "2023-07-14T17:32:13.190Z",\ "updated_at": "2023-07-14T17:35:13.190Z",\ "sent_to_driver_at": "2023-07-14T17:34:13.190Z",\ "saved_manifest_id": "2023-07-14T17:32:13.190Z",\ "vehicle_id": "4",\ "current_capacity": 0\ }\ ] ``` JSONCopy JSONCopy Manifests for a specific date ### Retrieve all Users ​Copy link Auth Required Query Parameters - show\_deactivated\_usersCopy link to show\_deactivated\_users Type: boolean Optionally retrieve deactivated users - pageCopy link to page Type: integer Optionally paginate and retrieve the specified page of users - perCopy link to per Type: integer Optionally specify how many users to retrieve per page. Default is 25 Responses - 200 success application/json Request Example for get/connect/users Shell Curl ```curl curl https://api.dispatchit.com/v1/connect/users \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` cURLCopy cURLCopy Test Request(get /connect/users) Status: 200 ```json { "records": [\ {\ "id": "43",\ "email": "calvinpowell@example.com",\ "given_name": "Calvin",\ "family_name": "Powell",\ "phone_number": "483-540-9903",\ "last_sign_in_at": "2023-05-12T17:32:13.190Z",\ "profile_image": {\ "url": "/assets/placeholders/user_placeholder-f6a38f09264113cc78e5b4ce5d6626f298768e67687a255c58df3338b41a39a8.png",\ "medium_2x": {\ "url": "/assets/placeholders/medium_2x_user_placeholder-0c807ec6fcb3ca2a063f6c2386abb3a16147c14035d04e6fcd1136085bf1868c.png"\ },\ "small_3x": {\ "url": "/assets/placeholders/small_3x_user_placeholder-b10d0890305edbe464a893c11c6da995d5595844ab8907e7cac255fe50061f06.png"\ },\ "small_2x": {\ "url": "/assets/placeholders/small_2x_user_placeholder-af8d452fa882854f890dd011c7f59c4a419f1519709fe5b9ffb0e7b1134bff93.png"\ }\ },\ "connect_roles": [\ "connect_driver"\ ],\ "name": "Calvin Powell",\ "deactivated_at": "2023-07-14T17:32:13.190Z",\ "timezone": "Central Time (US & Canada)",\ "profile_image_is_placeholder": true,\ "organization_id": "1",\ "terms=": [\ {\ "path": "/privacy_policy",\ "label": "Dispatch Privacy Policy"\ }\ ]\ },\ {\ "id": "15",\ "email": "connectdrivertest@example.com",\ "given_name": "Connect",\ "family_name": "Driver",\ "phone_number": "555-555-5555",\ "last_sign_in_at": "2023-05-12T17:32:13.190Z",\ "profile_image": {\ "url": "/assets/placeholders/user_placeholder-f6a38f09264113cc78e5b4ce5d6626f298768e67687a255c58df3338b41a39a8.png",\ "medium_2x": {\ "url": "/assets/placeholders/medium_2x_user_placeholder-0c807ec6fcb3ca2a063f6c2386abb3a16147c14035d04e6fcd1136085bf1868c.png"\ },\ "small_3x": {\ "url": "/assets/placeholders/small_3x_user_placeholder-b10d0890305edbe464a893c11c6da995d5595844ab8907e7cac255fe50061f06.png"\ },\ "small_2x": {\ "url": "/assets/placeholders/small_2x_user_placeholder-af8d452fa882854f890dd011c7f59c4a419f1519709fe5b9ffb0e7b1134bff93.png"\ }\ },\ "connect_roles": [\ "connect_driver"\ ],\ "name": "Connect Driver",\ "deactivated_at": "",\ "timezone": "Central Time (US & Canada)",\ "profile_image_is_placeholder": true,\ "organization_id": "1",\ "terms=": [\ {\ "path": "/privacy_policy",\ "label": "Dispatch Privacy Policy"\ }\ ]\ },\ {\ "id": "47",\ "email": "connectmobileuser@example.com",\ "given_name": "Mobile",\ "family_name": "AutomationUser",\ "phone_number": "605-931-7964",\ "last_sign_in_at": "2023-05-12T17:32:13.190Z",\ "profile_image": {\ "url": "/assets/placeholders/user_placeholder-f6a38f09264113cc78e5b4ce5d6626f298768e67687a255c58df3338b41a39a8.png",\ "medium_2x": {\ "url": "/assets/placeholders/medium_2x_user_placeholder-0c807ec6fcb3ca2a063f6c2386abb3a16147c14035d04e6fcd1136085bf1868c.png"\ },\ "small_3x": {\ "url": "/assets/placeholders/small_3x_user_placeholder-b10d0890305edbe464a893c11c6da995d5595844ab8907e7cac255fe50061f06.png"\ },\ "small_2x": {\ "url": "/assets/placeholders/small_2x_user_placeholder-af8d452fa882854f890dd011c7f59c4a419f1519709fe5b9ffb0e7b1134bff93.png"\ }\ },\ "connect_roles": [\ "connect_driver"\ ],\ "name": "Mobile AutomationUser",\ "deactivated_at": null,\ "timezone": "Central Time (US & Canada)",\ "profile_image_is_placeholder": true,\ "organization_id": "1",\ "terms=": [\ {\ "path": "/privacy_policy",\ "label": "Dispatch Privacy Policy"\ }\ ]\ },\ {\ "id": "45",\ "email": "rhysemmanuel@example.com",\ "given_name": "Rhys",\ "family_name": "Emmanuel",\ "phone_number": "216-393-6599",\ "last_sign_in_at": "2023-05-12T17:32:13.190Z",\ "profile_image": {\ "url": "/assets/placeholders/user_placeholder-f6a38f09264113cc78e5b4ce5d6626f298768e67687a255c58df3338b41a39a8.png",\ "medium_2x": {\ "url": "/assets/placeholders/medium_2x_user_placeholder-0c807ec6fcb3ca2a063f6c2386abb3a16147c14035d04e6fcd1136085bf1868c.png"\ },\ "small_3x": {\ "url": "/assets/placeholders/small_3x_user_placeholder-b10d0890305edbe464a893c11c6da995d5595844ab8907e7cac255fe50061f06.png"\ },\ "small_2x": {\ "url": "/assets/placeholders/small_2x_user_placeholder-af8d452fa882854f890dd011c7f59c4a419f1519709fe5b9ffb0e7b1134bff93.png"\ }\ },\ "connect_roles": [\ "connect_driver"\ ],\ "name": "Rhys Emmanuel",\ "deactivated_at": null,\ "timezone": "Central Time (US & Canada)",\ "profile_image_is_placeholder": true,\ "organization_id": "1",\ "terms=": [\ {\ "path": "/privacy_policy",\ "label": "Dispatch Privacy Policy"\ }\ ]\ },\ {\ "id": "24",\ "email": "testuser@example.com",\ "given_name": "Test",\ "family_name": "User",\ "phone_number": "517-714-0294",\ "last_sign_in_at": "2023-05-12T17:32:13.190Z",\ "profile_image": {\ "url": "/assets/placeholders/user_placeholder-f6a38f09264113cc78e5b4ce5d6626f298768e67687a255c58df3338b41a39a8.png",\ "medium_2x": {\ "url": "/assets/placeholders/medium_2x_user_placeholder-0c807ec6fcb3ca2a063f6c2386abb3a16147c14035d04e6fcd1136085bf1868c.png"\ },\ "small_3x": {\ "url": "/assets/placeholders/small_3x_user_placeholder-b10d0890305edbe464a893c11c6da995d5595844ab8907e7cac255fe50061f06.png"\ },\ "small_2x": {\ "url": "/assets/placeholders/small_2x_user_placeholder-af8d452fa882854f890dd011c7f59c4a419f1519709fe5b9ffb0e7b1134bff93.png"\ }\ },\ "connect_roles": [\ "connect_web_admin"\ ],\ "name": "Test User",\ "deactivated_at": null,\ "timezone": "Central Time (US & Canada)",\ "profile_image_is_placeholder": true,\ "organization_id": "1",\ "terms=": [\ {\ "path": "/privacy_policy",\ "label": "Dispatch Privacy Policy"\ }\ ]\ },\ {\ "id": "44",\ "email": "yasinhunt@example.com",\ "given_name": "Yasin",\ "family_name": "Hunt",\ "phone_number": "980-905-9615",\ "last_sign_in_at": null,\ "profile_image": {\ "url": "/assets/placeholders/user_placeholder-f6a38f09264113cc78e5b4ce5d6626f298768e67687a255c58df3338b41a39a8.png",\ "medium_2x": {\ "url": "/assets/placeholders/medium_2x_user_placeholder-0c807ec6fcb3ca2a063f6c2386abb3a16147c14035d04e6fcd1136085bf1868c.png"\ },\ "small_3x": {\ "url": "/assets/placeholders/small_3x_user_placeholder-b10d0890305edbe464a893c11c6da995d5595844ab8907e7cac255fe50061f06.png"\ },\ "small_2x": {\ "url": "/assets/placeholders/small_2x_user_placeholder-af8d452fa882854f890dd011c7f59c4a419f1519709fe5b9ffb0e7b1134bff93.png"\ }\ },\ "connect_roles": [\ "connect_driver"\ ],\ "name": "Yasin Hunt",\ "deactivated_at": null,\ "timezone": "Central Time (US & Canada)",\ "profile_image_is_placeholder": true,\ "organization_id": "1",\ "terms=": [\ {\ "path": "/privacy_policy",\ "label": "Dispatch Privacy Policy"\ }\ ]\ }\ ] } ``` JSONCopy JSONCopy success Show sidebar POST Server: https://api.dispatchit.com/v1 /orders/estimates Copy URL Send Send post request to https://api.dispatchit.com/v1/orders/estimates POST Copy URLSend Send post request to https://api.dispatchit.com/v1/orders/estimates Close Client Create an Estimate AllAuthCookiesHeadersQueryBody All ## AuthenticationRequired Selected Auth Type: oauth2 Authorize ## Variables | Enabled | Key | Value | | --- | --- | --- | ## Cookies | Enabled | Key | Value | | --- | --- | --- | | | | | ## Headers Clear All Headers | Enabled | Key | Value | | --- | --- | --- | | | accept | application/json | | | content-type | application/json | | | | | ## Query Parameters | Enabled | Key | Value | | --- | --- | --- | | | | | ## Request Body Press `Esc` then `Tab` to exit 99 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 { "pickup\_info": { "business\_name": "Dispatch", "location": { "address": { "address\_1": "1401 W 94th Street", "address\_2": "", "city": "Bloomington", "state\_province\_code": "MN", "postal\_code": "55431" } }, "pickup\_date\_time\_utc": "2019-08-09T13:00:00.000Z" }, "drop\_off\_info": { "business\_name": "the Nerdery", "estimated\_weight": 1, "location": { "address": { "address\_1": "9555 James Ave S", "address\_2": "", "city": "Bloomington", "state\_province\_code": "MN", "postal\_code": "55431" } }, "drop\_off\_date\_time\_utc": "2019-08-09T16:00:00.000Z" }, "organization\_id": 25, "vehicle\_type": "cargo\_van", "add\_ons": \[\ \ "dolly"\ \ \], "dedicated\_vehicle": false, "items": \[\ \ {\ \ "name": "Cordless Power Drill",\ \ "description": "18V Lithium-Ion Cordless Drill Kit",\ \ "external\_id": "DRILL-001",\ \ "scan\_string": "DRILL-001",\ \ "sku": "DRILL-001",\ \ "quantity": 1,\ \ "weight": 200,\ \ "length": 25,\ \ "width": 25,\ \ "height": 25\ \ }\ \ \] } | JSON | | --- | ## Code Snippet (Collapsed) Shell Curl Response AllCookiesHeadersBody All [Powered By Scalar.com](https://www.scalar.com/) .,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:. \|\|\|\|\|\|\|\|\|\|\|\|\|\|!?TFPRBBBBBBBBBBBBBBB8m=, \|\|\|\| '""^^!!\|\|\|\|\|\|\|\|\|\|TFPRBBBVT!:...! \|\|\|\| '""^^!!\|\|\|\|\|?!:.......! \|\|\|\| \|\|\|\|.........! \|\|\|\| \|\|\|\|.........! \|\|\|\| \|\|\|\|.........! \|\|\|\| \|\|\|\|.........! \|\|\|\| \|\|\|\|.........! \|\|\|\| \|\|\|\|.........! \|\|\|\|, \|\|\|\|.........\` \|\|\|\|\|!!-.\_ \|\|\|\|.......;. ':!\|\|\|\|\|\|\|\|\|!!-.\_ \|\|\|\|.....bBBBBWdou,. bBBBBB86foi!\|\|\|\|\|\|\|!!-..:\|\|\|!..bBBBBBBBBBBBBBBY! ::!?TFPRBBBBBB86foi!\|\|\|\|\|\|\|\|!!bBBBBBBBBBBBBBBY..! :::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....! :::;\`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......! ;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........! .ob86foi;::::::::::::::::::::::::!?TFPRBY..........\` .b888888888886foi;:::::::::::::::::::::::..........\` .b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......\`!Tf998888888888888888888888888888888886foi;:::....\` '"^!\|Tf9988888888888888888888888888888888!::..\` '"^!\|Tf998888888888888888888888889!! '\` '"^!\|Tf9988888888888888888!!\` iBBbo. '"^!\|Tf998888888889!\` WBBBBbo. '"^!\|Tf9989!\` YBBBP^' '"^!\` \` Send Request ctrlControl ↵Enter Version 1Version 2 (Latest)