Show Menu
Search…
Ctrl+K
ESC
Example searches: “object”, “key”, “string”, “number”, “buttonText”
Toggle dark mode
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Topics
Introduction
Authentication
Endpoints
PublicPageInfo
Get all the needed information for main page of the shop
Get all the needed information for products page of the shop
Get all the needed information for product page of the shop
Get all the needed information for feedbacks page of the shop
Get all the needed information for announcement page of the shop
Get all the needed information for faqs page of the shop
Products
GET /self/{shopId}/products
DELETE /self/{shopId}/products/{productId}
PUT /self/{shopId}/products/bulk/update/custom-fields
PUT /self/{shopId}/products/bulk/update/customer-note
PUT /self/{shopId}/products/bulk/update/visibility
PUT /self/{shopId}/products/bulk/update/discord-integration
POST /self/{shopId}/products/bulk/delete
AffiliatesDashboard
GET /self/{shopId}/affiliates/stats
GET /self/{shopId}/affiliates
POST /self/{shopId}/affiliates/{customerId}/referral/disable
Customization
PUT /self/{shopId}/customization/design
PUT /self/{shopId}/customization/widgets
PUT /self/{shopId}/customization/storefront
POST /self/{shopId}/customization/storefront/background
PUT /self/{shopId}/customization/seo
POST /self/{shopId}/customization/seo/image
POST /self/{shopId}/customization/seo/favicon
POST /self/{shopId}/customization/logo
PUT /self/{shopId}/customization/links
GET /self/{shopId}/customization
Blacklist
Create Blocked Item
Get Blocked Item
Get All
Edit Blocked Item
Delete Blocked Item
AnalyticsVisits
GET /self/{shopId}/analytics/visits/real-time
Announcements
Edit Announcement
Get all
Create Announcement
Delete Announcement
Categories
Get All
Create Category
Get Category
Edit Category
Delete Category
Coupons
Get All
Create Coupon
Get Coupon
Edit Coupon
Delete Coupon
Shop
GET /self/shops
POST /self/shops
DesignShopSettings
PUT /self/{shopId}/settings/design
PUT /self/{shopId}/settings/design/storefront
POST /self/{shopId}/settings/design/storefront/logo
POST /self/{shopId}/settings/design/logo
PUT /self/{shopId}/settings/design/links
Dashboard
GET /self/{shopId}/dashboard/general
GET /self/{shopId}/dashboard/advanced
Faqs
POST /self/{shopId}/faqs
GET /self/{shopId}/faqs
PUT /self/{shopId}/faqs/{faqId}
DELETE /self/{shopId}/faqs/{faqId}
Feedbacks
GET /self/{shopId}/feedbacks
GET /self/{shopId}/feedbacks/appeals
GET /self/{shopId}/feedbacks/{feedbackId}
POST /self/{shopId}/feedbacks/{feedbackId}/answer
POST /self/{shopId}/feedbacks/{feedbackId}/appeal
Groups
GET /self/{shopId}/groups
POST /self/{shopId}/groups
GET /self/{shopId}/groups/{groupId}
PUT /self/{shopId}/groups/{groupId}
DELETE /self/{shopId}/groups/{groupId}
POST /self/{shopId}/groups/{groupId}/thumbnail
Orders
Get all invoices
Get invoice
Resend email to customer
Replace invoice
Process invoice
Listings
GET /self/{shopId}/listings
PUT /self/{shopId}/listings/position
Tickets
Get all tickets
GET /self/{shopId}/tickets/{ticketId}
POST /self/{shopId}/tickets/{ticketId}/message
POST /self/{shopId}/tickets/{ticketId}/close
ProductsV2
Get products
Create a new product
Update product thumbnail
Update seo image
Get product
Update product
Bulk payment-methods update
Customers
GET /self/{shopId}/customers
GET /self/{shopId}/customers/stats
GET /self/{shopId}/customers/{customerId}
Add a balance to customer account
Remove balance from customer account
GET /self/{shopId}/customers/{customerId}/ips
GeneralShopSettings
PUT /self/{shopId}/settings/name
PUT /self/{shopId}/settings/subdomain
PUT /self/{shopId}/settings/currency
PUT /self/{shopId}/settings/password
PUT /self/{shopId}/settings/timezone
PUT /self/{shopId}/settings/status
PUT /self/{shopId}/settings/popup
PUT /self/{shopId}/settings/terms
GET /self/{shopId}/settings
PaymentsShopSettings
PUT /self/{shopId}/settings/payments/coinbasecommerce
PUT /self/{shopId}/settings/payments/virtual-payments
PUT /self/{shopId}/settings/payments/buy-me-coffee
PUT /self/{shopId}/settings/payments/balance
PUT /self/{shopId}/settings/payments/stripeconnect
PUT /self/{shopId}/settings/payments/paypalemail
PUT /self/{shopId}/settings/payments/cashapp
PUT /self/{shopId}/settings/payments/paypal-ff
PUT /self/{shopId}/settings/payments/square
Dismiss highlight
Show more
Tickets
Manage tickets