E-commerce API

Get all attributes with pagination and search

Create a new attribute with optional terms

Archive (soft delete) single or multiple attributes by setting archived = 1 Handles both single delete and bulk delete

Get attributes formatted for dropdown/select components Includes terms for each attribute

Get a single attribute by ID with its terms

Update an existing attribute and its terms

Public pricing plans

Which Services appear on the Membership table: - Block selected product_ids → those Services (order preserved) - No selection → all active recurring Services except bare add-ons The Service toggle `show_in_pricing_table` does NOT gate visibility. It only unlocks marketing on the card (badge, highlight, bullets, compare). Checkout: one Service = one plan, so the plan IS the checkout product.

List Categories

Get Category

Create Category

Update Category

Delete Category

Export Categories

My Community Roles

The signed-in (verified) visitor's roles on this site: resident always, plus what the owner approved or gave.

Ask For A Community Role

A verified visitor asks to be a business owner (optionally of one listing) or an organisation on this site. It waits for the owner; nothing is mailed from this.

Register customer account

Creates a new customer account under the given project and returns a sanctum bearer token — the customer is logged in immediately without waiting on email verification. A verification email is sent, and any past guest orders with the same email are linked to the new account in the background.

Log in customer

Authenticates a customer and returns a sanctum bearer token to use on subsequent requests. Accounts with an unverified email can still log in.

Request password reset

Emails a password reset link to the customer. Responds with a generic success message whether or not the email matches an existing account, so the response cannot be used to probe which emails are registered. The link expires after 60 minutes.

Reset customer password

Sets a new password using a token delivered by email. On success the email is also marked verified, since completing the reset flow proves email ownership.

Accept invitation

Submitted by the storefront's accept-invitation page after the customer clicks the link from their invitation email. Validates the token, sets the customer's password, marks the email verified (reaching the inbox + entering the token proves ownership) and issues a sanctum bearer token so the customer is signed in immediately.

Log out customer

Revokes the sanctum token used for the current request. Other tokens issued to the same customer (for example from other devices) remain valid.

Resend verification email

Sends a fresh verification link to the authenticated customer's inbox. Returns 200 even when the customer is already verified, so callers can fire-and-forget without branching.

Get customer profile

Returns the full profile of the currently authenticated customer, including default billing/shipping address snapshots and email verification status.

Update customer profile

Updates the authenticated customer's name, phone, and default billing country / postcode (used for phone + postal validation and checkout prefills). Email changes are deferred to a dedicated re-verification flow.

Update cart-reminder consent

Toggles the authenticated customer's opt-in for abandoned-cart reminder emails. Setting `enabled` to true records a fresh consent (timestamp + text version + IP); setting it to false marks the consent as withdrawn.

Update default addresses

Updates the customer's default billing and shipping address snapshots. These are used to prefill checkout on future orders. Both fields are optional and independent (you can update only billing, only shipping, or both).

List customer orders

Returns a paginated list of the authenticated customer's past orders, most recent first. Only completed checkout orders are returned — quotes are excluded.

Get customer order detail

Returns the full detail of a single order belonging to the authenticated customer — line items, totals, billing/shipping snapshot, payment status. Requesting an order that belongs to a different customer returns 404.

Reorder a past order

Appends every line item from a past order onto the authenticated customer's active shopping cart at current prices. Stock is NOT checked here — the cart's existing checkout flow validates availability when the customer proceeds to pay. Only products that have been deleted or disabled in the catalog are skipped (their rows can't be inserted). Shipping methods and discount codes are NOT carried over — the customer re-selects shipping at checkout, and automatic discounts (customer-tier, sale, campaign) re-evaluate against the cart's current state.

Ask a question about an order

Opens a ticket in the shop's helpdesk inbox, linked to the order number, from the signed-in customer's own email (a verified sender). The shop replies by email. Only the customer's own orders (404 otherwise), only when the shop has the helpdesk with an active inbox (422 otherwise), and at most a few questions an hour (429).

List the authenticated customer's booking reservations + memberships

Industry pattern (Mindbody / Shopify booking apps): - My orders → catalog payment receipts (slot-only booking checkouts are excluded) - My invoices → receipts for paid bookings + catalog - My bookings → operational items: slot reservations + active memberships Abandoned `expired` payment holds are hidden from this list.

Get a single booking reservation OR membership belonging to the customer

Pass item_kind=membership (or booking_id like "m12") for subscriptions.

The guest's open waitlist places (times still to come), soonest first

Leave one of the guest's own waitlist places

List my memberships

Cancel my membership

Pause my membership

End the pause of my membership

List customer quotes

Returns a paginated list of quote requests the authenticated customer has submitted, most recent first. Quotes are separate from orders — they carry no payment and exist for shops that offer a request-a-quote flow alongside regular checkout.

Change password

Changes the authenticated customer's password. Requires the current password as confirmation. All existing tokens (on this and every other device) are revoked and a fresh token is returned for this session — the client must swap it into storage and headers to stay logged in.

Delete customer account

Permanently deletes the authenticated customer. Requires the current password as confirmation. Past orders are retained (invoice/tax retention) with their customer link removed.

Request email change (step 1 of 2)

Starts the change flow: validates the new address, stores a 6-digit OTP against the customer (max one pending at a time), sends the OTP to the new address and a security alert to the current address. Finish the change by submitting the code to the verify endpoint within 10 minutes.

Verify email change (step 2 of 2)

Submits the 6-digit code received at the new email address. On success the email is changed, marked verified (entering the code proves ownership of the new inbox) and every existing token is revoked — the customer must log in again with the new address on every device.

Claim guest cart

Attaches a guest shopping cart (identified by its session token) to the authenticated customer, so the cart they built before logging in follows them into their account. Only unassigned carts can be claimed.

List Customers (picker)

Returns project-scoped customers, optionally filtered by a free-text search across email + first/last name. Capped at 50 rows.

List Customers (admin)

Returns project-scoped customers with order aggregates and basic profile fields, paginated and sortable. Supports free-text search across email, name, and company.

Get Customer (admin)

Returns one customer's full profile, addresses, and order aggregates, scoped to the current project.

Link past guest orders to a customer (admin)

Same as what happens when the customer verifies their email: guest orders, carts and memberships placed with this email are attached to the account. Only for verified customers (an unverified account could belong to someone else).

Webshop admin dashboard stats

Single endpoint that returns all sections for the webshop dashboard: KPIs (with compare deltas), revenue chart series, order status counts, recent orders, top products, low stock, abandoned carts, payment methods, order type split, and top discounts. Period anchors: - Revenue / AOV / paid metrics: `paid_at` (money collected) - Order count / type split / recent orders / chart: `created_at` (demand placed) - Refunds: `updated_at` (status change time; no dedicated refunded_at column)

List Discounts

Get Discount

Create Discount

Update Discount

Change Discount Status

Delete Discount

Delete Feed

Create Feed

Update Feed

Get Feed

List Feeds

List Filters

Get Filters

Get Filter

Create Filter

Update Filter

Delete Filters

Get SendCloud Status

Get Shipping Methods

List Orders

Export Orders

Get Order Detail

Returns full order details including products, pricing, tax breakdown, shipping, payment, discount and user/billing information. Response structure varies by order type (checkout or quote).

Update Order

Sync Order to Financial Provider

Rate limit: 5 requests per minute.

Mark Order as Paid

Mark Order as Cancelled

Mark Order as Completed

Mark Order as on Hold

Mark Order as Refunding

Mark Order as Refunded

Update Vendor Comment

Get Shipping Methods

Create Shipments

This endpoint validates orders and queues them for batch processing. Actual SendCloud API communication happens asynchronously in jobs.

Create Shipping Labels

This endpoint validates shipments and queues them for batch label processing. Actual SendCloud API communication happens asynchronously in jobs.

Download Shipping Labels Supports multiple shipments per order and different printer types

Generate Invoice PDF

Returns an HTML view rendered as a PDF invoice for the specified order.

Generate Package Slip PDF

Returns an HTML view rendered as a package slip for the specified order.

Generate PDF

Export Orders

Create Order

Converts a shopping cart into an order. Creates quote and/or checkout orders based on cart products. For paid orders, initiates payment and returns a redirect URL.

Get Order

Mark Order Purchase as Tracked

Get Product File Download

Resolve Contextual Prices

Returns ONLY the products whose price changes for this visitor (customer or campaign overlay). Products absent from the response should keep their static price. A product with variations that have their own price also gets `variations: {variation_id: overlay}`; an entry may carry only that (then the product's own static price stays).

Get booking resources for a specific product

Get all variations for a specific product

Save (create or update) product variations This controller handles bulk variation save operations

List Products

Create Product

Update Product

Duplicate Product

Export Products

Export stock

Every simple product and every variation with its current quantity, for the CLI stock list (`wemasy stock pull`).

Apply stock changes

Rows with op "set" (quantity, optional expected: compare-and-set) or "add" (delta, atomic). A dry run unless dry_run is false.

Google Shopping Feed

Returns a Google Merchant Center compatible XML product feed.

Google Shopping Feed by Filter

Returns a filtered Google Merchant Center compatible XML product feed.

Get Product Stock

Get Product Stock Bulk

Get Product Options Returns all options or filters by page_type if specified

Get Webshop Settings

Save Webshop Settings

Create official cart / checkout / thank-you pages (sync)

Files lead (#1273): for a project stored as its folder the job writes the shop starter (pages and their assignments) into the folder, and SystemSetupReady reads them from there.

Verify SendCloud Credentials

Set Default Shipping Method

Get Financial Connections

Save Financial Connection

Create Shopping Cart

Get Shopping Cart

Update Cart Quantity

Returns the full updated cart (same response as Get Shopping Cart).

Delete Cart Product

Returns the full updated cart (same response as Get Shopping Cart).

Add User Details to Cart

Returns the full updated cart (same response as Get Shopping Cart).

Validate a Cart's VAT Number (VIES)

Dedicated, self-contained VAT validation so the storefront can show a "validating…" indicator next to the VAT field WITHOUT blocking the whole address-save or the checkout button. Persists the invoice tax fields and the resolved vies_* state, then returns the full updated cart (same shape as Get Shopping Cart) so reverse-charge totals and the vies status update together.

Add Shipping Method to Cart

Returns the full updated cart (same response as Get Shopping Cart).

Add Payment Method to Cart

Returns the full updated cart (same response as Get Shopping Cart).

Add Product to Shopping Cart

Returns the full updated cart (same response as Get Shopping Cart). Validates product options based on page_type if provided

Update Shopping Cart Item

Returns the full updated cart (same response as Get Shopping Cart). Updates quantity and validates options based on page_type if provided

Verify Shopping Cart for Checkout

Validates all products are ready for checkout.

Apply Coupon Code

Remove Coupon Code

Apply a gift card

Remove the gift card

Send the bought gift card(s) to someone

Their name, email address and a message; empty = the buyer gets the card (the default). The card goes out by mail when the payment is in.

Send a reminder with a payment link: first payment (waiting memberships) or the renewal

Cash / bank transfer received for the renewal: mark the renewal order paid, which extends the membership one period and unlocks its credits

Cancel a membership for the member: no more charges, no reminders; the period already paid stays usable

Pause a membership from one date until another (holiday, injury): no payments and no credits in that time; the next payment moves on by the same days

End a pause today, or take away one that has not started yet

Create Transaction

Initiates a payment transaction for a checkout order. Creates a Mollie/Stripe payment session and returns a redirect URL. For non-payment methods (pay_on_pickup, wire transfer), redirects directly to the thank-you page.

Invite a customer

Creates a new customer record without a password and emails them an invitation link. Clicking the link lands them on the storefront's accept-invitation page where they pick a password and are signed in automatically. The email arrives on the merchant's brand and the URL lives on the merchant's storefront domain (not the platform host).