> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Order Desk

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

![Order Desk logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/order_desk.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=119d7090c3c631d3d76b41ff039477b0)

* **Category:** ecommerce
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 20
* **Triggers:** 0
* **Slug:** `ORDER_DESK`
* **Version:** 20261101\_00

## Tools

> [accordion] 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
>
> **note** `string` *required*
>
> 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` *required*
>
> Positive Order Desk internal order ID.
>
> **source\_name** `string`
>
> Integration or actor name to record as the permanent note source.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Order Item
>
> **Slug:** `ORDER_DESK_ADD_ORDER_ITEM`
>
> Add one line item to an existing order.
>
> #### Input Parameters
>
> **code** `string`
>
> SKU or item code.
>
> **name** `string` *required*
>
> Line-item name.
>
> **price** `number`
>
> Unit price.
>
> **weight** `number`
>
> Item weight.
>
> **metadata** `object`
>
> Flat metadata key/value object containing only scalar values. Its JSON encoding must not exceed 15000 characters.
>
> **order\_id** `integer` *required*
>
> Positive Order Desk internal order ID.
>
> **quantity** `integer`
>
> Quantity to add.
>
> **category\_code** `string`
>
> Category code.
>
> **delivery\_type** `string ("ship" | "noship" | "download" | "future")`
>
> Delivery behavior: ship, noship, download, or future.
>
> **variation\_list** `object`
>
> Flat variation key/value object containing only scalar values. Its JSON encoding must not exceed 5000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **items** `array` *required*
>
> 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` *required*
>
> Positive Order Desk internal order ID that will receive every item.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **code** `string` *required*
>
> Unique SKU for the inventory item.
>
> **cost** `number`
>
> Item cost.
>
> **name** `string` *required*
>
> Inventory item name.
>
> **price** `number`
>
> Selling price.
>
> **stock** `number`
>
> Current stock quantity.
>
> **weight** `number`
>
> Item weight.
>
> **location** `string`
>
> Storage location.
>
> **metadata** `object`
>
> Flat inventory metadata object containing only scalar values. Its JSON encoding must not exceed 5000 characters.
>
> **update\_source** `string`
>
> Integration slug responsible for the update.
>
> **variation\_list** `object`
>
> Flat variation key/value object containing only scalar values. Its JSON encoding must not exceed 5000 characters.
>
> **manufacturer\_sku** `string`
>
> Manufacturer SKU.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Inventory Items
>
> **Slug:** `ORDER_DESK_CREATE_INVENTORY_ITEMS`
>
> Create two to 10 inventory items sequentially in a non-atomic batch. Return per-item results, including created items, errors, or unknown outcomes after server errors.
>
> #### Input Parameters
>
> **items** `array` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Shipments
>
> **Slug:** `ORDER_DESK_CREATE_SHIPMENTS`
>
> Create one or more shipment records across orders in one request. Report per-shipment outcomes when they can be attributed; fewer provider results leave all submitted outcomes unknown.
>
> #### Input Parameters
>
> **shipments** `array` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **inventory\_item\_id** `integer` *required*
>
> Positive Order Desk inventory item ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **order\_id** `integer` *required*
>
> Positive Order Desk internal order ID.
>
> **order\_item\_id** `integer` *required*
>
> Positive Order Desk line-item ID to permanently remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **order\_id** `integer` *required*
>
> Positive Order Desk internal order ID.
>
> **shipment\_id** `integer` *required*
>
> Positive shipment ID to permanently remove from the order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inventory Item
>
> **Slug:** `ORDER_DESK_GET_INVENTORY_ITEM`
>
> Get one inventory item by its positive Order Desk ID.
>
> #### Input Parameters
>
> **inventory\_item\_id** `integer` *required*
>
> Positive Order Desk inventory item ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Order
>
> **Slug:** `ORDER_DESK_GET_ORDER`
>
> Get one order by Order Desk internal ID, including addresses, line items, shipments, metadata, notes, and discounts when returned.
>
> #### Input Parameters
>
> **order\_id** `integer` *required*
>
> Positive Order Desk internal order ID, not the source integration ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **code** `string`
>
> Exact unique SKU filter.
>
> **name** `string`
>
> Inventory item name filter.
>
> **search** `string`
>
> Search metadata, name, and code.
>
> **location** `string`
>
> Location filter.
>
> **metadata** `string`
>
> Value that must occur in metadata keys or values.
>
> **manufacturer\_sku** `string`
>
> Manufacturer SKU filter.
>
> **inventory\_item\_id** `integer`
>
> Positive Order Desk inventory item ID; sent as the provider's id filter.
>
> **updated\_start\_date** `string`
>
> Earliest update date in UTC.
>
> **exclude\_update\_source** `string`
>
> Exclude items last updated by this integration slug.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Order Items
>
> **Slug:** `ORDER_DESK_LIST_ORDER_ITEMS`
>
> Return all line items for one order.
>
> #### Input Parameters
>
> **order\_id** `integer` *required*
>
> Positive Order Desk internal order ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **email** `string`
>
> Exact customer email address.
>
> **limit** `integer`
>
> Maximum orders in this page (1-500).
>
> **order\_by** `string`
>
> Provider order field.
>
> **folder\_id** `string`
>
> One folder ID or comma-separated folder IDs.
>
> **source\_id** `string`
>
> Exact order ID from the source integration.
>
> **sort\_order** `string ("ASC" | "DESC")`
>
> Sort direction.
>
> **customer\_id** `string`
>
> Exact source customer ID.
>
> **folder\_name** `string`
>
> Exact folder name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; it retains the original filters and page size.
>
> **source\_name** `string`
>
> Source integration name.
>
> **search\_end\_date** `string`
>
> Created-at upper bound in UTC.
>
> **customer\_company** `string`
>
> Customer company filter.
>
> **shipping\_company** `string`
>
> Shipping company filter.
>
> **modified\_end\_date** `string`
>
> Modified-at upper bound in UTC.
>
> **search\_start\_date** `string`
>
> Created-at lower bound in UTC.
>
> **customer\_last\_name** `string`
>
> Customer last name filter.
>
> **shipping\_last\_name** `string`
>
> Shipping recipient last name filter.
>
> **customer\_first\_name** `string`
>
> Customer first name filter.
>
> **modified\_start\_date** `string`
>
> Modified-at lower bound in UTC.
>
> **shipping\_first\_name** `string`
>
> Shipping recipient first name filter.
>
> **include\_order\_history** `boolean`
>
> Include order history. This makes the provider query considerably slower.
>
> **search\_end\_date\_local** `string`
>
> Created-at upper bound in store-local time.
>
> **search\_start\_date\_local** `string`
>
> Created-at lower bound in store-local time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Order Shipments
>
> **Slug:** `ORDER_DESK_LIST_ORDER_SHIPMENTS`
>
> Return all shipments recorded for one order.
>
> #### Input Parameters
>
> **order\_id** `integer` *required*
>
> Positive Order Desk internal order ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **order\_ids** `array` *required*
>
> Unique positive Order Desk internal order IDs to move. This tool allows at most 100 orders per call.
>
> **destination\_folder\_id** `integer`
>
> Positive destination folder ID. Supply this or destination\_folder\_name, never both.
>
> **destination\_folder\_name** `string`
>
> Exact destination folder name. Supply this or destination\_folder\_id, never both.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Inventory Items
>
> **Slug:** `ORDER_DESK_UPDATE_INVENTORY_ITEMS`
>
> Update selected fields on one to 50 Order Desk inventory items, identified by unique inventory item IDs. Nested changes are merged, while explicit null or empty objects can clear fields; item-level results are returned when provided by Order Desk.
>
> #### Input Parameters
>
> **updates** `array` *required*
>
> One to 50 partial inventory updates. Inventory item IDs must be unique; all items are read before any update is attempted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Order Item
>
> **Slug:** `ORDER_DESK_UPDATE_ORDER_ITEM`
>
> Update selected fields on an Order Desk order line item identified by its order and line-item IDs. Nested changes are merged, and explicit null or empty objects can clear fields.
>
> #### Input Parameters
>
> **changes** `object` *required*
>
> Writable item fields to change. Omitted fields are preserved; nested objects merge recursively; explicit null or empty values clear fields.
>
> **order\_id** `integer` *required*
>
> Positive Order Desk internal order ID.
>
> **order\_item\_id** `integer` *required*
>
> Positive Order Desk line-item ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Shipment
>
> **Slug:** `ORDER_DESK_UPDATE_SHIPMENT`
>
> Update selected fields on one shipment, preserving omitted writable fields returned by the initial shipment read.
>
> #### Input Parameters
>
> **changes** `object` *required*
>
> Shipment fields to change. Omitted fields are preserved; explicit null or empty values clear fields where supported.
>
> **order\_id** `integer` *required*
>
> Positive Order Desk internal order ID.
>
> **shipment\_id** `integer` *required*
>
> Positive Order Desk shipment ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
