# iDirect Open API

> The iDirect Open API lets external systems (WMS / OMS / e-commerce backends) integrate delivery data: push and update orders (single or bulk), create tasks, invite and manage drivers, maintain the customer address book, and query statuses. Route optimization and route publishing are dashboard operations and are not exposed through this API.

Base URL: https://api.idirect.app/open/v1 · Auth: `Authorization: Bearer sk_your_api_key`

## Start here

- [Overview](https://developer.idirect.app/md/overview.md): authentication, error codes, rate limits, pagination, idempotency, order lifecycle
- [Full API reference](https://developer.idirect.app/md/api.md): every endpoint in a single file
- [Webhooks overview](https://developer.idirect.app/md/webhooks-overview.md): event delivery and signature verification

## Me

- [Verify the API key and return the current team](https://developer.idirect.app/md/get-me.md): `GET /me`

## Order

- [Create an order in a task](https://developer.idirect.app/md/create-order-in-task.md): `POST /task/{taskId}/order`
- [Create an unscheduled order](https://developer.idirect.app/md/create-unscheduled-order.md): `POST /unscheduled/order`
- [Search orders](https://developer.idirect.app/md/search-order.md): `GET /order/search`
- [Bulk import orders into a task (async)](https://developer.idirect.app/md/import-orders-into-task.md): `POST /task/{taskId}/order/import`
- [Bulk import unscheduled orders (async)](https://developer.idirect.app/md/import-unscheduled-orders.md): `POST /unscheduled/order/import`
- [Get an order in a task](https://developer.idirect.app/md/get-order-in-task.md): `GET /task/{taskId}/order/{orderId}`
- [Update an order in a task](https://developer.idirect.app/md/update-order-in-task.md): `POST /task/{taskId}/order/{orderId}`
- [Get an unscheduled order](https://developer.idirect.app/md/get-unscheduled-order.md): `GET /unscheduled/order/{orderId}`
- [Update an unscheduled order](https://developer.idirect.app/md/update-unscheduled-order.md): `POST /unscheduled/order/{orderId}`
- [Assign an unscheduled order into a task](https://developer.idirect.app/md/assign-order.md): `POST /unscheduled/order/{orderId}/assign`
- [Remove an order from its task](https://developer.idirect.app/md/unassign-order.md): `POST /task/{taskId}/order/{orderId}/unassign`

## Task

- [Create a task](https://developer.idirect.app/md/create-task.md): `POST /task`
- [Search tasks](https://developer.idirect.app/md/search-task.md): `GET /task/search`
- [Get a task](https://developer.idirect.app/md/get-task.md): `GET /task/{taskId}`
- [Delete a task](https://developer.idirect.app/md/delete-task.md): `POST /task/{taskId}/delete`

## Operation

- [Get async operation status (bulk import)](https://developer.idirect.app/md/get-operation.md): `GET /operation/{operationId}`

## Driver

- [Invite a driver (create)](https://developer.idirect.app/md/invite-driver.md): `POST /driver/invite`
- [List drivers](https://developer.idirect.app/md/list-driver.md): `GET /driver`
- [Get a driver](https://developer.idirect.app/md/get-driver.md): `GET /driver/{driverId}`
- [Update a driver](https://developer.idirect.app/md/update-driver.md): `POST /driver/{driverId}`

## Customer

- [List customers](https://developer.idirect.app/md/list-customer.md): `GET /customer`
- [Create a customer (address book entry)](https://developer.idirect.app/md/create-customer.md): `POST /customer`
- [Get a customer](https://developer.idirect.app/md/get-customer.md): `GET /customer/{customerId}`
- [Update a customer](https://developer.idirect.app/md/update-customer.md): `POST /customer/{customerId}`

## Webhooks

- [Order out for delivery](https://developer.idirect.app/md/webhook-order-start-delivery.md): event `order.start_delivery`
- [Order delivered](https://developer.idirect.app/md/webhook-order-succeeded.md): event `order.succeeded`
- [Order delivery failed](https://developer.idirect.app/md/webhook-order-failed.md): event `order.failed`
- [Test event](https://developer.idirect.app/md/webhook-test-event.md): event `test.event`

## Optional

- [OpenAPI spec (YAML)](https://developer.idirect.app/openapi.yaml): machine-readable spec, the single source of truth
- [Webhooks spec (YAML)](https://developer.idirect.app/webhook.yaml)
- [Everything in one file](https://developer.idirect.app/llms-full.txt)