Summarize fulfillment orders

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://developer.pattern.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Hub API MCP server": {
    "url": "https://developer.pattern.com/mcp"
  }
}

GET /v1/orders/summary

Bearer auth

Aggregate counts and merchandise value for all fulfillment orders in a date window, including unshipped statuses. Use this as the denominator for volume, error rate, and revenue; the list endpoint supplies the per-order rows.

Query parameters

start_date string

Filter orders placed on or after this date
end_date string

Filter orders placed on or before this date
status string

Filter to orders with a shipment in this status

Responses

200 application/json

Summary retrieved successfully
Hide response attributes Show response attributes object
- total_orders integer
  
  Number of orders in the window
- order_value_totals object
  
  Merchandise value totals keyed by currency code
  
  Hide order_value_totals attribute Show order_value_totals attribute object
  
  * number(float) Additional properties
- by_status object
  
  Order counts by rolled-up status
  
  Hide by_status attribute Show by_status attribute object
  
  * integer Additional properties
422 application/json

Invalid date filter
Hide response attribute Show response attribute object
- errors array[string]

GET /v1/orders/summary

curl \
 --request GET 'https://api.pattern.com/hub/v1/orders/summary' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "total_orders": 42,
  "order_value_totals": {
    "additionalProperty1": 42.0,
    "additionalProperty2": 42.0
  },
  "by_status": {
    "additionalProperty1": 42,
    "additionalProperty2": 42
  }
}

Response examples (422)

{
  "errors": [
    "string"
  ]
}