---
canonical_url: "https://docs.composio.dev/toolkits/order_desk"
markdown_url: "https://docs.composio.dev/toolkits/order_desk.md"
product: "platform"
version: null
last_updated: null
---

# Order Desk

Order Desk is an order management platform for managing orders, shipments, inventory, and store data across ecommerce integrations.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 20
- **Triggers:** 0
- **Slug:** `ORDER_DESK`
- **Version:** 00000000_00

## Tools

### Add Order History Note

**Slug:** `ORDER_DESK_ADD_ORDER_HISTORY_NOTE`

Append a timestamped note permanently to an existing order's history. Order history is append-only, so this tool cannot edit or remove the entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | Yes | Note text to append permanently to order history, up to 1800 characters. This append-only entry cannot be edited or removed by this tool. |
| `order_id` | integer | Yes | Positive Order Desk internal order ID. |
| `source_name` | string | No | Integration or actor name to record as the permanent note source. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Order Item

**Slug:** `ORDER_DESK_ADD_ORDER_ITEM`

Add one line item to an existing order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | SKU or item code. |
| `name` | string | Yes | Line-item name. |
| `price` | number | No | Unit price. |
| `weight` | number | No | Item weight. |
| `metadata` | object | No | Flat metadata key/value object containing only scalar values. Its JSON encoding must not exceed 15000 characters. |
| `order_id` | integer | Yes | Positive Order Desk internal order ID. |
| `quantity` | integer | No | Quantity to add. |
| `category_code` | string | No | Category code. |
| `delivery_type` | string ("ship" | "noship" | "download" | "future") | No | Delivery behavior: ship, noship, download, or future. |
| `variation_list` | object | No | Flat variation key/value object containing only scalar values. Its JSON encoding must not exceed 5000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Order Items

**Slug:** `ORDER_DESK_ADD_ORDER_ITEMS`

Add two to 10 line items sequentially to the same order and return a result for every processed item. This batch is not atomic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Two to 10 line items to add sequentially to the same order. The batch is not atomic: earlier items remain added if a later item fails. |
| `order_id` | integer | Yes | Positive Order Desk internal order ID that will receive every item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Inventory Item

**Slug:** `ORDER_DESK_CREATE_INVENTORY_ITEM`

Create one inventory item with a unique SKU and return its positive Order Desk ID and complete created representation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Unique SKU for the inventory item. |
| `cost` | number | No | Item cost. |
| `name` | string | Yes | Inventory item name. |
| `price` | number | No | Selling price. |
| `stock` | number | No | Current stock quantity. |
| `weight` | number | No | Item weight. |
| `location` | string | No | Storage location. |
| `metadata` | object | No | Flat inventory metadata object containing only scalar values. Its JSON encoding must not exceed 5000 characters. |
| `update_source` | string | No | Integration slug responsible for the update. |
| `variation_list` | object | No | Flat variation key/value object containing only scalar values. Its JSON encoding must not exceed 5000 characters. |
| `manufacturer_sku` | string | No | Manufacturer SKU. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Inventory Items

**Slug:** `ORDER_DESK_CREATE_INVENTORY_ITEMS`

Create two to 10 inventory items sequentially and return each created ID or error. This batch is not atomic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Two to 10 inventory items to create sequentially. Every code must be a unique SKU. The batch is not atomic: earlier items remain created if a later item fails. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Shipments

**Slug:** `ORDER_DESK_CREATE_SHIPMENTS`

Create one or more shipment records across orders in one request and report the success or error returned for every shipment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shipments` | array | Yes | Shipment records to create. Pass one record for a single shipment or multiple records for a batch; this tool allows at most 50 per call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inventory Item

**Slug:** `ORDER_DESK_DELETE_INVENTORY_ITEM`

Permanently delete one inventory item by its positive Order Desk ID. This destructive action cannot be undone; verify the ID before calling it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inventory_item_id` | integer | Yes | Positive Order Desk inventory item ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Item

**Slug:** `ORDER_DESK_DELETE_ORDER_ITEM`

Permanently remove one line item from an order. This destructive action cannot be undone by this tool; verify both IDs before calling it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Positive Order Desk internal order ID. |
| `order_item_id` | integer | Yes | Positive Order Desk line-item ID to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Shipment

**Slug:** `ORDER_DESK_DELETE_SHIPMENT`

Permanently remove one shipment record from an order. This destructive action cannot be undone by this tool; verify both IDs before calling it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Positive Order Desk internal order ID. |
| `shipment_id` | integer | Yes | Positive shipment ID to permanently remove from the order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Item

**Slug:** `ORDER_DESK_GET_INVENTORY_ITEM`

Get one inventory item by its positive Order Desk ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inventory_item_id` | integer | Yes | Positive Order Desk inventory item ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `ORDER_DESK_GET_ORDER`

Get one order and its addresses, line items, shipments, metadata, notes, and discounts by Order Desk internal ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Positive Order Desk internal order ID, not the source integration ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Store Metadata

**Slug:** `ORDER_DESK_GET_STORE_METADATA`

Return safe store identity, locale, timezone, page-size settings, and folder IDs and names without exposing credentials or email configuration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Items

**Slug:** `ORDER_DESK_LIST_INVENTORY_ITEMS`

Search inventory items in the connected store by ID, SKU, name, metadata, manufacturer SKU, location, or update time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Exact unique SKU filter. |
| `name` | string | No | Inventory item name filter. |
| `search` | string | No | Search metadata, name, and code. |
| `location` | string | No | Location filter. |
| `metadata` | string | No | Value that must occur in metadata keys or values. |
| `manufacturer_sku` | string | No | Manufacturer SKU filter. |
| `inventory_item_id` | integer | No | Positive Order Desk inventory item ID; sent as the provider's id filter. |
| `updated_start_date` | string | No | Earliest update date in UTC. |
| `exclude_update_source` | string | No | Exclude items last updated by this integration slug. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Items

**Slug:** `ORDER_DESK_LIST_ORDER_ITEMS`

Return all line items for one order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Positive Order Desk internal order ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orders

**Slug:** `ORDER_DESK_LIST_ORDERS`

Find orders in the connected store using at least one narrowing filter and return one bounded page. Use next_cursor to continue the same query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Exact customer email address. |
| `limit` | integer | No | Maximum orders in this page (1-500). |
| `order_by` | string | No | Provider order field. |
| `folder_id` | string | No | One folder ID or comma-separated folder IDs. |
| `source_id` | string | No | Exact order ID from the source integration. |
| `sort_order` | string ("ASC" | "DESC") | No | Sort direction. |
| `customer_id` | string | No | Exact source customer ID. |
| `folder_name` | string | No | Exact folder name. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; it retains the original filters and page size. |
| `source_name` | string | No | Source integration name. |
| `search_end_date` | string | No | Created-at upper bound in UTC. |
| `customer_company` | string | No | Customer company filter. |
| `shipping_company` | string | No | Shipping company filter. |
| `modified_end_date` | string | No | Modified-at upper bound in UTC. |
| `search_start_date` | string | No | Created-at lower bound in UTC. |
| `customer_last_name` | string | No | Customer last name filter. |
| `shipping_last_name` | string | No | Shipping recipient last name filter. |
| `customer_first_name` | string | No | Customer first name filter. |
| `modified_start_date` | string | No | Modified-at lower bound in UTC. |
| `shipping_first_name` | string | No | Shipping recipient first name filter. |
| `include_order_history` | boolean | No | Include order history. This makes the provider query considerably slower. |
| `search_end_date_local` | string | No | Created-at upper bound in store-local time. |
| `search_start_date_local` | string | No | Created-at lower bound in store-local time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Shipments

**Slug:** `ORDER_DESK_LIST_ORDER_SHIPMENTS`

Return all shipments recorded for one order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | Yes | Positive Order Desk internal order ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Orders

**Slug:** `ORDER_DESK_MOVE_ORDERS`

Move one or more orders to exactly one destination folder selected by positive ID or exact name, with a result for every order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_ids` | array | Yes | Unique positive Order Desk internal order IDs to move. This tool allows at most 100 orders per call. |
| `destination_folder_id` | integer | No | Positive destination folder ID. Supply this or destination_folder_name, never both. |
| `destination_folder_name` | string | No | Exact destination folder name. Supply this or destination_folder_id, never both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Inventory Items

**Slug:** `ORDER_DESK_UPDATE_INVENTORY_ITEMS`

Safely update selected fields on one or more inventory items while preserving every omitted field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `updates` | array | Yes | One to 50 partial inventory updates. Inventory item IDs must be unique; all items are read before any update is attempted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order Item

**Slug:** `ORDER_DESK_UPDATE_ORDER_ITEM`

Safely update selected fields on one order line item while preserving every omitted field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | Yes | Writable item fields to change. Omitted fields are preserved; nested objects merge recursively; explicit null or empty values clear fields. |
| `order_id` | integer | Yes | Positive Order Desk internal order ID. |
| `order_item_id` | integer | Yes | Positive Order Desk line-item ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Shipment

**Slug:** `ORDER_DESK_UPDATE_SHIPMENT`

Safely update selected fields on one shipment while preserving every omitted field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | object | Yes | Shipment fields to change. Omitted fields are preserved; explicit null or empty values clear fields where supported. |
| `order_id` | integer | Yes | Positive Order Desk internal order ID. |
| `shipment_id` | integer | Yes | Positive Order Desk shipment ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |