How to access data for reporting with GraphQL

In this article, we explain how you can find the data you need for reporting. Specifically you’ll learn:

• What data is available for reporting
• Definitions of the data
• The GQL objects and variables that the data can be found in
• Basic formulas to combine data

Marketplacer contains hundreds of GQL objects and variables that are accessible to operators. A mapping of these can be found here. Most data an operator would use to report on the day-to-day operations of the marketplace is contained in the 99 fields of the All Sales Report in the operator portal. The All Sales Report is Marketplacer’s most comprehensive report available in the platform, containing 99 fields of data about customer orders. For the purposes of this article, we will use these fields as a basis for the information to retrieve from GQL. 

All Sales Report and Associated GQL Endpoints

The following table gives a full list of all the data that can be found in Marketplacer’s All Sales Report and the associated objects and variables to use to retrieve the data through GQL.

Other considerations

Each All Sales Report looks different depending on the fields the operator has selected, in addition In addition to the country the marketplace is set up in, the currency that is being used, the configuration of the individual marketplace and which fields are selected as visible. However, the GQL endpoints are available to all operators, regardless of their UI setup.

Example queries

Full discussion on querying with GraphQL is outside the scope of this article, there are some good learning resources on the official GraphQL site if you’ve not worked with GraphQL before. Especially important to be familiar with is how to order.

This section provides some example queries that contain information found in the All Sales Report.

Postman collection

Our Postman collection contains many more query and mutation examples for your use. You can download the collection here.

Example 1: Basic Invoices Query

This query returns basic information for the invoices on the marketplace. You’ll be able to see information about the line items on the invoice, when the seller states the items were dispatched, and when the invoices were created in Marketplacer.

query {
  invoices {
    pageInfo {
        hasNextPage
        endCursor
      }
    edges{
      node{
        id
        legacyId
        createdAt
        updatedAt
        order{
          updatedAt
          id
        }
        statusFlags
        lineItems{
          id
          variantId
          variantSku
          variantBarcode
          variantName
           totalCents
        }
        shipments{
          id
          dispatchedAt
          shippedItems{
            id
            lineItem{
              id
              advertTitle
            }
          }
        }
      }
    }
  }
}

Example 2: Detailed Invoice Query

This query gives more detailed information about each invoice, including detailed financial information like shipping cost, refund amounts, and commission amounts. The majority of the fields contained in the above table are present in this query.

query {
  invoices {
    pageInfo {
      hasNextPage
      endCursor
    }
    edges {
      node {
        legacyId
        id
        totalCents
        shippingCostCents
        subtotalCents
        legacyId
        createdAt
        updatedAt
        statusFlags
        remittedAt
        lineItems {
          commissionAmountCents
     postageCents
     itemAmountCents
          id
        }
        annotations {
          id
          createdAt
          invoiceAnnotationType {
            id
            createdAt
          }
        }
        seller {
          businessName
          accountName
          accountCode
          address {
            address
            city
            country {
              code
            }
            postcode
            state {
              short
            }
          }
        }
        order {
          id
          legacyId
          status
          firstName
          surname
          emailAddress
          phone
          companyName
          metadata {
            key
            value
            updatedAt
          }
          address {
            address
            city
            state {
              short
            }
            country {
              code
            }
          }
        }
       lineItems {
          id
          metadata {
            key
            value
          }
          advertLegacyId
          advertTitle
          variantName
          variantSku
          variantBarcode
          variant {
            barcode
          }
          shipments {
            carrier
            dispatchedAt
            trackingNumber
            trackingLink
          }
          inventory {
            seller {
              address {
                address
              }
            }
          }
          totalCents
          subtotalCents
          postageCents
          commissionAmountCents
          quantity
        }
        amendments {
          id
          remittanceCents
          lineItems {
            id
          }
        }
        refundRequests {
          id
          refundAmountCents
          recoveredAmountCents
          status
          cashAmountCents
          lineItems {
            id
            amountCents
          }
        }
        shipments {
          id
          dispatchedAt
          shippedItems {
            id
            lineItem {
              id
              advertTitle
            }
          }
        }
      }
    }
  }
}

Deprecated functionality

We have now deprecated the following functionality, which is why you are not able to see these fields in GQL:

• Customisation
• Comments
• Reservation number
• Tax rate used
• Coupon used
• Abandonment email
• Abandonment coupon email
• Payment gateways
• Transaction IDs
• Transaction ID links