# Kosmo Documentation

> Documentation for Kosmo

## API Reference: Overview
- [What's Kosmo?](https://kosmo.readme.io/reference/whats-kosmo.md)

## API Reference: API Guidelines
- [Getting Started](https://kosmo.readme.io/reference/getting-started-1.md)
- [Which endpoint to use based on my use case?](https://kosmo.readme.io/reference/what-endpoint-to-use-based-on-my-use-case.md)
- [Model descriptions](https://kosmo.readme.io/reference/model-descriptions.md)
- [Sandbox](https://kosmo.readme.io/reference/sandbox.md): What is it and how to use it
- [Order State Machine](https://kosmo.readme.io/reference/order-state-machine.md)
- [API Errors](https://kosmo.readme.io/reference/api-errors.md): On this page you'll find information regarding errors that you might encounter when using the Kosmo API. Hopefully they are self explanatory so we can help solve them.
- [Locations](https://kosmo.readme.io/reference/locations-1.md)
- [Merchants](https://kosmo.readme.io/reference/merchants-1.md)
- [Auto-Dispatch](https://kosmo.readme.io/reference/auto-dispatch.md)
- [3PL Quotes](https://kosmo.readme.io/reference/quotes-2.md)
- [Customer Notifications](https://kosmo.readme.io/reference/customer-communications.md)
- [Idempotent requests](https://kosmo.readme.io/reference/idempotent-requests.md)
- [API Examples](https://kosmo.readme.io/reference/examples.md)

## API Reference: Kosmo API Reference v2
- [Orders](https://kosmo.readme.io/reference/orders.md)
  - [Assign driver to draft order](https://kosmo.readme.io/reference/assigndrivertodraftorder.md): Assign driver to draft order. BETA - This endpoint is in beta and is subject to change.
  - [Create draft order](https://kosmo.readme.io/reference/createdraftorder.md): You can use this endpoint to create draft order which you can manage later on the Plan Orders platform page. Not supported in Test mode.
  - [Create order](https://kosmo.readme.io/reference/createorder.md): You can use this endpoint to create an order without quotes.
  - [List orders](https://kosmo.readme.io/reference/getorders.md): You can use this endpoint to get a list of orders.
  - [Get order](https://kosmo.readme.io/reference/getorder.md): You can use this endpoint to get information about a specific order.
  - [Cancel order](https://kosmo.readme.io/reference/cancelorder.md)
  - [Set tips to order](https://kosmo.readme.io/reference/settipsorder.md)
- [Stops](https://kosmo.readme.io/reference/stops.md)
  - [Batch import stops](https://kosmo.readme.io/reference/batchimportstops.md): You can use this endpoint to create multiple stops at once. It will return a plan ID which you can use to optimize the plan.
  - [Find stop](https://kosmo.readme.io/reference/findstops.md): You can use this endpoint to find stops by order reference id. BETA - This endpoint is in beta and is subject to change.
  - [Update stop](https://kosmo.readme.io/reference/updatestop.md): You can use this endpoint to update a stop. Provide order reference id, and we check both Draft and Active orders. Location cannot be updated, you should cancel this and create a new one.
  - [Cancel stop](https://kosmo.readme.io/reference/cancelstop.md): You can use this endpoint to cancel a stop. Provide order reference id, and we check both Draft and Active orders. Draft order will be permanently deleted. Active order will be marked as cancelled.
  - [Merge stops](https://kosmo.readme.io/reference/mergestops.md): You can use this endpoint to merge multiple stops into one.
- Plans
  - [Optimize plan](https://kosmo.readme.io/reference/optimizeplan.md): Optimize a plan. It returns a list of optimized orders. Sometimes it can be not ready, so need to check the status. Recommended to check it once in 5 seconds.
  - [Confirm plan](https://kosmo.readme.io/reference/confirmplan.md): Confirm a plan. It will create orders from the optimized plan and send them to drivers.
- [Quotes](https://kosmo.readme.io/reference/quotes-1.md)
  - [Create quotes](https://kosmo.readme.io/reference/post_v2-quotes.md): You can use this endpoint to generate quotes from multiple providers.
  - [Accept quote](https://kosmo.readme.io/reference/acceptquote.md): You can use this endpoint to accept one of the previously generated quotes.
- Locations
  - [Get list of locations](https://kosmo.readme.io/reference/get_v2-locations.md): (Work in progress) You can use this endpoint to get a list of all your saved and used locations.
  - [Create location](https://kosmo.readme.io/reference/post_v2-locations.md): (Work in progress) You can use this endpoint to create a new location.
- Merchants
  - [Create merchant](https://kosmo.readme.io/reference/post_v2-orgs-merchants.md): You can use this endpoint to create a new merchant. Please, reach out to us if you want to use this endpoint.
  - [Get merchants](https://kosmo.readme.io/reference/get_v2-orgs-merchants.md): After you link and merchant, you can get all merchants for your org.  it returns the `merchantId` which later can be use as an optional field in `getQuotes`
- Drivers
  - [Create driver](https://kosmo.readme.io/reference/post_v2-drivers.md): You can use this endpoint to create a new driver.
  - [Get list of drivers](https://kosmo.readme.io/reference/get_v2-drivers.md): You can use this endpoint to get a list of all drivers.
- [Webhooks](https://kosmo.readme.io/reference/webhooks-1.md)
  - [/v2/webhooks/kosmo](https://kosmo.readme.io/reference/post_v2-webhooks-kosmo.md)