omnicado-mall-proxy
GET /orders/stats

Returns number of orders for each status within given period of time (in days). Should you not use the days parameter, the method will return data for period of 30 days by default.

Headers

  • X-Application-Name string

Query parameters

  • client_id string Required

    Client identifier

  • days integer

    Default value is 30.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • data object
      Hide data attributes Show data attributes object
      • blocked integer Required

        orders in status blocked

      • open integer Required

        orders in status open

      • shipping integer Required

        orders in status shipping

      • shipped integer Required

        orders in status shipped

      • delivered integer Required

        orders in status delivered

      • cancelled integer Required

        orders in status cancelled

      • returned integer Required

        orders in status returned

      • lost integer Required

        orders in status lost

    • result object
      Hide result attributes Show result attributes object
      • code integer(int)
      • status string
GET /orders/stats 
curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/orders/stats?client_id=yourClientId&client_id=api_token_value \
 -H "X-Application-Name: myApplicationName"
Response examples (200) 
{
  "data": {
    "blocked": 5,
    "open": 8,
    "shipping": 2,
    "shipped": 14,
    "delivered": 52,
    "cancelled": 1,
    "returned": 2,
    "lost": 2
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}
Response examples (200) 
{
  "data": {
    "blocked": 5,
    "open": 8,
    "shipping": 2,
    "shipped": 14,
    "delivered": 52,
    "cancelled": 1,
    "returned": 2,
    "lost": 2
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}