Skip to content
OpenShop
Search
Ctrl
K
Cancel
GitHub
Start Here
Quickstart
FAQ
Web Components
Overview
Cart Button
Cart Slideout
Product Details
Product List
Referral Tracker
Single Product Card
Tutorials
Webflow with Open Shop
MCP
Overview
Claude Desktop
ChatGPT
Open WebUI
API Reference
OpenShop API (Admin)
Overview
user
/admin/user/all
GET
/admin/user/me
GET
store
/admin/store/all
GET
/admin/store/settings
GET
/admin/store/settings
PATCH
/admin/store/payment-provider/all
GET
/admin/store/payment-provider
POST
/admin/store/payment-provider
PATCH
/admin/store/tax-provider
GET
/admin/store/tax-provider
PATCH
/admin/store/commission-provider
GET
/admin/store/commission-provider
PATCH
customer
/admin/customer/paged
GET
/admin/customer/account-type/all
GET
/admin/customer
GET
/admin/customer
POST
/admin/customer/order/paged
GET
/admin/customer/import/template
GET
/admin/customer/email-check
GET
/admin/customer/search
GET
order
/admin/order/paged
GET
/admin/order/unfulfilled/count
GET
/admin/order/details
GET
/admin/order
POST
/admin/order
PATCH
/admin/order/sync
POST
/admin/order/export
GET
/admin/order/pdf
GET
/admin/order/refund
POST
/admin/order/shipping-methods
GET
/admin/order/item/summary
GET
/admin/order/summary
GET
/admin/order/fulfill
POST
/admin/order/resend-shipment-email
POST
product
/admin/product/paged
GET
/admin/product
GET
/admin/product
POST
/admin/product
PATCH
/admin/product/tax-class/all
GET
/admin/product/tax-class
POST
/admin/product/tax-class
DELETE
/admin/product/tax-class
PATCH
/admin/product/browse/paged
GET
scope
/admin/scope/me
GET
/admin/scope/all
GET
/admin/scope
GET
/admin/scope
PUT
login
/admin/login
POST
language
/admin/language/all
GET
media
/admin/media
POST
/admin/media
DELETE
/admin/media
PATCH
/admin/media/folder
POST
/admin/media/folder
DELETE
/admin/media/folder
PATCH
/admin/media/folder/paged
GET
/admin/media/paged
GET
store-customer
/admin/store-customer
PATCH
price
/admin/price/reference
GET
integration-log
/admin/integration-log/paged
GET
/admin/integration-log
GET
coupon
/admin/coupon/paged
GET
/admin/coupon
GET
/admin/coupon
POST
/admin/coupon
PATCH
/admin/coupon/usage
GET
collection
/admin/collection/check
GET
/admin/collection
POST
/admin/collection
DELETE
integration-task
/admin/integration-task/paged
GET
/admin/integration-task/retry
POST
email
/admin/email/test
POST
email-template
/admin/email-template/paged
GET
/admin/email-template
PATCH
email-template-type
/admin/email-template-type/all
GET
dashboard
/admin/dashboard
GET
subscription
/admin/subscription/paged
GET
/admin/subscription
GET
/admin/subscription
PATCH
/admin/subscription/process/all
POST
/admin/subscription/retry
POST
/admin/subscription/cancel
POST
subscription-plan
/admin/subscription-plan/all
GET
pdf-template
/admin/pdf-template/paged
GET
/admin/pdf-template
PATCH
/admin/pdf-template/preview
POST
pdf-template-type
/admin/pdf-template-type/all
GET
customer-payment-method
/admin/customer-payment-method/all
GET
shipment
/admin/shipment
PATCH
OpenShop API (Customer)
Overview
user
get my user
GET
Change Email Request
POST
Commit Email Change
PATCH
Logout
POST
Check Available
POST
Verify User Password
POST
Resend Verify Email Pin
POST
Forgot Password
POST
Change Password
POST
Reset Password
POST
Verify Email
POST
Delete Me
POST
Update my customer user
PATCH
Fetch User Commission SSO Url
GET
store
Store Login
POST
Get Store Overview for the Site
GET
product
Get Product Card Details
GET
Get Full Product Details
GET
Get Product Paged
GET
cart
Add Item To Cart
POST
Delete an Item from the Cart
DELETE
Updates a Cart Item
PATCH
Get a Cart Summary
GET
collection
Get all collections
GET
checkout
Checkout Payment Methods
GET
Checkout Cart
POST
Get Shipping Methods
GET
Generates a Crypto Payment Link
POST
order
Order Details
GET
Get an Order Summary
GET
Customer Order History Paged
GET
referrer
Get Referrer Details
GET
user-address
Get a user's addresses
GET
Create User Address
POST
DELETE User address
DELETE
Update an Address
PATCH
Set default address
PATCH
customer-payment-method
Get customer payment method intent
GET
Save payment method
POST
Delete a payment method
DELETE
Get customer payment methods
GET
Set Card to default
PATCH
subscription
Get user subscriptions
GET
Cancel Subscription
POST
Get Subscription Details
GET
Update Subscription
PATCH
Get Subscription Estimate
GET
GitHub
get my user
GET
/admin/user/me
Get my user
Responses
Section titled “ Responses ”
200
Section titled “200 ”
Get my user
Select media type
application/json
object
id
number
firstName
Any of:
string
null
string
null
lastName
Any of:
string
null
string
null
email
string
lastLoginOn
Any of:
string
null
string
null
createdOn
string
adminPhoneNumber
Any of:
string
null
string
null
adminPhoneCountry
Any of:
unknown
null
null
