Planned Volumes By Warehouse

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

mcp.json 
{
  "Madden Analytics API MCP server": {
    "url": "https://docs.maddenanalytics.com/mcp"
  }
}
Close
GET /v2/api/planning/planned-volumes/by-warehouse
Bearer

Returns stock, confirmed-PO and draft-PO volumes for active-planning SKUs, grouped by a product dimension and warehouse. Draft-PO volume without an assigned warehouse is returned with an empty warehouseId. The whole fromDate–toDate window is returned; 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.

  • fromDate string Required

    Start of PO/draft-PO delivery date window (YYYY-MM-DD)

  • toDate string Required

    End of PO/draft-PO delivery date window (YYYY-MM-DD)

  • updatedSince string

    Only return rows whose PO or draft-PO data was modified 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 with delivery date in the requested date window

    • groupKey string

      Value of the groupBy dimension (e.g. "SS26")

    • poVolume number

      Confirmed PO volume arriving in the requested date window

    • stockVolume number

      Current sellable warehouse stock (physical or available, per account setting)

    • warehouseId string

      Warehouse the volumes belong to. Empty for draft-PO volume not yet assigned to a warehouse.

    • warehouseName 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/planned-volumes/by-warehouse 
curl \
 --request GET 'https://api.maddenanalytics.com/v2/api/planning/planned-volumes/by-warehouse?fromDate=string&toDate=string' \
 --header "Authorization: $API_KEY"
Response examples (200) 
[
  {
    "draftPOVolume": 42.0,
    "groupKey": "string",
    "poVolume": 42.0,
    "stockVolume": 42.0,
    "warehouseId": "string",
    "warehouseName": "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
}