Enabled resource errors field for orders and carts —
Check the use case
LogoLogo
Metrics APIOther APIsChangelog
Getting started
Getting started
  • Welcome to Metrics API
  • Getting started
    • API specification
    • Queries
      • Breakdown
      • Date breakdown
      • Stats
      • Search
    • Filters
    • Analysis
      • FBT
    • Errors
    • Use cases
      • Orders by currency
      • Orders by status and payment status
      • Orders by repeat customer
      • Orders by bundle
      • Orders by shipment status and shipping method name
      • Orders paid with gift cards
      • Orders associated with a specific promotion
      • Number of products per order by country
      • Best-selling products by market
      • Customers that bought a specific product
      • Shipments average time in picking
      • Top 10 spenders by currency
      • Orders by day
      • Returns per year by destination city
      • Refunds by country and currency
      • Latest carts with a specific product from a specific market
      • Orders by resource error code and message
      • Latest archived orders
      • Latest placed orders from customers with specific email domains
      • Frequently bought together products
  • API reference
    • Orders
    • Returns
    • Carts
On this page
  • The problem
  • The solution
  • Try it on Postman
  • Example
  • Similar cases
  1. Getting started
  2. Use cases

Latest archived orders

How to use the Metrics API to get the most recently archived orders

PreviousOrders by resource error code and messageNextLatest placed orders from customers with specific email domains

Last updated 1 year ago

The problem

You want to get the latest 100 orders that have been recently archived, over a selected date and time range, chronologically ordered by date of archival.

The solution

Query

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

Key
Value

limit

100

sort_by

order.archived_at

If you want to focus on some specific information about the carts you're searching for, just fill in the fields array with the list of attributes you want to get in the response.

Filter

Set the desired date and time range using the date_from and date_to keys and add an additional on the field to restrict the related search on carts that contain the desired SKU only:

Attribute
Operator

archived

true

As shown in the example below, use archived_at as the date_field in the if you want the results to count all the orders that were archived in the selected date and time range ( about this).

Example

The following request uses the Metrics API to get the latest archived orders:

curl -g -X POST \
  'https://{{your_domain}}.commercelayer.io/metrics/orders/search' \
  -H 'Accept: application/vnd.api.v1+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -d '{
    "search": {
      "limit": 100,
      "sort": "desc",
      "sort_by": "order.archived_at",
      "fields": [ "order.id", "order.number", "order.archived_at" ]
    },
    "filter": {
      "order": {
        "date_from": "2021-01-01T00:00:00Z",
        "date_to": "2021-12-31T23:59:00Z",
        "date_field": "archived_at",
        "archived": true
      }
    }
  }'

On success, the API responds with a 200 OK status code, returning the requested fields in the data object and additional information alongside pagination in the meta object:

{
  "data": [
    {
      "id": "NrnYhAdVXO",
      "number": "2434779",
      "archived_at": "2021-07-15T15:00:49.154Z"
    },
    {
      "id": "NEBrhvrjRO",
      "number": "2431839",
      "archived_at": "2021-04-16T14:29:29.350Z"
    },
    { ... }
  ],
  "meta": {
    "pagination": {
      "record_count": 123,
      "cursor": "LS0tCi0gJzIwMjEtMTItMzFUMjM6NDE6M=="
    },
    "type": "search",
    "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:

Latest approved returns over a specific period of time
Latest returns shipped from a specific country
Latest placed orders from customer with specific email domains
Latest created carts containing a specific SKU and associated with a specific market
🚀
search query
filter
Try it on Postman
line items
date filter
read more