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

Orders paid with gift cards

How to use the Metrics API to get the total number of orders that were paid using a gift card

PreviousOrders by shipment status and shipping method nameNextOrders associated with a specific promotion

Last updated 11 months ago

The problem

You want to get the total number of orders that were (partially or totally) paid with any gift card, over a selected date and time range.

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

field

order.id

operator

value_count

Filter

Set the desired date and time range using the date_from and date_to keys and add additional on the field to restrict the related computation to paid orders associated with a gift card only:

Attribute
Operator

gift_card

true

payment_statuses

"in": [ "skus" ]

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

Example

The following request uses the Metrics API to get the total number of orders that were paid using any gift card:

curl -g -X POST \
  'https://{{your_domain}}.commercelayer.io/metrics/orders/stats' \
  -H 'Accept: application/vnd.api.v1+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -d '{
    "stats": {
      "field": "order.id",
      "operator": "value_count"
    },
    "filter": {
      "order": {
        "date_from": "2021-01-01T00:00:00Z",
        "date_to": "2021-12-31T23:59:00Z",
        "date_field": "approved_at",
        "gift_card": true,
        "payment_statuses": {
          "in": [ "paid" ]
        }
      }
    }
  }'

On success, the API responds with a 200 OK status code, returning the computed value in the data object and additional information in the meta object:

{
  "data": {
    "value": 1234
  },
  "meta": {
    "type": "stats",
    "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 over a specific period of time
Total number of orders paid with a coupon
Total number of orders paid with a specific coupon code
Total number of orders that triggered a specific promotion
Total number of orders that took more than 5 minutes to be placed
Total number of refunded orders
Total number of returned orders
Total number of orders to which a discount was applied
Total orders with a personalization option
Mixed stats about the number of products per order
Total number of orders containing a specific list of products
Total number of orders with amounts greater than $100
Total number of customers over a specific period of time
Total number of customers who bought a specific product or bundle
Mixed stats about returns that contain more than one product
Total number of pending carts with more than one product
Total amount lost due to potentially abandoned carts over a specific period of time
Total number of pending carts with amount greater than 100€
Shipments average time in picking
🚀
stats query
filters
Try it on Postman
order
date filter
read more