Operation Get Pie Chart Details By Criteria

Method: HTTP GET method

Endpoint: http://<host_address>:<port_address>/v2/orders/pieChartDetails

The required field parameters are given in the following list:

  • orderIds
  • category
    The category can be anything from the following list:  
    • Plan Fragment

    • Order Status

    • Order Line Status

    • Plan Item Status

    • Milestone Status

    • Delivery Postal Code

    • Delivery Locality

    • Delivery Region

    • Order Line Action

Example of GetPieChartDetailsByCriteria:

{
  "orderIds": ["12345", "67890"],
  "category": "Plan Fragment",
  "details": [
    {
      "name": "Fragment A",
      "value": 3
    },
    {
      "name": "Fragment B",
      "value": 2
    }
  ]
}

For the category mentioned here, the output includes:

  • a name representing the actual plan fragment name

  • a value indicating the frequency of that particular plan fragment in the request order list