Orders

Order management and fulfillment

📄️ Cancel order

Cancel an open order. Voids authorized payments, optionally refunds any remaining

Edits the line items of an existing order (add/remove/change quantities, custom items, discounts, shipping), re-syncing inventory and payment. Returns the full order detail rebuilt from the canonical database.

📄️ Add a comment to an order

Adds a staff comment (optionally with a media attachment) to the order timeline. Returns the full order detail rebuilt from the canonical database.

📄️ Update an order comment

Edits the content and/or attachment of an existing order timeline comment. Returns the full order detail rebuilt from the canonical database.

📄️ Delete an order comment

Removes a comment from the order timeline. Returns the full order detail rebuilt from the canonical database.

📄️ Archive or unarchive an order

Toggles archival — archives an open order (recording its previous status), or restores an archived order to the status it had before archiving. Returns the updated order document.

📄️ Resend digital download links

Re-sends the digital product download links email to the buyer of the order. Fails with 404 if the order has no active download tokens.

📄️ Revoke digital download access

Revokes all digital product download tokens issued for the order.

📄️ Restore digital download access

Restores download access for a previously revoked digital order, reactivating tokens in place and preserving remaining download counts.

📄️ Refund an order

Processes a full or partial refund. Refund either specific line items (amount computed from them) or an explicit amount; optionally restocks items and emails the customer.

📄️ List all order tags

Returns the deduplicated set of tags used across all non-deleted orders of the store.

📄️ Add a tag to an order

Adds a single tag to the order. Returns the full order detail rebuilt from the canonical database so the caller sees the updated tag set.

📄️ Remove a tag from an order

Removes a single tag from the order (tag name passed in the request body). Returns the full order detail rebuilt from the canonical database.

📄️ Get order metrics

Returns dashboard order metrics (orders, items ordered, returns, fulfillments, deliveries) as totals plus per-day series over the requested date range (defaults to the last 30 days).

📄️ List saved order views

Returns all saved order-list views for the store, with the built-in 'all' view (isAll=true) moved to the front.

📄️ Create a saved order view

Creates a named, filterable order-list view with a chosen set of columns.

📄️ Update a saved order view

Updates a saved view's name, query, or columns. Pass the literal id 'all' to update the store's built-in default view.

📄️ Delete a saved order view

Deletes a saved order-list view by id.

📄️ Get order customer journey

Returns the enriched pre-purchase customer journey for an order — session details, UTM attribution (first/last touch), a step timeline, device/location info and store-average comparison. Sections are empty/null when no visit data can be matched to the order's IP.