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