Dummy Shipping App

Example app that connects to third-party Shipping API and works with Saleor.

Introduction

This app is an example of how to integrate with the Saleor shipping API. The diagram below illustrates the flow of requests:

sequenceDiagram
    Customer->>+Saleor: checkoutCreate
    Saleor->>+Shipping App: ShippingListMethodsForCheckout
    Shipping App-->>-Saleor: getInitialShippingMethodsForCheckout
    Saleor-->>-Customer: shippingMethods
    Customer->>+Saleor: checkoutDeliveryMethodUpdate
    Saleor->>+Shipping App: ShippingListMethodsForCheckout
    Shipping App-->>-Saleor: getShippingMethodsForAddressForCheckout
    Saleor-->>-Customer: shippingMethods
    Customer->>+Saleor: checkoutComplete
    Saleor->>+Shipping App: OrderCreated
    Shipping App-->>-Saleor: setShippingMethodForOrder

Subscriptions

ShippingListMethodsForCheckout

You can use the third-party API to request shipping methods for a given checkout session. Since a checkout can be created with or without a shipping address, you may need additional logic for these two scenarios. For more information, refer to the documentation.

OrderCreated

Used to tell third-party API that checkout session is completed and order with shipping method is created. Docs

Mutations

Standard flow for storefront:

checkoutCreate. Creates checkout with shipping address.
checkoutDeliveryMethodUpdate. Select delivery method.
checkoutComplete. Completes checkout and creates an order.

How to test whole flow?

Configure your dashboard channel to Allow unpaid orders
Run app in development mode
Send requests via Bruno

Development

Requirements

Before you start, make sure you have installed:

Node.js
pnpm
Saleor CLI - optional, but recommended
Bruno - for API calls

With CLI

The easiest way to set up a Saleor app is by using the Saleor CLI.

Saleor CLI is designed to save you from the repetitive chores around Saleor development, including creating Apps. It will take the burden of spawning new apps locally, connecting them with Saleor environments, and establishing a tunnel for local development in seconds.

Full Saleor CLI reference

If you don't have a (free developer) Saleor Cloud account, create one with the following command:

saleor register

You will also have to login with:

saleor login

Now you're ready to create your first App:

saleor app template [your-app-name]

In this step, Saleor CLI will:

clone this repository to the specified folder
install dependencies
ask you whether you'd like to install the app in the selected Saleor environment
create .env file
start the app in development mode

Having your app ready, the final thing you want to establish is a tunnel with your Saleor environment. Go to your app's directory first and run:

saleor app tunnel

Your local application should be available now to the outside world (Saleor instance) for accepting all the events via webhooks.

A quick note: the next time you come back to your project, it is enough to launch your app in a standard way (and then launch your tunnel as described earlier):

pnpm dev

Without CLI

Install the dependencies by running:

pnpm install

Start the local server with:

pnpm dev

Expose local environment using tunnel: Use tunneling tools like localtunnel or ngrok.
Install the application in your dashboard:

If you use Saleor Cloud or your local server is exposed, you can install your app by following this link:

[YOUR_SALEOR_DASHBOARD_URL]/apps/install?manifestUrl=[YOUR_APP_TUNNEL_MANIFEST_URL]

This template host manifest at /api/manifest

You can also install application using GQL or command line. Follow the guide how to install your app to learn more.

Generated schema and typings

Commands build and dev would generate schema and typed functions using Saleor's GraphQL endpoint. Commit the generated folder to your repo as they are necessary for queries and keeping track of the schema changes.

Learn more about GraphQL code generation.

Storing registration data - APL

During the registration process, Saleor API passes the auth token to the app. With this token App can query Saleor API with privileged access (depending on requested permissions during the installation). To store this data, app-template use a different APL interfaces.

The choice of the APL is made using the APL environment variable. If the value is not set, FileAPL is used. Available choices:

file: no additional setup is required. Good choice for local development. It can't be used for multi tenant-apps or be deployed (not intended for production)
upstash: use Upstash Redis as storage method. Free account required. It can be used for development and production and supports multi-tenancy. Requires UPSTASH_URL and UPSTASH_TOKEN environment variables to be set

If you want to use your own database, you can implement your own APL. Check the documentation to read more.

Running Bruno

If you have your application up and running inside Saleor Dashboard now its time to run GraphQL mutations. To get started you need:

Create .env inside bruno folder based on .env.example
Fill the needed env variables
Open Bruno and send request in sequence they are defined to make full checkout flow

krzysztofzuraw/dummy-shipping-app