Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Report Pro
Introduction
GET
Bestsellers Card
GET
Sales By Customer Group Card
GET
Stock vs Sold Card
GET
Sales By Location Card
GET
Abandoned Cart Card
GET
Sales By Customers Card
GET
Bestsellers Details
GET
Sales By Customers Details
GET
Sales By Customer Group Details
GET
Sales By Location Details
GET
Stock vs Sold Details
GET
Sales By Product Details

Report Pro

GETBestsellers Card

{{magento_base_url}}rest/V1/mpreports/card/bestsellers
HEADERS
Content-Type

application/json

Authorization

Bearer {{admin_token}}

Example Request
Bestsellers Card
curl
curl --location -g '{{magento_base_url}}rest/V1/mpreports/card/bestsellers?startDate=2020-02-09&endDate=2020-03-09&store=2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'
200 OK
Example Response
json
{
  "name": "bestsellers",
  "data": [
    {
      "period_time": "2020-03-02",
      "product_name": "Push It Messenger Bag",
      "product_id": "14",
      "sku": "24-WB04",
      "item_ordered": "1",
      "product_price": "45.0000",
      "discount": "0.0000",
      "tax": "3.7100",
      "total": "45.0000",
      "cost": "0.0000",
      "profit": "45.0000",
      "margin": "100.00"
    },
    {
      "period_time": "2020-03-08",
      "product_name": "Breathe-Easy Tank-XS-Purple",
      "product_id": "1803",
      "sku": "WT09-XS-Purple",
      "item_ordered": "1",
      "product_price": "34.0000",
      "discount": "0.0000",
      "tax": "0.0000",
      "total": "34.0000",
      "cost": "0.0000",
      "profit": "34.0000",
      "margin": "100.00"
    }
  ]
}
Date

Mon, 09 Mar 2020 10:59:41 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=9f5p8bfjduiducdt0pvdm928tg; expires=Mon, 09-Mar-2020 11:59:41 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

552

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETSales By Customer Group Card

{{magento_base_url}}rest/V1/mpreports/card/salesByCustomerGroup
HEADERS
Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS
startDate

2020-03-09

endDate

2020-03-09

compareStartDate
compareEndDate
store

3

group
website

2

Example Request
Sales By Customer Group Card
curl
curl --location -g '{{magento_base_url}}rest/V1/mpreports/card/salesByCustomerGroup' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'
200 OK
Example Response
json
{
  "name": "salesByCustomerGroup",
  "data": {
    "chartData": {
      "labels": [
        "General",
        "Retailer",
        "NOT LOGGED IN",
        "Wholesale"
      ],
      "data": {
        "data": [
          "560.9000",
          "128.0000",
          "100.0000",
          "98.0000"
        ]
      },
      "compareData": {
        "data": [
          0,
          0,
          0,
          0
        ]
      },
      "total": "<span class=\"price\">$886.90</span> (Total)",
      "rate": 0,
      "yUnit": {
        "pattern": "$%s",
        "precision": 2,
        "requiredPrecision": 2,
        "decimalSymbol": ".",
        "groupSymbol": ",",
        "groupLength": 3,
        "integerRequired": false
      },
      "isCompare": "1",
      "label": [
        "2020-02-09 to 2020-03-09",
        "2020-01-10 to 2020-02-08"
      ]
    }
  }
}
Date

Tue, 10 Mar 2020 03:31:37 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=cjmklu1fkarqd28j4mirrg6657; expires=Tue, 10-Mar-2020 04:31:37 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

493

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETStock vs Sold Card

{{magento_base_url}}rest/V1/mpreports/card/stockvsSold
HEADERS
Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS
startDate

2020-03-03

endDate

2020-03-09

compareStartDate

2020-02-25

compareEndDate

2020-03-02

store

3

group
website

2

Example Request
Stock vs Sold Card
curl
curl --location -g '{{magento_base_url}}rest/V1/mpreports/card/stockvsSold' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'
200 OK
Example Response
json
{
  "name": "stockvsSold",
  "data": [
    {
      "id_field_name": "id",
      "product_name": "Fusion Backpack",
      "product_id": "6",
      "sku": "24-MB02",
      "stock_qty": "100",
      "item_ordered": "8",
      "manage_stock": "1",
      "orig_data": null,
      "out_of_stock_estimate": "2021-03-07"
    },
    {
      "id_field_name": "id",
      "product_name": "Push It Messenger Bag",
      "product_id": "14",
      "sku": "24-WB04",
      "stock_qty": "97",
      "item_ordered": "15",
      "manage_stock": "1",
      "orig_data": null,
      "out_of_stock_estimate": "2020-09-13"
    },
    {
      "id_field_name": "id",
      "product_name": "Hero Hoodie-S-Gray",
      "product_id": "153",
      "sku": "MH07-S-Gray",
      "stock_qty": "100",
      "item_ordered": "4",
      "manage_stock": "1",
      "orig_data": null,
      "out_of_stock_estimate": "2022-03-05"
    },
    {
      "id_field_name": "id",
      "product_name": "Argus All-Weather Tank-L-Gray",
      "product_id": "698",
      "sku": "MT07-L-Gray",
      "stock_qty": "100",
      "item_ordered": "1",
      "manage_stock": "1",
      "orig_data": null,
      "out_of_stock_estimate": "2028-02-17"
    },
    {
      "id_field_name": "id",
      "product_name": "Breathe-Easy Tank-XS-Purple",
      "product_id": "1803",
      "sku": "WT09-XS-Purple",
      "stock_qty": "100",
      "item_ordered": "1",
      "manage_stock": "1",
      "orig_data": null,
      "out_of_stock_estimate": "2028-02-17"
    }
  ]
}
Date

Tue, 10 Mar 2020 03:31:45 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=cjmklu1fkarqd28j4mirrg6657; expires=Tue, 10-Mar-2020 04:31:45 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

1084

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETSales By Location Card

{{magento_base_url}}rest/V1/mpreports/card/salesByLocation
HEADERS
Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS
startDate

2020-03-09

endDate

2020-03-09

compareStartDate

2020-02-25

compareEndDate

2020-03-02

store

2

group
website

2

Example Request
Sales By Location Card
curl
curl --location -g '{{magento_base_url}}rest/V1/mpreports/card/salesByLocation' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'
200 OK
Example Response
json
{
  "name": "salesByLocation",
  "data": {
    "chartData": {
      "labels": [
        "United States",
        "Thailand",
        "Vietnam",
        "Uganda",
        "Turkey",
        "Other"
      ],
      "data": {
        "data": [
          6,
          3,
          3,
          1,
          1,
          2
        ]
      },
      "compareData": {
        "data": [
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      "total": "%s (Orders)",
      "rate": 0,
      "isCompare": "1",
      "label": [
        "2020-02-09 to 2020-03-09",
        "2020-01-10 to 2020-02-08"
      ]
    }
  }
}
Date

Tue, 10 Mar 2020 03:31:59 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=cjmklu1fkarqd28j4mirrg6657; expires=Tue, 10-Mar-2020 04:31:59 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

301

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8