Restore orders

Restore orders finds orders that were deleted from your Swell store and restores them. Choose a period, review the orders deleted in it, and restore the ones you need with their original number and data.

The app reads the order.deleted events Swell records when an order is deleted, so it also finds orders deleted before you installed it. Restoring sends no emails, calls no webhooks and doesn't change your stock.

The app runs only when someone uses the page. It has no functions, doesn't react to orders being deleted, and stores no records of its own.

Install Restore orders from the Swell App Store.

The app has no settings.

What a user can do on the page depends on the Orders level of their role, set in Settings > Users under Manage roles:

Users without a role have Full permissions or a list of permissions. With Full permissions or Orders in the list, they can search and restore. Without Orders, the page shows the same error as for Restrict. The app checks the user's access with Swell on every request, not only when the page opens.

To find deleted orders, go to Orders > Restore orders, set Date start and Date end, and click Search. The dates are when the orders were deleted, not when they were placed. Both days are included, in your browser's time zone. The form starts with the last 30 days, and you can search any period.

The search reads 1,000 events per request. In a long period with many deletions, the page shows its progress, such as "Searching · events page 2 of 5". The line above the grid shows the total, such as "186 deleted orders found".

The grid shows 10 orders per page. Dates and amounts follow your browser's language and time zone.

These orders aren't listed:

Only not canceled is on by default and leaves out orders that were canceled when they were deleted, such as orders deleted with Cancel and delete order. To list them too, turn it off and click Search. They show with a Canceled badge.

To sort the results, choose Date deleted or Date created under Sort by. Orders are sorted newest first, and the default is Date deleted. Sorting applies at once, without searching again, and returns to the first page. Orders without that date go last. Sort by shows when there are two or more results.

To see what an order held when it was deleted, click its row or its number. Event data opens below the grid with the full order.deleted event as JSON. The order is under data, with its items, addresses and totals. To hide it, click the order again or click Close.

The restore uses this data. Payments, shipments and other linked records are separate records, so they aren't in it.

To restore orders, select them with the checkboxes and click Restore. The button shows how many are selected, such as Restore 2, and the line above the grid shows "186 deleted orders found · 2 selected". The checkbox in the header selects the orders on the current page. Your selection stays when you change the page or the sort. To clear it, click Clear selection.

After you click Restore, the page asks you to confirm, such as "Restore 2 orders?", and says that each order is created again with its original ID, number and data, and that order emails and webhooks aren't sent. To start, click Restore 2 orders. To go back, click Cancel. A restore can't be undone from the app.

While the restore runs, the page shows its progress, such as "Restoring 10 of 25… Keep this page open until it finishes.", and the button shows Restoring…. The page sends 10 orders at a time, one group after another, so leaving the page stops the groups not sent yet. The page asks your browser to warn you before the tab is closed or reloaded, but going to another dashboard page doesn't warn you. Orders already restored stay restored and leave the list when you search again.

The result shows above the grid, such as "Restored 2 orders." If any weren't restored, it adds how many and lists each one with the reason, such as "Order 100551: The order already exists". The page then searches the same period again, so restored orders leave the list.

Select all shows the number of results, such as Select all 186, and selects every result on all pages, including pages you haven't opened. It shows until every result is selected. Check the period and Only not canceled before you click Restore.

The app writes the order back from its order.deleted event, with its original ID.

The app shows its messages on the page. When a call to Swell fails during a search, Error details shows the call and Swell's response. The app writes no logs of its own. Its calls to the Swell API are under Developer > Console > Logs: choose the app under App to see them.

Check that the dates cover the day the order was deleted, not the day it was placed, and that you're in the environment it was deleted in. If the order was canceled, turn off Only not canceled. Orders that exist now and orders without a customer account aren't listed. To check for the event, look for order.deleted under Developer > Console > Events.

Search is off while the page checks your access, while a search or a restore is running, while you confirm a restore, when a date is empty, and when Date start is after Date end. For users without access to orders, it stays off.

Your role has Restrict for Orders, or you have no role and Orders isn't in your permissions. Ask the store owner for access to orders in Settings > Users, then reload the page.

Your role has View for Orders. You can search and see event data, but Restore doesn't show. To restore orders, you need Manage or Full. After your role changes, reload the page.

The request had no dashboard session. Sign in to the Swell dashboard and open Orders > Restore orders there.

The dashboard session has ended or belongs to another store. Sign in again and open the page from this store's dashboard.

The session cookie couldn't be read. Sign in to the dashboard again.

The request reached the app without the store's details from Swell. Open the page from Orders > Restore orders.

The app couldn't check the dashboard session or your access to orders with Swell. Try again in a minute. If it shows when the page opens, reload the page.

A search or restore request didn't come from the app's own page. Open the page from Orders > Restore orders and try again.

The event no longer exists, or it isn't an order.deleted event. Search again.

The order exists again, so it was skipped. Someone else may have restored it after your search. It leaves the list when the page searches again.

The event doesn't hold an order with a valid ID, so the order can't be restored from it.

Swell's answer had no order in it. Search again, and if the order is still listed, try again. The request shows as POST /orders in the logs.

The text after the order number is Swell's answer. If it's a message such as "… is sold out.", a before: hook of an installed app refused the order. If every order in a group of 10 shows the same message, the whole request failed. Select those orders and try again.

Swell answered a call with an error and no message. Try again in a minute. If it happens during a search, Error details shows the call and the response.

The app got an answer it couldn't read. Try again in a minute.

Restoring doesn't update the account's order count and order value. Swell updates them at the customer's next order, or when one of their orders is canceled or its total changes.

Channel isn't restored, so the order page shows a dash. The rest of the order isn't affected.

To uninstall the app, go to Apps > Restore orders and choose Uninstall app. This removes the app and its Restore orders entry under Orders. Uninstalling applies to the environment you are in, so remove the app from the test and live environments separately.

Restored orders stay, because they're regular orders. The app stores no records of its own, so nothing else is removed. order.deleted events stay too, so if you reinstall the app, it finds the orders you haven't restored.

The app is an admin app with frontend.hosting: managed and no functions. Swell hosts the page and its Worker. The sidebar entry comes from content/restores.json, with nav parent orders and link frontend:///. models/restores.json is a placeholder collection for that view and stores no records. Other /app-api paths return 404, wrong methods return 405, and all other paths serve the built page.

The Worker doesn't read Swell-Context. Each route reads the _swell_admin_session cookie and calls GET /admin/api/session on Swell-Admin-Url with it as X-Session. The session must have a user_id, and its client_id must match Swell-Store-Id. It then calls GET /admin/api/user the same way, and a missing user returns 401. The user's access to orders comes from role.permissions.orders: restrict is none, view is view, and any other value is full. Without a role, all_permissions, no permissions list, or orders in permissions is full, and anything else is none. None returns 403 on every route, and restore returns 403 unless access is full. POST routes also need an Origin equal to the request's origin and a JSON Content-Type, and otherwise return 403.

Calls to Swell go to Swell-API-Host with Basic auth from Swell-Store-Id and Swell-Access-Token, the installation's key, which is per environment. permissions in swell.json is empty, which gives the key full Backend API access. The Worker calls only GET /events, GET /events/{id}, GET /orders and POST /orders. The key is removed from error details, and responses are Cache-Control: private, no-store.

Search reads GET /events with where[type]=order.deleted, $gte and $lt on where[date_created], sort=date_created desc, id desc, limit=1000 and the fields the grid needs. It keeps the first event of each data.id, drops events with no data.account_id and, with not_canceled, events with data.canceled: true, and checks the rest with GET /orders and where[id][$in], 100 IDs at a time. order_ids lists every order on the page, so the browser can skip older deletions on later pages. The browser asks for pages until done. date_from and date_to are the start of Date start and the start of the day after Date end, in the browser's time zone.

An order.deleted event holds the order record as it was stored, without linked records. Events have no TTL. The 90-day TTL in the events indexes applies to their webhook delivery records.

Restore reads GET /events/{id}, checks GET /orders for the order's ID, and calls POST /orders with the event's data plus $restore: true and $events: false. id, number, date_created and date_updated are stored as sent.

The Worker writes no logs. When a Swell API call fails during a search, the route returns { error, details } with status 502, and the page shows details under Error details. In a restore, each order's failure is in its result's error. The app's own messages, such as for invalid input, return only { error }. API calls made with the app's key are logged as requests, with the app's ID.

Swell builds and maintains the Restore orders app. For help with the app, email support@swell.is.