Get Orders using Shopify API

A python app for getting orders in a store using the Shopify API. The python FastAPI is used for making the API call. The app requires a SHOPIFY_ADMIN_API_TOKEN and "orders" scope permissions to authenticate requests. This app can be customized to get all orders by name, by order ID (order number), fulfilled orders only and so on.

Introduction to the Shopify API Get Orders Template

This template helps you create a Python application using FastAPI to retrieve orders from a Shopify store. The app requires a SHOPIFY_ADMIN_API_TOKEN to authenticate requests.

Clicking Start with this Template

To get started with this template, click the "Start with this Template" button.

Initial Setup

This template requires setting up environment secrets. Follow these steps to configure the necessary environment secrets:

1. SHOPIFY_STORE_URL: This is the URL of your Shopify store. You can find this in your Shopify admin dashboard.
2. SHOPIFY_ADMIN_API_TOKEN: This token is required to authenticate API requests. Follow these steps to get your API token:
3. Log in to your Shopify admin dashboard.
4. Go to Apps.
5. Click on Manage private apps.
6. Create a new private app or use an existing one.
7. Under Admin API, ensure you have the necessary permissions to read orders.
8. Copy the Admin API access token.

In the Lazy Builder, navigate to the Environment Secrets tab and add the following secrets: - SHOPIFY_STORE_URL - SHOPIFY_ADMIN_API_TOKEN

Test

Press the "Test" button to deploy the app. The Lazy CLI will handle the deployment process.

Using the App

Once the app is deployed, you will be provided with a server link through the Lazy builder CLI. You can use this link to interact with the API. Additionally, since the app uses FastAPI, you will also receive a link to the automatically generated API documentation.

Integrating the App

To retrieve orders from your Shopify store, you can use the provided API endpoint. Below is a sample request and response:

Sample Request


GET /orders
Host: [Your Lazy App Server Link]
Content-Type: application/json
X-Shopify-Access-Token: [Your SHOPIFY_ADMIN_API_TOKEN]


Sample Response


{
    "orders": [
        {
            "id": 123456789,
            "email": "customer@example.com",
            "created_at": "2023-10-01T12:34:56-04:00",
            "total_price": "100.00",
            "currency": "USD",
            "line_items": [
                {
                    "id": 987654321,
                    "title": "Sample Product",
                    "quantity": 1,
                    "price": "100.00"
                }
            ]
        }
    ]
}


You can integrate this API endpoint into your existing systems or tools to automate order retrieval from your Shopify store.