MCP Orders Tools

Order Add Attachment

order_add_attachment — Writes data. Beta: this tool is being rolled out and may not be available on your account yet.

Attach a file to an order. The file is fetched from the given URL and stored with the order.

order_id (integer, required)

url (string, required)

Order Import

order_import — Writes data.

Import (create) or update an order, matched by client_order_id + store; it is attributed to the built-in Offline store. SIDE EFFECTS: creates or updates the buyer record, may decrement stock, and EMAILS THE BUYER – a real customer of this jeweller – the new-order / status auto-emails. Those emails cannot be recalled, so confirm with the user before importing orders in bulk. Provide exactly one of client_id or client, and at most one of discount_rate or discount_sum. Returns the order id plus created/updated flags.

client_order_id (string, required) — External order id; the match key for create-vs-update.

status (integer, required) — Order status id, see order_statuses.

client_id (integer) — Existing buyer id (see orders_clients_export). Mutually exclusive with client.

client (object) — Buyer to create/update. Mutually exclusive with client_id.

client.email (string, required)

client.name (string)

client.phone (string)

client.country_code (string) — ISO country code; must be known to the system.

client.address (string)

products (array) — Order line items.

products[].payment_id (string, required) — Your unique per-line id (required).

products[].product_id (integer) — Internal product id. Provide product_id and/or product_code; if neither resolves, the line becomes an external item.

products[].product_code (string) — Product SKU. If given but not found, the call fails.

products[].amount (integer) — Quantity.

products[].buy_price (number)

products[].original_price (number)

products[].order_title (string) — Line title shown on the order.

products[].stock_id (integer) — Stock location to draw from, see order_stocks.

products[].comment (string)

products[].thumb_url (string) — Image URL, used only for external (unmatched) items.

shipping_info (object)

shipping_info.first_name (string)

shipping_info.last_name (string)

shipping_info.addr_line_1 (string)

shipping_info.addr_line_2 (string)

shipping_info.city (string)

shipping_info.state (string)

shipping_info.zip (string)

shipping_info.country_code (string)

shipping_info.phone (string)

shipping_info.shipping_full_address (string)

shipping_info.shipping_type (string)

tracking_number (string)

order_date (string) — YYYY-MM-DD.

order_time (string) — HH:MM:SS.

due_date (string)

discount_rate (number) — Percent discount. Mutually exclusive with discount_sum.

discount_sum (number) — Absolute discount. Mutually exclusive with discount_rate.

final_price (number)

comments (string)

recipients (string)

currency (string)

payment_method (string)

fulfillment_channel (integer)

Order Replace Product

order_replace_product — Writes data.

Replace the product of an order line with another product. Does not affect stock levels; a history record is written to the order.

order_id (integer, required)

order_line_id (integer, required)

product_id (integer, required) — The replacement product id.

Order Set Tracking

order_set_tracking — Writes data.

Set the shipment tracking number of an order (single shipment for the whole order). Fails if the order already has a tracking number.

order_id (integer, required)

carrier (string, required)

tracking_number (string, required)

send_date (string, required) — Shipment date-time, e.g. “2026-06-10 15:30”.

extended_field_1 (string)

extended_field_2 (string)

Order Set Tracking Separate

order_set_tracking_separate — Writes data.

Set per-line-item tracking numbers on an order whose sales channel supports separate shipments. Each item targets one order line.

order_id (integer, required)

items (array, required)

items[].order_line_id (integer, required)

items[].carrier (string, required)

items[].tracking_number (string, required)

items[].send_date (string, required) — Shipment date-time, e.g. “2026-06-10 15:30”.

extended_field_1 (string)

extended_field_2 (string)

Order Statuses

order_statuses — Read-only.

List the order statuses configured for this client (id, title, priority). Use the ids as the status argument of order_update and order_import.

Takes no parameters.

Order Stocks

order_stocks — Read-only.

List the stock locations of this client (id, title, is_default). Use the ids as the stock_id argument of product_sold.

Takes no parameters.

Order Update

order_update — Writes data.

Update order fields: payment method, transaction id, comments, shipping name, shipping reference number, status or invoice number. At least one field besides order_id must be provided.

order_id (integer, required)

payment_method (string)

transaction_id (string)

comments (string)

shipping_name (string)

shipping_reference_number (string)

status (integer) — Order status id, see order_statuses.

invoice_number (string)

Orders Client Import

orders_client_import — Writes data.

Create a customer (buyer) record. Fails if a customer with the given email already exists. Returns the new customer client_id.

email (string, required)

country_code (string) — ISO country code; must be known to the system when provided.

name (string)

shop_username (string)

username (string)

company (string)

contact_person (string)

phone (string)

address (string)

description (string)

comments (string)

Orders Clients Export

orders_clients_export — Read-only.

Export all customers (buyers) of this client with their contact data and country codes.

Takes no parameters.

Orders Export

orders_export — Read-only.

Export orders (paginated, newest first) with full buyer, shipping, line-item, history and attachment data. Filter by date range, statuses, sales channel or client order id. Returns items plus total_items_count. Always paginated here: `limit` defaults to 20 and caps at 100; page through older orders with `offset`.

offset (integer) — Default: 0.

limit (integer) — Default: 20.

date_from (string)

date_to (string)

statuses (array) — Order status ids, see order_statuses.

channel (string) — Substring match on the STORE NAME the order came in on – free text, and not the platform identifier the listings and posting tools take. A client’s store name is whatever they called it, so match loosely or omit this.

client_order_id (string) — Substring match on the external order id.