Storing order data

After finishing this tutorial, you'll know how to do the following:

• Handle webhook events for orders

• Store order data in your database

• You've completed the Merchant onboarding tutorials.

• You're familiar with webhooks.

Your channel app requires the following access scopes:

• read_orders

In this step, you'll create an Orders data table in your schema, with column data reflecting the information you want to store. You'll also run a database migration. For an overview of the available fields for generating your orders model, refer to the Order API reference.

1. Run the following command to create a new migration file:

2. In the newly-generated migration file, add the following code:

3. Create a models/order.js file and add the following code:

4. Run the following to apply the migration and create the new data table:

In this step, you'll create the framework to subscribe to the ORDERS_CREATE webhook topic and handle orders/create webhook events. You'll do the same for the ORDERS_FULFILLED webhook topic.

1. In server/handlers/webhooks, create an orders.js file.

2. In server/handlers/webhooks/orders.js, add a webhook handler to listen for incoming webhooks and save them to the Orders data table that you created.

3. In server/handlers/webhooks/setup.js, subscribe to the ORDERS_CREATE and ORDERS_FULFILLED webhooks.

There are several Order-adjacent webhook topics that you might want to subscribe to and make database adjustments based on their content.

• Learn how to bill merchants for sales they make on your marketplace.

• Share feedback on Marketplace Kit.