Main Navigation Dev Docs User Guide Extensions Community Forum Contact Us

Appearance

Sidebar Navigation

Getting Started

Introduction

Setup

Authentication

Storefront Keys

Core Concepts

Rate Limiting

Status Codes

Pagination

Sorting

Integration Guides

Testing & Debugging

Build with AI

Introduction

Agent Skills

MCP Server

For Developers

Introduction

Register Your Package

Build an Endpoint

Write Endpoints

Conventions

Test & Ship

Workflows

Introduction

Shop

Overview

Build a Storefront

Browse & Filter Catalog

Cart

Checkout

Customer Account

Returns / RMA

EU Withdrawal

GDPR Requests

Admin

Overview

Build an Admin Dashboard

Create-Order Flow

Product Management

Order Fulfillment Actions

Customers (Impersonate & GDPR)

Returns / RMA

EU Withdrawal

Marketing

Configuration

Customization

Overview

Folder Structure

Testing

GraphQL API

Introduction

Authentication

Shop API

Locales

Queries

Locales

Single Locale

Theme

Sections

Single Section

CMS Pages

Queries

Pages

Single Page

Product

Queries

Products

Search Products

Category Attribute Filters

Single Product

Booking Slots

Product Review

Queries

Product Reviews

Mutations

Create Product Review

Update Product Review

Delete Product Review

Attribute

Queries

Attributes

Single Attribute

Attribute Options

Channel

Queries

Channels

Single Channel

Currency

Queries

Currencies

Single Currency

Country

Single Country

Countries

Country States

Country State

Customer

Queries

Get Customer Profile

Get Customer Orders

Get Customer Order

Get Customer Order Shipments

Get Customer Order Shipment

Get Customer Invoices

Get Customer Invoice

Download Invoice

Get Downloadable Products

Get Downloadable Product

Download Downloadable Product

Get Customer Addresses

Mutations

Customer Registration

Customer Login

Social Login

Customer Verify Token

Customer Logout

Update Customer Profile

Delete Customer Profile

Forgot Password

Create Customer Address

Update Customer Address

Delete Customer Address

Cancel Customer Order

Reorder Customer Order

Get Customer Reviews

Get Customer Review

GDPR Requests

Queries

GDPR Status

List GDPR Requests

View GDPR Request

Mutations

Raise GDPR Request

Revoke GDPR Request

Delete GDPR Request

Returns (RMA)

Queries

List Returns

View Return

List Returnable Orders

List Returnable Items

List Return Reasons

List Return Custom Fields

List Return Messages

Mutations

Create Return

Cancel Return

Reopen Return

Close Return

Send Return Message

EU Withdrawal

Queries

EU Withdrawal Status

List EU Withdrawals

View EU Withdrawal

Mutations

File EU Withdrawal

File EU Withdrawal (Guest)

Cart

Queries

Get Cart

Mutations

CreateCart

AddToCart

UpdateCartItem

RemoveCartItem

Merge Cart

Upload Customizable File

ApplyCoupon

RemoveCoupon

Checkout

Queries

Get Addresses

Get Shipping Methods

Get Payment Methods

Mutations

Set Checkout Address

Set Shipping Method

Set Payment Method

Place Order

Wishlist

Queries

Get Wishlists

Get Wishlist Item

Mutations

Create Wishlist

Toggle Wishlist

Delete Wishlist

Move to Cart

Delete All Wishlists

Compare

Queries

Get Compare Items

Get Compare Item

Mutations

Create Compare Item

Delete Compare Item

Delete All Compare Items

Contact Us

Mutations

Create Contact Us

Newsletter

Mutations

Create Newsletter

Admin API

Authentication

Admin Profile

Get Profile

Navigation

Menu

Permissions

Catalog

Products

List Products

Add-Product Search (Create-Order)

Catalog Product Detail

Create Product

Update Product

Delete Product

Copy Product

Mass Delete Products

Mass Update Status

Upload Image (REST only)

Update Image

Reorder Images

Delete Image

List Inventories

Update Inventories

List Customer-Group Prices

Add Customer-Group Price

Update Customer-Group Price

Delete Customer-Group Price

Categories

Categories Listing (Datagrid)

Categories Tree (Nested)

Category Detail

Create Category

Update / Move Category

Delete Category

Mass Delete Categories

Mass Update Status

Attributes

Attributes Listing (Datagrid)

Attribute Detail

Create Attribute

Update Attribute

Delete Attribute

Mass Delete Attributes

Attribute Options (CRUD)

Attribute Families

Families Listing (Datagrid)

Family Detail

Create Family

Update Family

Delete Family

Appearance

Themes

adminAppearanceThemes

adminAppearanceTheme

adminAppearanceThemeImpact

createAdminAppearanceThemeActivate

Sections

adminAppearanceSections

adminAppearanceSection

createAdminAppearanceSection

updateAdminAppearanceSection

deleteAdminAppearanceSection

createAdminAppearanceSectionDraft

createAdminAppearanceSectionStatus

createAdminAppearanceSectionReorder

createAdminAppearanceSectionDuplicate

createAdminAppearanceSectionPublish

createAdminAppearanceSectionDiscard

adminAppearanceSectionFields

adminAppearanceSectionPreview

CMS

Queries

List Pages

Page Detail

Mutations

Create Page

Update Page

Delete Page

Mass Delete Pages

Sales

Orders

List Orders

Order Detail

Reorder

Cancel Order

Add Comment

List Comments

Create Invoice

Get Invoice

Print Invoice (PDF)

Send Duplicate Invoice

Create Shipment

Get Shipment

Create Refund

Refund Preview

Get Refund

Carts

Get Cart

Add Item

Update Items

Remove Item

Save Address

Apply Coupon

Remove Coupon

List Shipping Methods

Set Shipping Method

List Payment Methods

Set Payment Method

Place Order

Invoices (Datagrid)

List Invoices

Get Invoice

Print Invoice (PDF)

Send Duplicate Invoice

Mass Update Status

Shipments (Datagrid)

List Shipments

Get Shipment

Refunds (Datagrid)

List Refunds

Get Refund

Returns (RMA)

List Returns

View Return

Returnable Items

Return Reasons

Return Messages

Create Return

Update Status

Reopen Return

Send Return Message

EU Withdrawal

List EU Withdrawals

View EU Withdrawal

Decline

Mark Refunded

Resend Confirmation

Transactions

List Transactions

Create Transaction

Bookings

List Bookings

Booking Detail

Customers

List Customers

Customer Detail

Create Customer

Update Customer

Delete Customer

Mass Delete

Mass Update Status

Addresses

List Addresses

Address Detail

Create Address

Update Address

Delete Address

Set as Default

Notes

Add Note

List Notes

Impersonate

Issue Impersonation Token

Customer Groups

List Groups

Group Detail

Create Group

Update Group

Delete Group

Mass Delete

Reviews

List Reviews

Review Detail

Review with Images

Update Status

Delete Review

Mass Delete

Mass Update Status

GDPR Requests

List Requests

Request Detail

Update Request

Delete Request

Process (Approve + Execute)

Download Data Export

Create-Order Helpers

Active Cart Items

Wishlist Items

Compare Items

Recent Order Items

Create Draft Cart

Settings

Locales

List

Detail

Create

Update

Delete

Mass Delete

Currencies

List

Detail

Create

Update

Delete

Mass Delete

Exchange Rates

List

Detail

Create

Update

Delete

Mass Delete

Update Rates

Inventory Sources

List

Detail

Create

Update

Delete

Mass Delete

Channels

List

Detail

Create

Update

Delete

Admin Users

List

Detail

Create

Update

Delete

Delete My Account

Roles

List

Detail

Create

Update

Delete

Tax Categories

List

Detail

Create

Update

Delete

Tax Rates

List

Detail

Create

Update

Delete

Return Reasons

List

Detail

Create

Update

Delete

Mass Delete

Mass Update Status

Return Rules

List

Detail

Create

Update

Delete

Mass Delete

Mass Update Status

Return Statuses

List

Detail

Create

Update

Delete

Mass Delete

Mass Update Status

Return Custom Fields

List

Detail

Create

Update

Delete

Mass Delete

Mass Update Status

Data Transfer Imports

Overview

List

Detail

Create

Validate

Start

Link

Index

Stats

Delete

Cancel

Dashboard

Statistics

Reporting

Overview

Sales

Customers

Products

Marketing

Promotions

Catalog Rules

List

Detail

Create

Update

Delete

Mass Delete

Cart Rules

List

Detail

Copy

Create

Update

Delete

Mass Delete

Cart Rule Coupons

List

Create

Bulk Generate

Delete

Mass Delete

Communications

Email Templates

List

Detail

Create

Update

Delete

Events

List

Detail

Create

Update

Delete

Campaigns

List

Detail

Create

Update

Delete

Send

Newsletter Subscribers

List

Detail

Toggle Subscription

Delete

Search SEO

URL Rewrites

List

Detail

Create

Update

Delete

Mass Delete

Search Terms

List

Detail

Update

Delete

Mass Delete

Search Synonyms

List

Detail

Create

Update

Delete

Mass Delete

Sitemaps

List

Detail

Create

Update

Delete

Regenerate

Configuration

Menu

Slugs

Values

Update

Identifiers (id, _id, IRI)

Playground Guide

Best Practices

Rest API

Introduction

Authentication

Shop API

Locales

Get All Locales

Get Single Locale

Categories

Category Tree

Theme

Get Theme

Sections

List Sections

Get Section

Products

Search Products

Single Product

Booking Slots

Product Sub-Resources

Product Type Sub-Resources

Product Review

Get Product Reviews

Get Product Review

Create Product Review

Update Product Review

Delete Product Review

Attribute

Attributes

Attribute Options

Attribute Translations

Channel

Channels

Channel Translations

Country and State

Countries

Country States

Customer

Registration

Login

Social Login

Verify Token

Customer Logout

Forgot Password

Change Password

Get Addresses

Create Address

Update Address

Delete Address

Get Profile

Update Profile

Delete Profile

Get Orders

Get Order

Get Invoices

Get Invoice

Download Invoice PDF

Get Downloadable Products

Get Downloadable Product

Download Downloadable Product

Get Customer Reviews

Get Customer Review

GDPR Requests

GDPR Status

List GDPR Requests

View GDPR Request

Raise GDPR Request

Revoke GDPR Request

Delete GDPR Request

Returns (RMA)

List Returns

View Return

Create Return

Cancel Return

Reopen Return

Close Return

List Returnable Orders

List Returnable Items

List Return Reasons

List Return Custom Fields

List Return Messages

Send Return Message

EU Withdrawal

EU Withdrawal Status

List EU Withdrawals

View EU Withdrawal

File EU Withdrawal

File EU Withdrawal (Guest)

Cart

Get Cart

Create Cart

Add to Cart

Update Cart Item

Remove Cart Item

Apply Coupon

Remove Coupon

Merge Cart

Upload Customizable File

Checkout

Get Addresses

Get Shipping Methods

Get Payment Methods

Set Shipping Address

Set Billing Address

Set Shipping Method

Set Payment Method

Place Order

Wishlist

Get Wishlist Items

Create Wishlist Item

Toggle Wishlist Item

Delete Wishlist Item

Delete All Wishlist Items

Move Wishlist Item to Cart

Compare

Get Compare Items

Get Compare Item

Create Compare Item

Delete Compare Item

Delete All Compare Items

Contact Us

Submit an Enquiry

Newsletter

Subscribe to Newsletter

Admin API

Authentication

Admin Profile

Get Profile

Navigation

Menu

Permissions

Catalog

Products

List Products

Add-Product Search (Create-Order)

Catalog Product Detail

Create Product

Update Product

Delete Product

Copy Product

Mass Delete Products

Mass Update Status

Export Products (CSV)

Upload Image

Update Image

Reorder Images

Delete Image

Upload Downloadable File

Download Downloadable File

Upload Video

Delete Video

List Inventories

Update Inventories

List Customer-Group Prices

Add Customer-Group Price

Update Customer-Group Price

Delete Customer-Group Price

Categories

Categories Listing (Datagrid)

Categories Tree (Nested)

Category Detail

Create Category

Update / Move Category

Delete Category

Mass Delete Categories

Mass Update Status

Attributes

Attributes Listing (Datagrid)

Attribute Detail

Create Attribute

Update Attribute

Delete Attribute

Mass Delete Attributes

Attribute Options (CRUD)

Attribute Families

Families Listing (Datagrid)

Family Detail

Create Family

Update Family

Delete Family

Appearance

Themes

List Themes

Get Theme

Theme Impact

Activate Theme

Sections

List Sections

Get Section

Create Section

Update Section

Delete Section

Stage Edits

Stage Status

Stage Order

Copy Section

Publish

Discard

Section Fields

Upload Media

Preview

CMS

Pages

List Pages

Page Detail

Create Page

Update Page

Delete Page

Mass Delete Pages

Export Pages (CSV)

Sales

Orders

List Orders

Order Detail

Reorder

Cancel Order

Add Comment

List Comments

Create Invoice

Get Invoice

Print Invoice (PDF)

Send Duplicate Invoice

Create Shipment

Get Shipment

Create Refund

Refund Preview

Get Refund

Export Orders (CSV)

Carts

Get Cart

Add Item

Update Items

Remove Item

Save Address

Apply Coupon

Remove Coupon

List Shipping Methods

Set Shipping Method

List Payment Methods

Set Payment Method

Place Order

Invoices (Datagrid)

List Invoices

Get Invoice

Print Invoice (PDF)

Send Duplicate Invoice

Mass Update Status

Export Invoices (CSV)

Shipments (Datagrid)

List Shipments

Get Shipment

Export Shipments (CSV)

Refunds (Datagrid)

List Refunds

Get Refund

Export Refunds (CSV)

Returns (RMA)

List Returns

Get Return

Create Return

Update Status

Reopen Return

Returnable Items

Return Reasons

Return Messages

Send Return Message

EU Withdrawal

List EU Withdrawals

Get EU Withdrawal

Decline

Mark Refunded

Resend Confirmation

Transactions

List Transactions

Create Transaction

Export Transactions (CSV)

Bookings

List Bookings

Booking Detail

Export Bookings (CSV)

Customers

List Customers

Customer Detail

Create Customer

Update Customer

Delete Customer

Mass Delete

Mass Update Status

Addresses

List Addresses

Address Detail

Create Address

Update Address

Delete Address

Set as Default

Notes

Add Note

List Notes

Impersonate

Issue Impersonation Token

Customer Groups

List Groups

Group Detail

Create Group

Update Group

Delete Group

Mass Delete

Reviews

List Reviews

Review Detail

Review with Images

Update Status

Delete Review

Mass Delete

Mass Update Status

GDPR Requests

List Requests

Request Detail

Update Request

Delete Request

Process (Approve + Execute)

Download Data Export

Create-Order Helpers

Active Cart Items

Wishlist Items

Compare Items

Recent Order Items

Create Draft Cart

Settings

Locales

List

Detail

Create

Update

Delete

Mass Delete

Currencies

List

Detail

Create

Update

Delete

Mass Delete

Exchange Rates

List

Detail

Create

Update

Delete

Mass Delete

Update Rates

Inventory Sources

List

Detail

Create

Update

Delete

Mass Delete

Channels

List

Detail

Create

Update

Delete

Admin Users

List

Detail

Create

Update

Delete

Delete My Account

Roles

List

Detail

Create

Update

Delete

Tax Categories

List

Detail

Create

Update

Delete

Tax Rates

List

Detail

Create

Update

Delete

Export (CSV)

Return Reasons

List

Detail

Create

Update

Delete

Mass Delete

Mass Update Status

Return Rules

List

Detail

Create

Update

Delete

Mass Delete

Mass Update Status

Return Statuses

List

Detail

Create

Update

Delete

Mass Delete

Mass Update Status

Return Custom Fields

List

Detail

Create

Update

Delete

Mass Delete

Mass Update Status

Data Transfer Imports

List

Detail

Create

Update

Validate

Start

Link

Index

Stats

Download File

Download Error Report

Download Sample

Delete

Cancel

Dashboard

Statistics

Reporting

Overview

Sales

Customers

Products

Marketing

Promotions

Catalog Rules

List

Detail

Create

Update

Delete

Mass Delete

Cart Rules

List

Detail

Copy

Create

Update

Delete

Mass Delete

Cart Rule Coupons

List

Create

Bulk Generate

Delete

Mass Delete

Communications

Email Templates

List

Detail

Create

Update

Delete

Events

List

Detail

Create

Update

Delete

Campaigns

List

Detail

Create

Update

Delete

Send

Newsletter Subscribers

List

Detail

Toggle Subscription

Delete

Search SEO

URL Rewrites

List

Detail

Create

Update

Delete

Mass Delete

Search Terms

List

Detail

Update

Delete

Mass Delete

Search Synonyms

List

Detail

Create

Update

Delete

Mass Delete

Sitemaps

List

Detail

Create

Update

Delete

Regenerate

Configuration

Menu

Slugs

Values

Update

Playground Guide

Best Practices

On this page

Update Admin User

Partial. Permission: settings.users.edit.

Help us improve this page on Github.

Last Updated:

Pager

Previous pageCreate

Next pageDelete

Released under the MIT License.