GET /v1/commerce/orders/metrics

GET/v1/commerce/orders/metrics

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

abandoned_carts_countinteger<int64>required

active_carts_countinteger<int64>required

gmv_7dinteger<int64>required

orders_todayinteger<int64>required

paid_countinteger<int64>required

pending_delivery_countinteger<int64>required

pending_payment_countinteger<int64>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/orders/metrics"

const response = await fetch("/v1/commerce/orders/metrics", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/orders/metrics",
)

Response

{
  "abandoned_carts_count": 0,
  "active_carts_count": 0,
  "gmv_7d": 0,
  "orders_today": 0,
  "paid_count": 0,
  "pending_delivery_count": 0,
  "pending_payment_count": 0
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}