Sales Plans

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/sales-plans

Bearer

Returns account sales-plan volumes per (SKU, segment) with product-hierarchy fields and classification metadata. Results are filtered to account-visible subsegments, matching the data shown in the Madden planning UI. fromDate/toDate are optional: when provided only forecasts whose delivery window overlaps the range are included and volumes are prorated by the overlap fraction; when omitted, all forecasts are returned at full volume. Sales-plan data has no warehouse dimension — use /breakdown for warehouse-level breakdowns.

Query parameters

fromDate string

Start of delivery-window filter (YYYY-MM-DD, optional)
toDate string

End of delivery-window filter (YYYY-MM-DD, optional)
channel string

Filter by channel: D2C or B2B. Omit to include all channels.
updatedSince string

Only return forecasts modified at or after this timestamp (RFC3339, or YYYY-MM-DD interpreted as account-local midnight)
seasons string

Season filter, repeatable
variants string

Variant group ID filter
products string

Product group ID filter
skus string

SKU filter, repeatable
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. Defaults to all non-inactive statuses.
activePlanning boolean

Restrict to active-planning SKUs. Defaults to true.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- classifications object
  
  All keys starting with "classification" from the SKU's custom_fields and external_attributes blobs. external_attributes takes precedence on collision.
  
  Additional properties are allowed.
- productGroupId string
- salesPlanVolume number
  
  Account-forecast volume. Prorated by the overlap fraction when fromDate/toDate are provided (delivery window intersected with the query range); full forecast volume when no date filter is given. The /breakdown endpoint exposes the same underlying data aggregated to a product-hierarchy groupBy dimension.
- season string
- segmentId string
  
  Segment the forecast belongs to.
- segmentName string
- sku string
- skuId integer
- variantGroupId string
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/sales-plans

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

Response examples (200)

[
  {
    "classifications": {},
    "productGroupId": "string",
    "salesPlanVolume": 42.0,
    "season": "string",
    "segmentId": "string",
    "segmentName": "string",
    "sku": "string",
    "skuId": 42,
    "variantGroupId": "string"
  }
]

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
}