Public
Documentation Settings

Report Ultimate GraphQL

POSTCustomer By Location Card

{{magento_base_url}}graphql
HEADERS
Content-Type

application/json

Example Request
curl
curl --location -g '{{magento_base_url}}graphql' \
--header 'Content-Type: application/json' \
--data '{"query":"query {\r\n\tmpReportsCustomerByLocationCard(\r\n\t\tfilters: {\r\n\t\t\taccessToken: \"d592rvtv8ey3zr9yr2fmmlyrfsusqrvn\"\r\n\t\t\tstore: \"1\"\r\n\t\t\tstartDate: \"2020-03-06\"\r\n\t\t\tendDate: \"2020-03-12\"\r\n\t\t\tcompareStartDate: \"2020-02-28\"\r\n\t\t\tcompareEndDate: \"2020-03-05\"\r\n\t\t}\r\n\t) {\r\n\t\titems {\r\n\t\t\tcountry_id\r\n\t\t\torder_count\r\n\t\t\ttotal_qty_ordered\r\n\t\t\ttotal\r\n\t\t\ttotal_invoiced\r\n\t\t\tsubtotal\r\n\t\t\tdiscount\r\n\t\t\ttax\r\n\t\t\tshipping\r\n\t\t\trefunded\r\n\t\t\tcustomer\r\n\t\t\trate\r\n\t\t}\r\n\t}\r\n}","variables":{}}'
200 OK
Example Response
json
{
  "data": {
    "mpReportsCustomerByLocationCard": {
      "items": [
        {
          "country_id": "US",
          "order_count": "2",
          "total_qty_ordered": "27",
          "total": "$1,570.59",
          "total_invoiced": "127.7400",
          "subtotal": "1338.0000",
          "discount": "0.0000",
          "tax": "107.5900",
          "shipping": "125.0000",
          "refunded": "0.0000",
          "customer": "1",
          "rate": 0
        },
        {
          "country_id": "TR",
          "order_count": "5",
          "total_qty_ordered": "5",
          "total": "$268.40",
          "total_invoiced": "52.2000",
          "subtotal": "267.0000",
          "discount": "-23.6000",
          "tax": "0.0000",
          "shipping": "25.0000",
          "refunded": "0.0000",
          "customer": "1",
          "rate": 100
        },
        {
          "country_id": "TH",
          "order_count": "3",
          "total_qty_ordered": "4",
          "total": "$232.06",
          "total_invoiced": "0.0000",
          "subtotal": "212.0000",
          "discount": "0.0000",
          "tax": "0.0600",
          "shipping": "20.0000",
          "refunded": "0.0000",
          "customer": "2",
          "rate": 100
        },
        {
          "country_id": "VN",
          "order_count": "2",
          "total_qty_ordered": "2",
          "total": "$114.00",
          "total_invoiced": "0.0000",
          "subtotal": "104.0000",
          "discount": "0.0000",
          "tax": "0.0000",
          "shipping": "10.0000",
          "refunded": "0.0000",
          "customer": "2",
          "rate": 100
        },
        {
          "country_id": "TW",
          "order_count": "1",
          "total_qty_ordered": "1",
          "total": "$59.00",
          "total_invoiced": "0.0000",
          "subtotal": "54.0000",
          "discount": "0.0000",
          "tax": "0.0000",
          "shipping": "5.0000",
          "refunded": "0.0000",
          "customer": "1",
          "rate": 100
        }
      ]
    }
  }
}
Date

Thu, 12 Mar 2020 02:20:41 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Tue, 12 Mar 2019 02:20:41 GMT

Cache-Control

max-age=0, must-revalidate, no-cache, no-store

Pragma

no-cache

Set-Cookie

PHPSESSID=74nvsc7s3bdd5gfr0drah9efrm; expires=Thu, 12-Mar-2020 03:20:41 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

Set-Cookie

private_content_version=3373156554998fee1e224d3f7880b313; expires=Sun, 10-Mar-2030 02:20:41 GMT; Max-Age=315360000; path=/

X-Magento-Tags

FPC

X-Content-Type-Options

nosniff

X-XSS-Protection

1; mode=block

X-Frame-Options

SAMEORIGIN

Content-Length

1213

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json

POSTSales By Attribute Set Card

{{magento_base_url}}graphql
HEADERS
Content-Type

application/json

Example Request
curl
curl --location -g --request POST '{{magento_base_url}}graphql' \
--header 'Content-Type: application/json' \
--data '{"variables":{}}'
200 OK
Example Response
json
{
  "data": {
    "mpReportsCustomerByLocationCard": {
      "items": [
        {
          "country_id": "US",
          "order_count": "2",
          "total_qty_ordered": "27",
          "total": "$1,570.59",
          "total_invoiced": "127.7400",
          "subtotal": "1338.0000",
          "discount": "0.0000",
          "tax": "107.5900",
          "shipping": "125.0000",
          "refunded": "0.0000",
          "customer": "1",
          "rate": 0
        },
        {
          "country_id": "TR",
          "order_count": "5",
          "total_qty_ordered": "5",
          "total": "$268.40",
          "total_invoiced": "52.2000",
          "subtotal": "267.0000",
          "discount": "-23.6000",
          "tax": "0.0000",
          "shipping": "25.0000",
          "refunded": "0.0000",
          "customer": "1",
          "rate": 100
        },
        {
          "country_id": "TH",
          "order_count": "3",
          "total_qty_ordered": "4",
          "total": "$232.06",
          "total_invoiced": "0.0000",
          "subtotal": "212.0000",
          "discount": "0.0000",
          "tax": "0.0600",
          "shipping": "20.0000",
          "refunded": "0.0000",
          "customer": "2",
          "rate": 100
        },
        {
          "country_id": "VN",
          "order_count": "2",
          "total_qty_ordered": "2",
          "total": "$114.00",
          "total_invoiced": "0.0000",
          "subtotal": "104.0000",
          "discount": "0.0000",
          "tax": "0.0000",
          "shipping": "10.0000",
          "refunded": "0.0000",
          "customer": "2",
          "rate": 100
        },
        {
          "country_id": "TW",
          "order_count": "1",
          "total_qty_ordered": "1",
          "total": "$59.00",
          "total_invoiced": "0.0000",
          "subtotal": "54.0000",
          "discount": "0.0000",
          "tax": "0.0000",
          "shipping": "5.0000",
          "refunded": "0.0000",
          "customer": "1",
          "rate": 100
        }
      ]
    }
  }
}
Date

Thu, 12 Mar 2020 02:20:41 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Tue, 12 Mar 2019 02:20:41 GMT

Cache-Control

max-age=0, must-revalidate, no-cache, no-store

Pragma

no-cache

Set-Cookie

PHPSESSID=74nvsc7s3bdd5gfr0drah9efrm; expires=Thu, 12-Mar-2020 03:20:41 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

Set-Cookie

private_content_version=3373156554998fee1e224d3f7880b313; expires=Sun, 10-Mar-2030 02:20:41 GMT; Max-Age=315360000; path=/

X-Magento-Tags

FPC

X-Content-Type-Options

nosniff

X-XSS-Protection

1; mode=block

X-Frame-Options

SAMEORIGIN

Content-Length

1213

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json

POSTSales By Category Card

{{magento_base_url}}graphql
HEADERS
Content-Type

application/json

Example Request
curl
curl --location -g '{{magento_base_url}}graphql' \
--header 'Content-Type: application/json' \
--data '{"query":"query {\r\n\tmpReportsSalesByCategoryCard(\r\n\t\tfilters: {\r\n\t\t\taccessToken: \"d592rvtv8ey3zr9yr2fmmlyrfsusqrvn\"\r\n\t\t\tstore: \"1\"\r\n\t\t\tstartDate: \"2020-03-06\"\r\n\t\t\tendDate: \"2020-03-12\"\r\n\t\t\tcompareStartDate: \"2020-02-28\"\r\n\t\t\tcompareEndDate: \"2020-03-05\"\r\n\t\t}\r\n\t) {\r\n\t\titems {\r\n\t\t\tcategory_name\r\n\t\t\tcategory_id\r\n\t\t\tproduct_name\r\n\t\t\tproduct_id\r\n\t\t\tsku\r\n\t\t\torder_count\r\n\t\t\tqty_ordered\r\n\t\t\ttotal\r\n\t\t\tinvoiced\r\n\t\t\tdiscount\r\n\t\t\ttax\r\n\t\t\trefunded\r\n\t\t\trate\r\n\t\t}\r\n\t}\r\n}","variables":{}}'
200 OK
Example Response
json
{
  "data": {
    "mpReportsSalesByCategoryCard": {
      "items": [
        {
          "category_name": "Gear",
          "category_id": "3",
          "product_name": "Push It Messenger Bag",
          "product_id": "14",
          "sku": "24-WB04",
          "order_count": "35",
          "qty_ordered": "37",
          "total": "$1,811.00",
          "invoiced": "184.0000",
          "discount": "28.5000",
          "tax": "103.1600",
          "refunded": "0.0000",
          "rate": 3600
        },
        {
          "category_name": "Bags",
          "category_id": "4",
          "product_name": "Push It Messenger Bag",
          "product_id": "14",
          "sku": "24-WB04",
          "order_count": "25",
          "qty_ordered": "27",
          "total": "$1,271.00",
          "invoiced": "177.0000",
          "discount": "23.6000",
          "tax": "59.1900",
          "refunded": "0.0000",
          "rate": 2600
        },
        {
          "category_name": "Collections",
          "category_id": "7",
          "product_name": "Push It Messenger Bag",
          "product_id": "14",
          "sku": "24-WB04",
          "order_count": "16",
          "qty_ordered": "16",
          "total": "$787.00",
          "invoiced": "0.0000",
          "discount": "0.0000",
          "tax": "46.3600",
          "refunded": "0.0000",
          "rate": 1500
        },
        {
          "category_name": "Watches",
          "category_id": "6",
          "product_name": "Aim Analog Watch",
          "product_id": "36",
          "sku": "24-MG04",
          "order_count": "9",
          "qty_ordered": "9",
          "total": "$533.00",
          "invoiced": "0.0000",
          "discount": "0.0000",
          "tax": "43.9700",
          "refunded": "0.0000",
          "rate": 100
        },
        {
          "category_name": "Hoodies & Sweatshirts",
          "category_id": "15",
          "product_name": "Hero Hoodie-S-Gray",
          "product_id": "153",
          "sku": "MH07-S-Gray",
          "order_count": "8",
          "qty_ordered": "8",
          "total": "$432.00",
          "invoiced": "0.0000",
          "discount": "0.0000",
          "tax": "8.9800",
          "refunded": "0.0000",
          "rate": 100
        }
      ]
    }
  }
}
Date

Thu, 12 Mar 2020 02:34:59 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Tue, 12 Mar 2019 02:34:59 GMT

Cache-Control

max-age=0, must-revalidate, no-cache, no-store

Pragma

no-cache

Set-Cookie

PHPSESSID=74nvsc7s3bdd5gfr0drah9efrm; expires=Thu, 12-Mar-2020 03:34:59 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

Set-Cookie

private_content_version=374915d71f143a88c479a0d9d110e733; expires=Sun, 10-Mar-2030 02:34:59 GMT; Max-Age=315360000; path=/

X-Magento-Tags

FPC

X-Content-Type-Options

nosniff

X-XSS-Protection

1; mode=block

X-Frame-Options

SAMEORIGIN

Content-Length

1382

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json

POSTSales By Coupon Card

{{magento_base_url}}graphql
HEADERS
Content-Type

application/json

Example Request
curl
curl --location -g '{{magento_base_url}}graphql' \
--header 'Content-Type: application/json' \
--data '{"query":"query {\r\n\tmpReportsSalesByCouponCard(\r\n\t\tfilters: {\r\n\t\t\taccessToken: \"d592rvtv8ey3zr9yr2fmmlyrfsusqrvn\"\r\n\t\t\tstore: \"1\"\r\n\t\t\tstartDate: \"2020-03-06\"\r\n\t\t\tendDate: \"2020-03-12\"\r\n\t\t\tcompareStartDate: \"2020-02-28\"\r\n\t\t\tcompareEndDate: \"2020-03-05\"\r\n\t\t}\r\n\t) {\r\n\t\titems {\r\n\t\t\tcoupon_code\r\n\t\t\torder_count\r\n\t\t\tqty_ordered\r\n\t\t\tdiscount\r\n\t\t\ttax\r\n\t\t\tshipping\r\n\t\t\tinvoiced\r\n\t\t\trefunded\r\n\t\t\tcanceled\r\n\t\t\ttotal\r\n\t\t\trate\r\n\t\t}\r\n\t}\r\n}","variables":{}}'
200 OK
Example Response
json
{
  "data": {
    "mpReportsSalesByCouponCard": {
      "items": [
        {
          "coupon_code": "G0T4",
          "order_count": "2",
          "qty_ordered": "2",
          "discount": "-23.6000",
          "tax": "0.0000",
          "shipping": "10.0000",
          "invoiced": "52.2000",
          "refunded": "0.0000",
          "canceled": "0.0000",
          "total": "$104.40",
          "rate": 100
        },
        {
          "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",
          "rate": 100
        }
      ]
    }
  }
}
Date

Thu, 12 Mar 2020 02:48:39 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Tue, 12 Mar 2019 02:48:39 GMT

Cache-Control

max-age=0, must-revalidate, no-cache, no-store

Pragma

no-cache

Set-Cookie

PHPSESSID=74nvsc7s3bdd5gfr0drah9efrm; expires=Thu, 12-Mar-2020 03:48:39 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

Set-Cookie

private_content_version=eba835f268bf645f2939adb380a0512e; expires=Sun, 10-Mar-2030 02:48:39 GMT; Max-Age=315360000; path=/

X-Magento-Tags

FPC

X-Content-Type-Options

nosniff

X-XSS-Protection

1; mode=block

X-Frame-Options

SAMEORIGIN

Content-Length

459

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json

POSTSales By Hours Card

{{magento_base_url}}graphql
HEADERS
Content-Type

application/json

Example Request
curl
curl --location -g '{{magento_base_url}}graphql' \
--header 'Content-Type: application/json' \
--data '{"query":"query {\r\n\tmpReportsSalesByHoursCard(\r\n\t\tfilters: {\r\n\t\t\taccessToken: \"d592rvtv8ey3zr9yr2fmmlyrfsusqrvn\"\r\n\t\t\tstore: \"1\"\r\n\t\t\tstartDate: \"2020-03-06\"\r\n\t\t\tendDate: \"2020-03-12\"\r\n\t\t\tcompareStartDate: \"2020-02-28\"\r\n\t\t\tcompareEndDate: \"2020-03-05\"\r\n\t\t}\r\n\t) {\r\n\t\titems {\r\n\t\t\tperiod_time\r\n\t\t\torder_count\r\n\t\t\tqty_ordered\r\n\t\t\tdiscount\r\n\t\t\ttax\r\n\t\t\tshipping\r\n\t\t\tinvoiced\r\n\t\t\trefunded\r\n\t\t\tcanceled\r\n\t\t\ttotal\r\n\t\t\trate\r\n\t\t}\r\n\t}\r\n}\r\n","variables":{}}'
200 OK
Example Response
json
{
  "data": {
    "mpReportsSalesByHoursCard": {
      "items": [
        {
          "period_time": "20:00",
          "order_count": "1",
          "qty_ordered": "25",
          "discount": "0.0000",
          "tax": "97.8500",
          "shipping": "125.0000",
          "invoiced": "0.0000",
          "refunded": "0.0000",
          "canceled": "0.0000",
          "total": "$1,442.85",
          "rate": 100
        },
        {
          "period_time": "23:00",
          "order_count": "6",
          "qty_ordered": "6",
          "discount": "0.0000",
          "tax": "0.0000",
          "shipping": "30.0000",
          "invoiced": "0.0000",
          "refunded": "0.0000",
          "canceled": "0.0000",
          "total": "$346.00",
          "rate": 100
        },
        {
          "period_time": "22:00",
          "order_count": "4",
          "qty_ordered": "5",
          "discount": "-28.5000",
          "tax": "9.7400",
          "shipping": "15.0000",
          "invoiced": "187.0400",
          "refunded": "0.0000",
          "canceled": "0.0000",
          "total": "$239.24",
          "rate": 100
        },
        {
          "period_time": "03:00",
          "order_count": "1",
          "qty_ordered": "2",
          "discount": "0.0000",
          "tax": "0.0600",
          "shipping": "10.0000",
          "invoiced": "0.0000",
          "refunded": "0.0000",
          "canceled": "0.0000",
          "total": "$123.06",
          "rate": 100
        },
        {
          "period_time": "02:00",
          "order_count": "2",
          "qty_ordered": "2",
          "discount": "0.0000",
          "tax": "0.0000",
          "shipping": "10.0000",
          "invoiced": "0.0000",
          "refunded": "0.0000",
          "canceled": "0.0000",
          "total": "$100.00",
          "rate": 100
        }
      ]
    }
  }
}
Date

Thu, 12 Mar 2020 02:56:41 GMT

Server

Apache/2.4.38 (Ubuntu)

Expires

Tue, 12 Mar 2019 02:56:41 GMT

Cache-Control

max-age=0, must-revalidate, no-cache, no-store

Pragma

no-cache

Set-Cookie

PHPSESSID=74nvsc7s3bdd5gfr0drah9efrm; expires=Thu, 12-Mar-2020 03:56:41 GMT; Max-Age=3600; path=/hang/ce234b; domain=192.168.1.200; HttpOnly

Set-Cookie

private_content_version=2db3872fcef544ce9682bb7caf2fd86b; expires=Sun, 10-Mar-2030 02:56:41 GMT; Max-Age=315360000; path=/

X-Magento-Tags

FPC

X-Content-Type-Options

nosniff

X-XSS-Protection

1; mode=block

X-Frame-Options

SAMEORIGIN

Content-Length

1084

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json