Return volume

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/returns/volume

Bearer auth

Returned unit and order counts for the authenticated organization, including a daily series. Combines Pattern warehouse returns with Amazon FBA returns (amazon_returns).

Query parameters

start_date string

ISO date (YYYY-MM-DD), inclusive. Defaults to 30 days before end_date when omitted.
end_date string

ISO date (YYYY-MM-DD), inclusive. Defaults to today when omitted.
warehouses[] array

Filter by Pattern warehouse name. When set, Amazon FBA returns are omitted.
vendors[] array

Filter by vendor name among vendors on the authenticated org.

Responses

200 application/json

volume retrieved successfully
Hide response attributes Show response attributes object
- units integer Required
  
  Returned units in the window
- orders integer Required
  
  Distinct returned orders in the window
- series array[object] Required
  
  Daily returned units and orders
  
  Hide series attributes Show series attributes object
  
  date string Required
  
  ISO date (YYYY-MM-DD)
  
  units integer Required
  
  orders integer Required
422 application/json

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

GET /v1/returns/volume

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

Response examples (200)

{
  "units": 42,
  "orders": 42,
  "series": [
    {
      "date": "string",
      "units": 42,
      "orders": 42
    }
  ]
}

Response examples (422)

{
  "errors": [
    "string"
  ]
}