Orders
Read orders, shipments, claims and carts; cancel orders and add notes.
10 tools. 2 change your store. Your client only shows the ones your permissions allow.
Search orders
Lists orders and searches them by number, status or date.
- Tool:
orders_list - Permissions:
order:read - Read-only
Read an order
Reads an order's status, items, totals, payments and notes.
- Tool:
orders_get - Permissions:
order:read - Read-only
Cancel an order
Cancels the order and fulfillment, returns reserved stock, emails the customer. No refund.
- Tool:
orders_cancel_propose - Permissions:
order:read,order:update - Changes your store
Add a note
Adds an internal note to an order. The customer doesn't see it.
- Tool:
orders_note_add - Permissions:
order:read,order:update - Changes your store
Search claims
Lists the store's complaint book entries.
- Tool:
orders_list_claims - Permissions:
order:read - Read-only
Read a claim
Reads one complaint book entry.
- Tool:
orders_get_claim - Permissions:
order:read - Read-only
Search shipments
Lists shipments by order or location.
- Tool:
fulfillment_list_orders - Permissions:
shipment:read - Read-only
Read a shipment
Reads a shipment's items, packages and tracking.
- Tool:
fulfillment_get_order - Permissions:
shipment:read - Read-only
Search carts
Lists the store's carts.
- Tool:
carts_list_carts - Permissions:
order:read - Read-only
Read a cart
Reads a cart's items and totals.
- Tool:
carts_get_cart - Permissions:
order:read - Read-only
Last updated: