Order Manager
List and retrieve order details including line items, totals, shipping info, and payment status for e-commerce order management.
The Order Manager gives you read access to all orders processed through GHL storefronts. Every purchase, every checkout, every transaction — the order record captures what was bought, how much was paid, and the current fulfillment status.
What This MCP Tool Does
This tool lets you list all orders and retrieve detailed order information including line items, totals, shipping details, customer information, and payment status. This is the data foundation for order fulfillment dashboards, revenue reporting, and customer communication automations.
Endpoint Reference
List all orders:
GET /payments/orders
Retrieve orders with filtering and pagination support.
Get order details:
GET /payments/orders/{orderId}
Retrieve the complete order record including line items, totals, shipping, and payment data.
Authentication
Requires a Private Integration Token (PIT) with the payments scope enabled.
Key Parameters
Order records include:
id— unique order identifiercontactId— the customer who placed the orderitems— array of line items with product references, quantities, and amountstotal— order total including taxes and shippingstatus— current order status (pending, completed, refunded, etc.)shippingAddress— delivery address for physical productscreatedAt— order timestamp
Important Notes
Orders are read-only through this API. You can view orders but cannot create, modify, or cancel them programmatically. Order creation happens through the checkout flow (funnel, storefront, or payment link).
For order management automations, combine order data with contact operations. When an order is completed, you might want to tag the contact, add them to a workflow, or update their pipeline stage using other MCP tools.
Order data connects to fulfillment tracking through the Order Fulfillment tool and to financial data through the Transactions tool.
Common Questions
Can I filter orders by date range? Yes, use date parameters to retrieve orders within a specific time window. This is essential for daily/weekly order reporting.
How do I connect an order to the customer’s contact record?
Each order includes a contactId. Use Contact CRUD to retrieve the full contact record and see their complete history.
Can I create orders through the API? No. Orders are created through customer-facing checkout flows. Use Invoice CRUD for direct billing or Payment Links for ad-hoc charges.
How do I track order fulfillment? Use the Order Fulfillment tool to create fulfillment records with tracking numbers and shipping status.
Related MCP Tools
- Order Fulfillment — Create fulfillment records for orders
- Transactions — View payment transaction data for orders
- Contact CRUD — Look up the customer associated with an order
- Product CRUD — Reference products in order line items
- Inventory Ops — Orders affect inventory levels