Shopify Custom App Tutorial: Export Order Line Item Properties to CSV

Ever found yourself needing a super specific feature for your Shopify store, only to scour the App Store and come up empty-handed? Or maybe you find an app that does almost what you need, but it comes with a bunch of extra features you don't want, inflating the price or complicating things?

That's exactly the kind of scenario we saw pop up in the community recently. A store owner, michael80000, a seasoned developer themselves (20 years of experience, no less!), asked a brilliant question: "Can I create my own app to fill my need but not put my app in the app store?" They just wanted to export specific data – lineitem.properties from orders – into a CSV or XLS file, and didn't want the hassle of selling or supporting an app for others. Sound familiar?

This is a common dilemma, and thankfully, the community jumped in with some fantastic advice. The consensus? Absolutely, you can! And for a simple, internal tool like a custom data export, it's surprisingly straightforward. Let's dive into how you can do this for your own store, inspired by the expert insights shared.

Your Own Private App: The Smart Solution for Unique Needs

For store owners with a bit of technical know-how, building a custom app just for your store is often the most efficient path. As askably_rod brilliantly put it, "No hosting, no OAuth dance, just an API token and a script." This is key. You're not building a full-blown public app with a fancy UI and complex authentication; you're building a simple script that talks directly to your store's data.

Step-by-Step: Creating Your Custom App in Shopify Admin

The first step is to create what Shopify calls a 'Custom App' directly within your store's admin. This acts as a secure gateway for your script to access your store's data. Here's how:

Log In to Your Shopify Admin: Go to your store's admin panel.
Navigate to App Development: Head to Settings > Apps and sales channels.
Access Develop Apps: Click on Develop apps.
Create a New App: Click the Create an app button. Give it a descriptive name, something like "My Custom Order Export" so you know exactly what it's for.
Configure API Scopes: This is crucial. Your app needs permission to read order data. Click on Configure Admin API scopes. You'll want to enable the read_orders access scope. This grants your app (and your script) permission to pull order information.
Install the App: Once scopes are set, click Install app. Shopify will then provide you with an API access token. Treat this token like gold! It's essentially the password your script will use to talk to your store. Make sure to copy it and store it securely, as you'll only see it once.

And just like that, you've got your custom app set up and an API token ready to go. No App Store submission, no public listing – just a private tool for your needs.

Pulling Your Data: Hitting the GraphQL Admin API

Now for the fun part: writing the script to fetch your data. Since michael80000 specifically wanted lineitem.properties, the GraphQL Admin API is your best friend. It's powerful and lets you precisely request the data you need without over-fetching.

As askably_rod demonstrated, retrieving orders with their custom line item attributes is quite elegant:

{
  orders(first: 50, query: "created_at:>2024-01-01") {
    edges {
      node {
        id
        name
        createdAt
        lineItems(first: 50) {
          edges {
            node {
              title
              quantity
              customAttributes {
                key
                value
              }
            }
          }
        }
      }
    }
  }
}

A quick note on that query: customAttributes on LineItem is the GraphQL equivalent of what you might know as lineitem.properties in Liquid. So, this query will fetch up to 50 orders created after January 1st, 2024, and for each order, it will get the ID, name, creation date, and then for each line item, its title, quantity, and all associated custom attributes (key-value pairs).

Executing Your Query and Exporting to CSV

With your API token and GraphQL query, you can use various tools and languages to execute this. Given michael80000's 20 years of experience, this part would indeed be "sorted in an afternoon"! Here's the general flow:

Choose Your Tool: You can use curl for a quick test or a small script in Python, Node.js, Ruby, or any language you're comfortable with. Even command-line tools like jq can parse the JSON output.
Hit the API Endpoint: Your Shopify store's Admin API GraphQL endpoint will look something like https://YOUR_STORE_NAME.myshopify.com/admin/api/2024-04/graphql.json (replace YOUR_STORE_NAME and adjust the API version as needed).
Include Your Access Token: Remember that API access token? You'll include it in the request header, specifically as X-Shopify-Access-Token: YOUR_API_ACCESS_TOKEN.
Parse and Export: The API will return a JSON response. Your script will need to parse this JSON, navigate through the edges and node structures, extract the relevant data (including those customAttributes), and then format it into a CSV file.

Pro Tip: Before writing a full script, you can test your GraphQL queries directly in the GraphiQL app built into your Shopify admin (under the same Develop apps section for your custom app). This is a fantastic way to experiment and ensure your query fetches exactly what you expect.

Considering Alternatives and Further Development

While the custom script approach is perfect for michael80000's specific need, it's worth noting other options mentioned in the thread:

Full Embedded Apps: If you do eventually need a proper user interface within the Shopify admin, or if you plan to offer your app publicly, then tools like shopify app init from the Shopify CLI (which scaffolds a Remix app with authentication) are the way to go. Shopify's official documentation on building apps is the ultimate starting point for this more complex path, as tim_1 and PaulNewton pointed out.
Shopify Flow: For certain backend automations, Shopify Flow (a free app for eligible plans) can be incredibly powerful. Tim_1 suggested it as an alternative. While Flow can't directly export CSV files, it can process orders and send data to other services like Google Sheets or email, which might serve as a workaround for some data aggregation needs.

Where to Find More Developer-Specific Help

One excellent piece of advice from PaulNewton was to direct developers to the most appropriate community. While the main Shopify community forums are great for merchant-focused discussions, for deep-dive technical questions about app development, the Shopify Developer Community is where you'll find the most concentrated expertise and resources. It's a fantastic place to ask specific coding questions or explore advanced API functionalities.

So, there you have it! Building a private custom app for your Shopify store, especially for targeted data exports, is not only possible but a highly recommended approach for those unique needs that off-the-shelf apps just can't meet. It empowers you to tailor your store's functionality precisely without the overhead of public app development. Happy coding!

Unlock Your Store's Data: How to Build a Private Shopify App for Custom Exports