Laioutr
Ecommerce

Actions

Actions available for implementation in ecommerce connector apps

Canonical actions define the write-operation contract between the frontend and your connector app. When you build an ecommerce connector, you implement action handlers for each of these actions so the frontend can authenticate users, manage carts, and perform other mutations against your commerce backend.

Import these from @laioutr-core/canonical-types/ecommerce.

Auth

AuthLoginAction

ecommerce/auth/login
Login a customer using email and password.
Input
email
stringrequired

The email address of the user.

formatemail
password
stringrequired

The password of the user.

Output
success
booleanrequired
message
string
Throwables
InvalidCredentialsError

AuthLogoutAction

ecommerce/auth/logout
Logout a customer.
Input
Output
unknown

AuthRegisterAction

ecommerce/auth/register
Register a new customer.
Input
email
stringrequired

The email address of the user.

formatemail
password
stringrequired

The password of the user.

firstName
stringrequired

The first name(s) of a person.

lastName
stringrequired

The last name(s) of a person.

salutation
string

Salutation of a person as lowercase key.

title
string

Title of a person as lowercase key.

Output
unknown
Throwables
InvalidFieldError

AuthRecoverAction

ecommerce/auth/recover
Send a recovery email to the customer.
Input
email
stringrequired
formatemail
Output
unknown

AuthLoginOauthAction

ecommerce/auth/login-oauth
Login a customer using OAuth.
Input
Output
authorizationUrl
stringrequired

AuthLogoutOauthAction

ecommerce/auth/logout-oauth
Logout a customer.
Input
Output
logoutUrl
stringrequired

AuthOauthCallbackAction

ecommerce/auth/oauth-callback
OAuth callback action for Shopify Customer Account API. This action handles the OAuth 2.0 callback from Shopify's authorization server. It exchanges the authorization code for access tokens and creates a user session.
Input
code
stringrequired

The authorization code returned by Shopify's OAuth server.

state
stringrequired

The state parameter to prevent CSRF attacks.

Output
unknown

Cart

CartAddItemsAction

ecommerce/cart/add-items
Add items to the cart.
Input
array

Union of all possible items that can be added to the cart. If you find yourself in a situation where you need to add items which are not products or discount-codes, you should create a custom action for that or use the type custom.

Accepts an array of the following:

Output
Throwables
ProductNotFoundErrorProductStockErrorProductQuantityErrorDiscountCodeNotFoundErrorDiscountCodeNotRedeemableError

CartRemoveItemsAction

ecommerce/cart/remove-items
Remove items from the cart.
Input
string[]
Output
unknown

CartUpdateItemsAction

ecommerce/cart/update-items
Update items in the cart. This action is used to update the quantity or custom fields of multiple items in the cart.
Input
array
itemId
stringrequired

Cart line-item id.

quantity
number

The new quantity of the item. Won't update if undefined. Only works for products.

customFields
Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Output
unknown

CartGetCheckoutUrlAction

ecommerce/cart/get-checkout-url
Get the checkout URL for the cart.
Input
Output
checkoutUrl
stringrequired

Product Lists

Product lists replace the former wishlist-specific mutations with one contract for wishlists, favorites, shopping lists, and B2B requisition lists.

ProductListCreateAction

ecommerce/product-list/create
Create a product list.
Input
name
stringrequired
type
string
visibility
"private" | "shared" | "public"

The visibility value set — shared with the ecommerce/product-list/* actions so the vocabulary has a single source.

Output
id
stringrequired

The ID of the created product list.

Throwables
UnauthenticatedErrorInvalidFieldError

ProductListUpdateAction

ecommerce/product-list/update
Update a product list's metadata and visibility.
Input
productListId
stringrequired
name
string
description
string
visibility
"private" | "shared" | "public"

The visibility value set — shared with the ecommerce/product-list/* actions so the vocabulary has a single source.

Output
unknown
Throwables
UnauthenticatedErrorInvalidFieldErrorProductListNotFoundError

ProductListDeleteAction

ecommerce/product-list/delete
Delete a product list.
Input
productListId
stringrequired
Output
unknown
Throwables
UnauthenticatedErrorProductListNotFoundError

ProductListDuplicateAction

ecommerce/product-list/duplicate
Duplicate a product list.
Input
productListId
stringrequired
name
stringrequired

The name of the new list.

Output
id
stringrequired

The ID of the created copy.

Throwables
UnauthenticatedErrorProductListNotFoundError

ProductListAddItemsAction

ecommerce/product-list/add-items
Add products or variants to a product list.
Input
productListId
string

The list to add to. Absent ⇒ the customer's default wishlist.

Output
unknown
Throwables
UnauthenticatedErrorProductNotFoundErrorProductListNotFoundError

ProductListUpdateItemsAction

ecommerce/product-list/update-items
Update list-specific item details such as quantity or note.
Input
productListId
string

The list the entries are on. Absent ⇒ the customer's default wishlist.

Output
unknown
Throwables
UnauthenticatedErrorProductListNotFoundErrorProductListItemNotFoundError

ProductListRemoveItemsAction

ecommerce/product-list/remove-items
Remove products or variants from a product list.
Input
productListId
string

The list to remove from. Absent ⇒ the customer's default wishlist.

Output
unknown
Throwables
UnauthenticatedErrorProductListNotFoundErrorProductListItemNotFoundError

ProductListAddToCartAction

ecommerce/product-list/add-to-cart
Add all orderable items from a product list to the current cart.
Input
productListId
string

The list to add to the cart. Absent ⇒ the customer's default wishlist.

Output
Throwables
UnauthenticatedErrorProductListNotFoundError

Customer

CustomerGetCurrentAction

ecommerce/customer/get-current
Get the current customer data.
Input
Output
Throwables
UnauthenticatedError

CustomerUpdateAction

ecommerce/customer/update
Update the current customer's profile.
Input
phone
string

Represents a phone number. Formatted as a E.164 number.

pattern^\+?[1-9]\d{1,14}$
customFields
Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Output
unknown
Throwables
UnauthenticatedErrorInvalidFieldError

CustomerAddressGetAllAction

ecommerce/customer/address-get-all
Get all addresses for the current customer.
Input
Output
Throwables
UnauthenticatedError

CustomerAddressCreateAction

ecommerce/customer/address-create
Create a new address for the current customer.
Input
Output
unknown
Throwables
UnauthenticatedErrorInvalidFieldError

CustomerAddressUpdateAction

ecommerce/customer/address-update
Update an address for the current customer.
Input
id
stringrequired

The ID of the address to update.

Output
unknown
Throwables
UnauthenticatedErrorAddressNotFoundErrorInvalidFieldError

CustomerAddressDeleteAction

ecommerce/customer/address-delete
Delete an address for the current customer.
Input
id
stringrequired

The ID of the address to delete.

Output
unknown
Throwables
UnauthenticatedErrorAddressNotFoundError

CustomerAddressSetDefaultAction

ecommerce/customer/address-set-default
Set a default address for the current customer.
Input
id
stringrequired

The ID of the address to set as default.

type
"shipping" | "billing"required

The type of default to set. Not all backends may support this distinction.

Output
unknown
Throwables
UnauthenticatedErrorAddressNotFoundError

Orders

OrderReorderAction

ecommerce/order/reorder
Add the orderable items from a previous order to the current cart.
Input
orderId
stringrequired

The ID of the order to reorder.

Output
Throwables
UnauthenticatedErrorOrderNotFoundError

OrderCancelAction

ecommerce/order/cancel
Cancel an order when its current state allows cancellation.
Input
orderId
stringrequired

The ID of the order to cancel.

Output
unknown
Throwables
UnauthenticatedErrorOrderNotFoundErrorOrderNotCancellableError

OrderGetStatisticsAction

ecommerce/order/get-statistics
Get aggregate order statistics for the current customer.
Input
year
number

The calendar year to aggregate. Defaults to the current year.

min-9007199254740991max9007199254740991
Output
year
numberrequired

The calendar year the statistics cover.

min-9007199254740991max9007199254740991
Throwables
UnauthenticatedError

Documents

DocumentGetAllAction

ecommerce/document/get-all
Get invoices, delivery notes, credit notes, and other documents visible to the current customer.
Input
Output
Throwables
UnauthenticatedError

DocumentGetDownloadUrlAction

ecommerce/document/get-download-url
Get a temporary download URL for a commerce document.
Input
documentId
stringrequired

The ID of the document to download.

Output
downloadUrl
stringrequired
Throwables
UnauthenticatedErrorDocumentNotFoundError

Legal

LegalWithdrawalAction

ecommerce/legal/withdrawal
Submit a statutory right-of-withdrawal request for an order or contract.
Input
name
stringrequired
min length1
orderReference
stringrequired
min length1
email
stringrequired
formatemail
Output
success
booleanrequired
message
string

Review

ProductReviewsCreateAction

ecommerce/product/reviews/create
Create and save a new review for a given product ID.
Input
productId
stringrequired
name
stringrequired
email
stringrequired
formatemail
title
stringrequired
content
stringrequired
points
numberrequired

A rating between 1 and 5. That's the most common rating scale. No other scale is supported at the moment. Decimals are allowed.

min1max5
Output
success
booleanrequired
message
string
Throwables
InvalidCredentialsErrorInvalidFieldError

Entities

Commerce Value Types

Shared activity, fee, batch-result, permission, document, and order-status values

Queries

Queries available for implementation in ecommerce connector apps

Copyright © 2026 Laioutr GmbH