Report Ultimate

GETSales By Category Card

{{magento_base_url}}rest/V1/mpreports/card/salesByCategory

HEADERS

Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS

startDate

2020-03-06

endDate

2020-03-12

compareStartDate

2020-02-28

compareEndDate

2020-03-05

store

Example Request

curl

curl --location -g '{{magento_base_url}}rest/V1/mpreports/card/salesByCategory' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'

200 OK

Example Response

json

{
  "name": "salesByCategory",
  "data": [
    {
      "id_field_name": "id",
      "category_name": "Gear",
      "category_id": "3",
      "product_name": "Push It Messenger Bag",
      "product_id": "14",
      "sku": "24-WB04",
      "order_count": "13",
      "qty_ordered": "14",
      "total": "$662.00",
      "invoiced": "260.0000",
      "discount": "4.9000",
      "tax": "17.1900",
      "refunded": "0.0000",
      "orig_data": null,
      "rate": 100
    },
    {
      "id_field_name": "id",
      "category_name": "Bags",
      "category_id": "4",
      "product_name": "Push It Messenger Bag",
      "product_id": "14",
      "sku": "24-WB04",
      "order_count": "12",
      "qty_ordered": "13",
      "total": "$655.00",
      "invoiced": "253.0000",
      "discount": "0.0000",
      "tax": "17.1900",
      "refunded": "0.0000",
      "orig_data": null,
      "rate": 100
    },
    {
      "id_field_name": "id",
      "category_name": "Collections",
      "category_id": "7",
      "product_name": "Push It Messenger Bag",
      "product_id": "14",
      "sku": "24-WB04",
      "order_count": "8",
      "qty_ordered": "8",
      "total": "$360.00",
      "invoiced": "135.0000",
      "discount": "0.0000",
      "tax": "7.4200",
      "refunded": "0.0000",
      "orig_data": null,
      "rate": 100
    },
    {
      "id_field_name": "id",
      "category_name": "Default Category",
      "category_id": "2",
      "product_name": "Minerva LumaTech&trade; V-Tee",
      "product_id": "1498",
      "sku": "WS08-XS-Blue",
      "order_count": "7",
      "qty_ordered": "7",
      "total": "$218.00",
      "invoiced": "61.0000",
      "discount": "0.0000",
      "tax": "8.7400",
      "refunded": "32.0000",
      "orig_data": null,
      "rate": 100
    },
    {
      "id_field_name": "id",
      "category_name": "Hoodies & Sweatshirts",
      "category_id": "15",
      "product_name": "Hero Hoodie-S-Gray",
      "product_id": "153",
      "sku": "MH07-S-Gray",
      "order_count": "6",
      "qty_ordered": "6",
      "total": "$324.00",
      "invoiced": "0.0000",
      "discount": "0.0000",
      "tax": "0.0600",
      "refunded": "0.0000",
      "orig_data": null,
      "rate": 100
    }
  ]
}

Date

Tue, 10 Mar 2020 08:33:12 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=rl1d9cf8rlr63l5f1fi73ndcsc; expires=Tue, 10-Mar-2020 09:33:12 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

1573

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETSales By Attribute Set Card

{{magento_base_url}}rest/V1/mpreports/card/salesByAttributeSet

HEADERS

Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS

startDate

2020-03-09

endDate

2020-03-10

compareStartDate

2020-03-07

compareEndDate

2020-03-08

website

group

store

Example Request

curl

curl --location -g '{{magento_base_url}}rest/V1/mpreports/card/salesByAttributeSet' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'

200 OK

Example Response

json

{
  "name": "salesByAttributeSet",
  "data": [
    {
      "id_field_name": "id",
      "period_time": "2020-03-02",
      "attribute_set_name": "Bag",
      "attribute_set_id": "15",
      "order_count": "9",
      "qty_ordered": "10",
      "total": "$506.00",
      "invoiced": "253.0000",
      "discount": "0.0000",
      "tax": "17.1600",
      "refunded": "0.0000",
      "orig_data": null,
      "rate": 100
    },
    {
      "id_field_name": "id",
      "period_time": "2020-03-08",
      "attribute_set_name": "Top",
      "attribute_set_id": "9",
      "order_count": "4",
      "qty_ordered": "4",
      "total": "$164.00",
      "invoiced": "0.0000",
      "discount": "0.0000",
      "tax": "0.0000",
      "refunded": "0.0000",
      "orig_data": null,
      "rate": 100
    },
    {
      "id_field_name": "id",
      "period_time": "2020-03-09",
      "attribute_set_name": "Gear",
      "attribute_set_id": "11",
      "order_count": "1",
      "qty_ordered": "1",
      "total": "$7.00",
      "invoiced": "7.0000",
      "discount": "4.9000",
      "tax": "0.0000",
      "refunded": "0.0000",
      "orig_data": null,
      "rate": 100
    },
    {
      "id_field_name": "id",
      "period_time": "2020-03-08",
      "attribute_set_name": "Bottom",
      "attribute_set_id": "10",
      "order_count": "1",
      "qty_ordered": "1",
      "total": "$45.00",
      "invoiced": "0.0000",
      "discount": "0.0000",
      "tax": "3.7100",
      "refunded": "0.0000",
      "orig_data": null,
      "rate": 100
    }
  ]
}

Date

Tue, 10 Mar 2020 07:14:36 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=rl1d9cf8rlr63l5f1fi73ndcsc; expires=Tue, 10-Mar-2020 08:14:36 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

1075

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETSales By Payment Card

{{magento_base_url}}rest/V1/mpreports/card/salesByPayment

HEADERS

Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS

startDate

2020-03-09

endDate

2020-03-10

compareStartDate

2020-03-07

compareEndDate

2020-03-08

website

group

store

Example Request

curl

curl --location -g '{{magento_base_url}}rest/V1/mpreports/card/salesByPayment?startDate=2020-03-09&endDate=2020-03-10&compareStartDate=2020-03-07&compareEndDate=2020-03-08&store=1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'

200 OK

Example Response

json

{
  "name": "salesByPayment",
  "data": [
    {
      "id_field_name": "id",
      "payment_type": "checkmo",
      "order_count": "4",
      "qty_ordered": "5",
      "discount": "-4.9000",
      "tax": "9.7400",
      "shipping": "15.0000",
      "invoiced": "134.8400",
      "refunded": "0.0000",
      "canceled": "0.0000",
      "total": "$234.84",
      "percent": "0.8333",
      "orig_data": null,
      "rate": -44.44
    },
    {
      "id_field_name": "id",
      "payment_type": "braintree",
      "order_count": "1",
      "qty_ordered": "1",
      "discount": "0.0000",
      "tax": "0.0000",
      "shipping": "5.0000",
      "invoiced": "0.0000",
      "refunded": "0.0000",
      "canceled": "0.0000",
      "total": "$50.00",
      "percent": "0.1667",
      "orig_data": null,
      "rate": 100
    }
  ]
}

Date

Tue, 10 Mar 2020 07:33:53 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=rl1d9cf8rlr63l5f1fi73ndcsc; expires=Tue, 10-Mar-2020 08:33:54 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

570

Keep-Alive

timeout=5, max=99

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8

GETSales By Coupon Card

{{magento_base_url}}rest/V1/mpreports/card/salesByCoupon

HEADERS

Content-Type

application/json

Authorization

Bearer {{admin_token}}

PARAMS

startDate

2020-03-09

endDate

2020-03-10

compareStartDate

2020-03-07

compareEndDate

2020-03-08

website

group

store

Example Request

curl

curl --location -g '{{magento_base_url}}rest/V1/mpreports/card/salesByCoupon' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_token}}'

200 OK

Example Response

json

{
  "name": "salesByCoupon",
  "data": [
    {
      "id_field_name": "id",
      "coupon_code": "H20",
      "order_count": "1",
      "qty_ordered": "1",
      "discount": "-4.9000",
      "tax": "0.0000",
      "shipping": "5.0000",
      "invoiced": "7.1000",
      "refunded": "0.0000",
      "canceled": "0.0000",
      "total": "$7.10",
      "orig_data": null,
      "rate": 100
    }
  ]
}

Date

Tue, 10 Mar 2020 07:39:24 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=rl1d9cf8rlr63l5f1fi73ndcsc; expires=Tue, 10-Mar-2020 08:39:24 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

272

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json; charset=utf-8