orderdesk_get_store
Get store settings and folders
The store's name, id, FOLDERS (id -> name; orders live in exactly one folder, and folder ids are needed to filter and move orders) and key settings (timezone, locale, stock behavior, shipping methods). The API key and mail credentials are never returned. GET /store.
Takes no parameters.
orderdesk_list_orders
List orders
Search orders, newest first, with items, addresses, totals, payment and shipments. Filters combine with AND. Prefer a date range: Order Desk asks clients to avoid open-ended queries. Page with limit and offset (next_offset). GET /orders.
Parametersemaillimitorderoffsetadded_toorder_byfolder_idsource_idadded_fromcustomer_idfolder_namemodified_to+7 more
orderdesk_get_order
Get order
One order by Order Desk's internal id: addresses, items, totals, payment, notes, discounts, checkout data and shipments. To find an order by your own id, use orderdesk_list_orders with source_id. GET /orders/{order_id}.
Parametersorder_idrequired
orderdesk_list_order_items
List order items
The line items of one order (name, SKU, price, quantity, weight, delivery type, variations). GET /orders/{order_id}/order-items.
Parametersorder_idrequired
orderdesk_list_order_shipments
List order shipments
The shipments recorded against an order: carrier, tracking number and URL, method, weight, cost, dates. GET /orders/{order_id}/shipments.
Parametersorder_idrequired
orderdesk_create_order
Create order
WRITE: add a new order to the store. Needs at least one item, and a name or company in the shipping or customer address (if only one address is given the other is copied from it). Omit folder_id to land in the first folder. Order Desk rejects an order it recognizes as a duplicate and names the existing order id. POST /orders.
Parametersemailcustomershippingfolder_idsource_idtax_totalorder_itemsrequiredsource_namepayment_typecheckout_datahandling_totalorder_metadata+3 more
orderdesk_update_order
Update order
WRITE: change fields of an existing order. Order Desk's PUT replaces the whole record, so this reads the order, applies only the fields you pass (shipping/customer address fields and checkout_data/order_metadata keys are merged into what is there, other values replaced) and sends the complete record back, items included. The order keeps its folder; use orderdesk_move_orders to move it. PUT /orders/{order_id}.
Parametersemailcustomerorder_idrequiredshippingtax_totalcheckout_datahandling_totalorder_metadatapayment_statusshipping_totalshipping_method
orderdesk_add_order_item
Add order item
WRITE: add one line item to an existing order; Order Desk recalculates the totals. POST /orders/{order_id}/order-items.
Parametersitemrequiredorder_idrequired
orderdesk_add_order_note
Add order history note
WRITE: append an entry to an order's history. History is append-only (entries cannot be edited or removed) and an order holds at most 250 entries, so do not use it for routine polling. POST /orders/{order_id}/order-history.
Parametersnoterequiredorder_idrequiredsource_name
orderdesk_add_shipment
Add shipment
WRITE: record a shipment (carrier and tracking number) against an order. One shipment per parcel; several shipments represent a partial fulfillment. Use "n/a" when there is no tracking number. If tracking_url is omitted Order Desk derives it. POST /orders/{order_id}/shipments.
Parameterscostweightorder_idrequiredcarrier_codetracking_urlshipment_methodtracking_numberrequired
orderdesk_move_orders
Move orders to a folder
WRITE: move one or more orders to another folder. Moving runs the rules attached to the destination folder (which can send e-mail, call fulfillment services, etc.) and writes a history entry. Pass exactly one of destination_folder_id or destination_folder_name (see orderdesk_get_store). Returns each order's previous folder. POST /move-orders.
Parametersorder_idsrequireddestination_folder_iddestination_folder_name
orderdesk_list_inventory_items
List inventory items
Search the store's inventory (SKU, name, price, cost, weight, stock, location). Order Desk returns every match with no paging, so narrow with search/code/name; limit and offset slice the result here. GET /inventory-items.
Parameterscodenamelimitoffsetsearchlocationupdated_frommanufacturer_sku
orderdesk_get_inventory_item
Get inventory item
One inventory item by Order Desk's internal id. GET /inventory-items/{inventory_item_id}.
Parametersinventory_item_idrequired
orderdesk_create_inventory_item
Create inventory item
WRITE: add an inventory item. The code (SKU) must match the code your orders arrive with. POST /inventory-items.
Parameterscoderequiredcostnamerequiredpricestockweightlocationmetadatavariation_listmanufacturer_sku
orderdesk_update_inventory_item
Update inventory item
WRITE: change fields of an inventory item, for example its stock count. Order Desk's PUT replaces the whole record, so this reads the item, applies only the fields you pass (metadata and variation keys are merged) and sends the complete record back. PUT /inventory-items/{inventory_item_id}.
Parameterscodecostnamepricestockweightlocationmetadatavariation_listmanufacturer_skuinventory_item_idrequired