API Reports

All reports are created using the SKUSavvy GraphQL API. Having knowledge of GraphQL as a query language is useful and encouraged.

• Inventory summaries

• SKU based inventory

• Inventory by bin location

• 1) Search through the docs to find any data and its associated fields. You can search query, mutation, or subscription types of actions

• 2) Query - select this to view all data elements within the SKUSavvy system (focus for this guide)

• 3) Mutation - select this to view all mutations that can be made on data within SKUSavvy (advanced)

• 4) Subscription - subscribe to different events that happen within SKUSavvy and get the response (advanced)

• 5) Write your query here, start with something like:

query warehouseID{
  warehouses{
    name
    id
  }
}

• 6) This is for inserting variables and headers into your graphQL queries

• 7) Run the query to retrieve the data from your account

• 8) Data (or syntax errors) shown when the search query is done. Note that for large SKU counts this may take a few seconds

• 9) Different query names create new 'tabs' for each query, you can have each report stored and run when needed

View Results from a Query

When you have results from a query they will show in a format called JSON. This data can easily be converted into a CSV format. Below is a sample of some data being returned from the above query example.

{
  "data": {
    "warehouses": [
      {
        "name": "Rocky Plains",
        "id": "c02ac340-8264-4cf8-83e3-8067caa89ca7"
      },
      {
        "name": "Jericho Fulfillment",
        "id": "288cd87-5f9f-448a-a524-21370fbbbee1"
      },
      {
        "name": "Austin Warehouse",
        "id": "a34p992-c103-4ff4-9afa-5fd175730b12"
      },
      {
        "name": "Savvy Warehouse",
        "id": "56488ad-c1d4-4e4e-bef2-1073aa4443a8"
      }
    ]
  }
}

Convert Query Results into CSV Format

When you have results you can highlight and copy this data. Paste directly into the site below which will generate a CSV file for you.

This report will retrieve each of your products by SKU and show the total quantity available in each of your warehouses.

Copy the following query snippet and paste into the query editor then press the blue 'Play' icon button:

query inventoryReport{
  warehouses{
    quantities{
      variant{
        sku
        inventory{
          warehouse{
            name
          }
          quantity
        }
      }
    }
  }
}

The results from this query will look something like the ones below. You can copy and paste the results from your query directly into the JSON to CSV converter tool.

{
  "data": {
    "warehouses": [
      {
        "quantities": [
          {
            "variant": {
              "sku": "8880081",
              "inventory": [
                {
                  "warehouse": {
                    "name": "Austin Warehouse"
                  },
                  "quantity": 96
                },
                {
                  "warehouse": {
                    "name": "Savvy Warehouse"
                  },
                  "quantity": 3390
                },
                {
                  "warehouse": {
                    "name": "Jericho Fulfillment"
                  },
                  "quantity": 18
                },
                {
                  "warehouse": {
                    "name": "Rocky Plains"
                  },
                  "quantity": 0
                }
              ]
            }
          }
        ]
      },
      {
        "quantities": [
          {
            "variant": {
              "sku": "GetItStack",
              "inventory": [
                {
                  "warehouse": {
                    "name": "Savvy Warehouse"
                  },
                  "quantity": 1993
                },
                {
                  "warehouse": {
                    "name": "Jericho Fulfillment"
                  },
                  "quantity": 1000
                }
              ]
            }
          }
        ]
      }
    ]
  }
}