Orders by shipment status and shipping method name

How to use the Metrics API to get the total number of orders of your organization, grouped by the associated shipment status and the related shipping method name

The problem

You want to get the total number of orders over a selected date and time range, grouped by the status of the associated shipments. For each shipment status, you also want to group the results by the related shipping method name.

The solution

Query

You need to perform a breakdown query setting the required query keys as follows and adding the optional ones based on your needs:

Key	Value
by	shipments.status
field	order.id
operator	value_count

You also need to add a nested breakdown setting the related query keys as follows:

Key	Value
by	shipments.shipping_method.name
field	order.id
operator	value_count

Filter

Make sure to set the desired date and time range using the date_from and date_to keys in the filter.

In the example below, since the date_field isn't specified in the date filter, the default value current_date will be used, meaning that the results will count all the orders that changed their status within the selected date and time range (read more about this).

Try it on Postman 🚀

Example

Request

The following request uses the Metrics API to get the total number of orders, grouped by the associated shipment status and the related shipping method name:

curl -g -X POST \
  'https://{{your_domain}}.commercelayer.io/metrics/orders/breakdown' \
  -H 'Accept: application/vnd.api.v1+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -d '{
    "breakdown": {
      "by": "shipments.status",
      "field": "order.id",
      "operator": "value_count",
      "limit": 10,
      "breakdown": {
        "by": "shipments.shipping_method.name",
        "field": "order.id",
        "operator": "value_count",
        "limit": 5
      }
    },
    "filter": {
      "order": {
        "date_from": "2021-01-01T00:00:00Z",
        "date_to": "2022-11-31T23:59:00Z"
      }
    }
  }'

Response

On success, the API responds with a 200 OK status code, returning the aggregated, nested values in the data object and extra information in the meta object:

{
  "data": {
    "shipments.status": [
      {
        "label": "shipped",
        "value": 7356,
        "shipments.shipping_method.name": [
          {
            "label": "Standard Delivery",
            "value": 1234
          },
          {
            "label": "Express Delivery",
            "value": 2345
          },
          {
            "label": "Tracked Delivery",
            "value": 3456
          },
          {
            "label": "Premium Fast Delivery",
            "value": 321
          }
        ]
      },
      {
        "label": "picking",
        "value": 8675,
        "shipments.shipping_method.name": [
          {
            "label": "Standard Delivery",
            "value": 4321
          },
          {
            "label": "Express Delivery",
            "value": 3232
          },
          {
            "label": "Tracked Delivery",
            "value": 1122
          }
        ]
      },
      {
        "label": "cancelled",
        "value": 888,
        "shipments.shipping_method.name": [
          {
            "label": "Standard Delivery",
            "value": 123
          },
          {
            "label": "Express Delivery",
            "value": 321
          },
          {
            "label": "Premium Fast Delivery",
            "value": 444
          }
        ]
      },
      {
        "label": "packing",
        "value": 7889,
        "shipments.shipping_method.name": [
          {
            "label": "Standard Delivery",
            "value": 2222
          },
          {
            "label": "Express Delivery",
            "value": 4322
          },
          {
            "label": "Tracked Delivery",
            "value": 1234
          },
          {
            "label": "Premium Fast Delivery",
            "value": 111
          }
        ]
      },
      {
        "label": "upcoming",
        "value": 3290,
        "shipments.shipping_method.name": [
          {
            "label": "Standard Delivery",
            "value": 2345
          },
          {
            "label": "Express Delivery",
            "value": 433
          },
          {
            "label": "Tracked Delivery",
            "value": 500
          },
          {
            "label": "Premium Fast Delivery",
            "value": 12
          }
        ]
      },
      {
        "label": "on_hold",
        "value": 310,
        "shipments.shipping_method.name": [
          {
            "label": "Express Delivery",
            "value": 200
          },
          {
            "label": "Tracked Delivery",
            "value": 100
          },
          {
            "label": "Premium Fast Delivery",
            "value": 10
          }
        ]
      },
      {
        "label": "ready_to_ship",
        "value": 143,
        "shipments.shipping_method.name": [
          {
            "label": "Standard Delivery",
            "value": 55
          },
          {
            "label": "Express Delivery",
            "value": 44
          },
          {
            "label": "Tracked Delivery",
            "value": 33
          },
          {
            "label": "Premium Fast Delivery",
            "value": 11
          }
        ]
      },
      {
        "label": "draft",
        "value": 101,
        "shipments.shipping_method.name": [
          {
            "label": "Standard Delivery",
            "value": 56
          },
          {
            "label": "Express Delivery",
            "value": 45
          }
        ]
      }
    ]
  },
  "meta": {
    "type": "breakdown",
    "trace_id": "fe571ea2-8a4f-4a5e-bd26-ac54651bb2e4",
    "mode": "test",
    "organization_id": "xYZkjABcde",
    "market_ids": [ "yzXKjYzaCx", "..." ]
  }
}

Similar cases

Just changing a couple of query keys and/or filter parameters you can address lots of very similar use cases, such as:

• Total number of orders by market and payment method name
• Average order total amount by currency and country code
• Top 5 best-selling products in the best-selling markets
• Top 5 best-selling countries for the best-selling products
• Top 10 spenders by currencies
• Total number of refunds by country and currency code
• Total number of active returns by market name and return status
• Total number of carts by status and related amount stats by currency code
• Total number of pending carts by customer email and payment method name
• Total number of orders by status and payment status
• Total number of orders by resource errors code and message