Breakdown

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://docs.maddenanalytics.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Madden Analytics API MCP server": {
    "url": "https://docs.maddenanalytics.com/mcp"
  }
}

GET /v2/api/planning/breakdown

Bearer

Returns current stock and unbounded confirmed-PO, draft-PO and sales-plan backlog volumes for active-planning SKUs, grouped by a product dimension, plus the earliest confirmed-or-draft PO delivery and departure dates still incoming per group. Date-window filtering (fromDate/toDate) is not supported on this endpoint — see /breakdown/by-warehouse or /sales-plans for date-windowed, prorated volumes. Period grouping is not supported. The standard product-filter query params (departments, genders, collections, colors, subcategories, productTypes, merchandiseTypes, pimCustom1-10) are also accepted in addition to those listed below.

Query parameters

groupBy string

Dimension to group by: seasons (default), products, variants, skus
seasons string

Season filter, e.g. SS26
variants string

Variant group ID filter
products string

Product group ID filter
skus string

SKU filter, repeatable (e.g. ?skus=abc&skus=def)
skuIds string

SKU ID filter, repeatable
brands string

Brand ID filter, repeatable
categories string

Category ID filter, repeatable
sizes string

Size filter, repeatable
skuStatus string

SKU status filter, repeatable. Defaults to all non-inactive statuses.
activePlanning boolean

Restrict to active-planning SKUs. Defaults to true.
updatedSince string

Only return groups whose PO, draft-PO or sales-plan data was modified at or after this timestamp (RFC3339, or YYYY-MM-DD interpreted as account-local midnight). Stock-only changes are not tracked.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- draftPOVolume number
  
  Draft PO volume, regardless of delivery date
- firstDepartureDate string
  
  Earliest departure date (revised, else original, for confirmed POs) still incoming behind poVolume and draftPOVolume; null when nothing incoming has a departure date.
- firstIncomingDate string
  
  Earliest delivery date still incoming behind poVolume and draftPOVolume; null when neither has anything incoming.
- groupKey string
  
  Value of the groupBy dimension (e.g. "SS26")
- plannedQuantity number
  
  Sum of confirmed PO volume and draft PO volume
- poVolume number
  
  Confirmed PO volume not yet received, regardless of delivery date
- salesPlanVolume number
  
  Full sales-plan (account forecast) volume, regardless of delivery window. For per-(SKU, segment) rows with classifications, or to window/prorate by date, use the /sales-plans endpoint.
- stockVolume number
  
  Current sellable warehouse stock (physical or available, per account setting)
400 application/json

Bad Request
Hide response attributes Show response attributes object
- error string
- message string
- statusCode integer
default application/json
Hide response attributes Show response attributes object
- error string
- message string
- statusCode integer

GET /v2/api/planning/breakdown

curl \
 --request GET 'https://api.maddenanalytics.com/v2/api/planning/breakdown' \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "draftPOVolume": 42.0,
    "firstDepartureDate": "2025-12-01",
    "firstIncomingDate": "2026-01-15",
    "groupKey": "string",
    "plannedQuantity": 42.0,
    "poVolume": 42.0,
    "salesPlanVolume": 42.0,
    "stockVolume": 42.0
  }
]

Response examples (400)

{
  "error": "Error Type (if any)",
  "message": "Message describing the error",
  "statusCode": 400
}

Response examples (default)

{
  "error": "Error Type (if any)",
  "message": "Message describing the error",
  "statusCode": 400
}