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

Input

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

customerAccessToken

stringrequired

Output

AuthRegisterAction

ecommerce/auth/register

Input

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.

address

MailingAddress { address1, address2, city, 11 more }required

Output

Throwables

InvalidFieldError

AuthRecoverAction

ecommerce/auth/recover

Send a recovery email to the customer.

Input

stringrequired

formatemail

Output

AuthLoginOauthAction

ecommerce/auth/login-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

Cart

CartAddItemsAction

ecommerce/cart/add-items

Add items to the cart.

Input

array

Accepts an array of the following:

CartAddItemProductInput

{ type, productId, variantId, 2 more }

CartAddItemDiscountCodeInput

{ type, code, customFields }

CartAddItemCustomInput

{ type, customFields }

Output

Throwables

ProductNotFoundError ProductStockError ProductQuantityError DiscountCodeNotFoundError DiscountCodeNotRedeemableError

CartRemoveItemsAction

ecommerce/cart/remove-items

Remove items from the cart.

Input

string[]

Output

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

CartGetCheckoutUrlAction

ecommerce/cart/get-checkout-url

Get the checkout URL for the cart.

Input

Output

checkoutUrl

stringrequired

Wishlist

WishlistAddItemsAction

ecommerce/wishlist/add-items

Add one or more items to the wishlist.

Input

array

productId

stringrequired

The product id.

variantId

string

The variant id.

customFields

Record<string, unknown>

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

Output

Throwables

UnauthenticatedError ProductNotFoundError

WishlistRemoveItemsAction

ecommerce/wishlist/remove-items

Remove one or more items from the wishlist.

Input

string[]

Output

Customer

CustomerGetCurrentAction

ecommerce/customer/get-current

Get the current customer data.

Input

Output

customer

{ id, email, phone, 6 more }required

Throwables

UnauthenticatedError

CustomerAddressGetAllAction

ecommerce/customer/address-get-all

Get all addresses for the current customer.

Input

Output

addresses

MailingAddress[] { address1, address2, city, 11 more }required

Throwables

UnauthenticatedError

CustomerAddressCreateAction

ecommerce/customer/address-create

Create a new address for the current customer.

Input

address

MailingAddress { address1, address2, city, 11 more }required

Output

Throwables

UnauthenticatedError InvalidFieldError

CustomerAddressUpdateAction

ecommerce/customer/address-update

Update an address for the current customer.

Input

stringrequired

The ID of the address to update.

address

{ address1, address2, city, 11 more }required

Output

Throwables

UnauthenticatedError AddressNotFoundError InvalidFieldError

CustomerAddressDeleteAction

ecommerce/customer/address-delete

Delete an address for the current customer.

Input

stringrequired

The ID of the address to delete.

Output

Throwables

UnauthenticatedError AddressNotFoundError

CustomerAddressSetDefaultAction

ecommerce/customer/address-set-default

Set a default address for the current customer.

Input

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

Throwables

UnauthenticatedError AddressNotFoundError

Review

ProductReviewsCreateAction

ecommerce/product/reviews/create

Create and save a new review for a given product ID.

Input

productId

stringrequired

name

stringrequired

title

stringrequired

content

stringrequired

points

numberrequired

min1max5

Output

success

booleanrequired

message

string

Throwables

InvalidCredentialsError

Entities

Edit this pageorReport an issue

Page Types

All canonical page types across domains - routing, query bindings, and entity resolution

Queries

Queries available for implementation in ecommerce connector apps