Skip to main content
Order Desk logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: ORDER_DESK
  • Version: 20261101_00

Tools

Slug: ORDER_DESK_ADD_ORDER_HISTORY_NOTEAppend 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

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.
integer
required
Positive Order Desk internal order ID.
string
Integration or actor name to record as the permanent note source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_ADD_ORDER_ITEMAdd one line item to an existing order.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_ADD_ORDER_ITEMSAdd 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

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.
integer
required
Positive Order Desk internal order ID that will receive every item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_CREATE_INVENTORY_ITEMCreate one inventory item with a unique SKU and return its positive Order Desk ID and complete created representation.

Input Parameters

string
required
Unique SKU for the inventory item.
number
Item cost.
string
required
Inventory item name.
number
Selling price.
number
Current stock quantity.
number
Item weight.
string
Storage location.
object
Flat inventory metadata object containing only scalar values. Its JSON encoding must not exceed 5000 characters.
string
Integration slug responsible for the update.
object
Flat variation key/value object containing only scalar values. Its JSON encoding must not exceed 5000 characters.
string
Manufacturer SKU.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_CREATE_INVENTORY_ITEMSCreate 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_CREATE_SHIPMENTSCreate 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_DELETE_INVENTORY_ITEMPermanently delete one inventory item by its positive Order Desk ID. This destructive action cannot be undone; verify the ID before calling it.

Input Parameters

integer
required
Positive Order Desk inventory item ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_DELETE_ORDER_ITEMPermanently remove one line item from an order. This destructive action cannot be undone by this tool; verify both IDs before calling it.

Input Parameters

integer
required
Positive Order Desk internal order ID.
integer
required
Positive Order Desk line-item ID to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_DELETE_SHIPMENTPermanently remove one shipment record from an order. This destructive action cannot be undone by this tool; verify both IDs before calling it.

Input Parameters

integer
required
Positive Order Desk internal order ID.
integer
required
Positive shipment ID to permanently remove from the order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_GET_INVENTORY_ITEMGet one inventory item by its positive Order Desk ID.

Input Parameters

integer
required
Positive Order Desk inventory item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_GET_ORDERGet one order by Order Desk internal ID, including addresses, line items, shipments, metadata, notes, and discounts when returned.

Input Parameters

integer
required
Positive Order Desk internal order ID, not the source integration ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_GET_STORE_METADATAReturn safe store identity, locale, timezone, page-size settings, and folder IDs and names without exposing credentials or email configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_LIST_INVENTORY_ITEMSSearch inventory items in the connected store by ID, SKU, name, metadata, manufacturer SKU, location, or update time.

Input Parameters

string
Exact unique SKU filter.
string
Inventory item name filter.
Search metadata, name, and code.
string
Location filter.
string
Value that must occur in metadata keys or values.
string
Manufacturer SKU filter.
integer
Positive Order Desk inventory item ID; sent as the provider’s id filter.
string
Earliest update date in UTC.
string
Exclude items last updated by this integration slug.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_LIST_ORDER_ITEMSReturn all line items for one order.

Input Parameters

integer
required
Positive Order Desk internal order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_LIST_ORDERSFind 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

string
Exact customer email address.
integer
Maximum orders in this page (1-500).
string
Provider order field.
string
One folder ID or comma-separated folder IDs.
string
Exact order ID from the source integration.
string ("ASC" | "DESC")
Sort direction.
string
Exact source customer ID.
string
Exact folder name.
string
Opaque continuation cursor returned by a previous call; it retains the original filters and page size.
string
Source integration name.
string
Created-at upper bound in UTC.
string
Customer company filter.
string
Shipping company filter.
string
Modified-at upper bound in UTC.
string
Created-at lower bound in UTC.
string
Customer last name filter.
string
Shipping recipient last name filter.
string
Customer first name filter.
string
Modified-at lower bound in UTC.
string
Shipping recipient first name filter.
boolean
Include order history. This makes the provider query considerably slower.
string
Created-at upper bound in store-local time.
string
Created-at lower bound in store-local time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_LIST_ORDER_SHIPMENTSReturn all shipments recorded for one order.

Input Parameters

integer
required
Positive Order Desk internal order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_MOVE_ORDERSMove one or more orders to exactly one destination folder selected by positive ID or exact name, with a result for every order.

Input Parameters

array
required
Unique positive Order Desk internal order IDs to move. This tool allows at most 100 orders per call.
integer
Positive destination folder ID. Supply this or destination_folder_name, never both.
string
Exact destination folder name. Supply this or destination_folder_id, never both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_UPDATE_INVENTORY_ITEMSUpdate 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

array
required
One to 50 partial inventory updates. Inventory item IDs must be unique; all items are read before any update is attempted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_UPDATE_ORDER_ITEMUpdate 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

object
required
Writable item fields to change. Omitted fields are preserved; nested objects merge recursively; explicit null or empty values clear fields.
integer
required
Positive Order Desk internal order ID.
integer
required
Positive Order Desk line-item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORDER_DESK_UPDATE_SHIPMENTUpdate selected fields on one shipment, preserving omitted writable fields returned by the initial shipment read.

Input Parameters

object
required
Shipment fields to change. Omitted fields are preserved; explicit null or empty values clear fields where supported.
integer
required
Positive Order Desk internal order ID.
integer
required
Positive Order Desk shipment ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not