Jump to Content
Apps
Themes
APIs and references
Changelog
Support
FeedBack
Home
Themes
Apps
v2022.01
v2024.07
v2025.06
v2026.01
Apps
Themes
APIs and references
Changelog
Support
FeedBack
Log in
Sign up
Apps
Log in
Sign up
v2025.06
Home
Themes
Apps
Product API FAQ
All
Pages
Start typing to search…
JUMP TO
BUILD APPS ON SHOPLAZZA
How To Create An APP
Overview
Application Classification
Quick Construction of Public Apps
1.Create a developer platform login account and register as a partner
2.Create A Public APP
3.Develop your application service
4.Test your app
5.Submit App for review
Quick Construction of Private Apps
How To Create An Payment APP
Overview
Getting started
Payment Callbacks API
Payment and Refund Notification
post
Complete Payment
post
Payment Flow Overview
Sale: Jump to Third-Party Payment
Iframe: Pop-up Payment
Card: Credit Card Direct Payment
Processing a Refund
App Review&Operation
App requirements
Prohibited app configurations
Installation and setup
Functionality and quality
App performance
App listing
App testcase
Security and merchant risk
Data and user privacy
App Support
App review process
App Review Rules
Common app rejections
App success
Managing app reviews
Supporting your app
Marketing your app through Shoplazza community
Marketing your app externally
Prohibited app actions
Unpublished APP
API Overview
Overview
API Usage
Authentication
Signature & Verification
Access Scopes
Rate limits
Pagination
API Public Parameters
Response status codes
Retrieve IDs
Webhooks
Developers tools
API libraries(SDK)
App Bridge
Overview
Actions
Overview
Contextual Save Bar
BackLink
Redirect
Session Token
AdminAPI
Online Store
Article
List Articles
get
Create Article
post
Get Article
get
Update Article
put
Delete Article
del
Count Articles
get
List Author
get
Blog
List Blogs
get
Create Blog
post
Get Blog
get
Update Blog
put
Delete Blog
del
Count Blog
get
Custom Page
Get Page List
get
Create Page
post
Get Page Details
get
Update Page
put
Delete Page
del
Get Page Count
get
Search Page
get
Batch Delete Pages
del
Batch Get Pages
post
OAuth
Get Access Scopes
get
Theme
Get Theme List
get
Get Theme Details
get
Delete Theme
del
Get Default Theme Details
get
Publish Theme
patch
Get Theme Task
get
Upgrade Specific Theme
post
Get Theme DocTree
get
Get Theme File
get
Create Theme File
post
Delete Theme File
del
Update Theme File
patch
Rename Theme File
put
Get Theme File Versions(Single File)
get
Get Theme File Version By Version Id
get
Get Theme File Versions(All File)
get
URL Redirects
Get Url Redirect List
get
Create Url Redirect
post
Get Url Redirect Details
get
Update Url Redirect
put
Delete Url Redirect
del
Search Url Redirect
post
Marketing
Coupon
Get Coupon List
get
Receive Coupons
post
Discount
Get Popup List
get
Get Sales Pop Config
get
Get Price Rule List
get
Create Price Rule
post
Get Price Rule
get
Update Price Rule
put
Delete Price Rule
del
Get Price Rule Count
get
Get Discount Code List
get
Create Discount Code
post
Batch Create Discount Code
post
Get Discount Code
get
Update Discount Code
put
Delete Discount Code
del
Search Discount Code
get
Get All Discount Code List
get
Get All Discount Flash Sale List
get
Get All Discount Rebate List
get
Customer
Address
Get Address List
get
Create Address
post
Get Address Details
get
Update Address
put
Delete Address
del
Set Default Address
put
Get Customer List
get
Create Customer
post
Get Customer Details
get
Update Customer
put
Get Customer Count
get
Data Analysis
Get Data Analysis
post
Get Data Analysis By SPU
post
File
Get File List
get
Create Upload File
post
Get Upload File Task
get
Get File Details
get
Delete File
del
Fulfillment
Create Fulfillment
post
Get Fulfillment Detail
get
Update Fulfillment
put
Complete Fulfillment
post
Cancel Fulfillment
post
Carrier Service
Get Carrier Service List
get
Create Carrier Service
post
Get Carrier Service Detail
get
Update Carrier Service
put
Delete Carrier Service
del
Get Fulfillment Count
get
Get Tracking Code List
get
Gift Card
Update Gift Card
put
Get Gift Card List
get
Create Gift Card
post
Get Gift Card Details
get
Disable Gift Card
post
Batch Create Gift Card
post
Inventory
Get Product Inventory Details
get
Get Inventory Item List
get
Get Variant Inventory Item List
get
Get Inventory Item
get
Update Inventory Item
put
Get Inventory Level List
get
Update Inventory Level
put
Create Inventory Level
post
Delete Inventory Level
del
Set Inventory Level
post
Procurement
Get Procurement List
get
Create Procurement
post
Get Procurement Details
get
Update Procurement
put
Get Procurement Item List
get
Batch Update Procurement Items
put
Batch Create Procurement Items
post
Batch Delete Procurement Items
del
Cancel Procurement
patch
Receive Procurement
patch
Supplier
Get Supplier List
get
Create Supplier
post
Get Supplier Details
get
Update Supplier
put
Location
List locations
get
Get location
get
Count locations
get
List inventory levels
get
Province
Get Province List
get
Create Province
post
Delete Province
del
Get Sub Area List
get
Metafield
Get Metafield List
get
Create Metafield
post
Get Metafield
get
Update Metafield
patch
Delete Metafield
del
Get Metafield Count
get
Metafield Definition
List Metafield Definitions
get
Create Metafield Definition
post
Update Metafield Definition
put
Delete Metafield Definition
del
Metafield definition Detail
get
Count Metafield by Definition
get
Metafield Definition Count By Group
get
Order
Get Order List
get
Create Order
post
Get Order Detail
get
Update Order
put
Delete Order
del
Cancel Order
post
Get Order Details By Number
get
Get Order Count
get
Get Post Sale Order List
get
Delete Post Sale Order
del
Pay Order Success
post
Order Risk
Get Order's Risk Assessment Information
get
Create Order Risk
post
Get Order Risk Detail
get
Update Order Risk
put
Delete Order Risk
del
Get Order Risk List
get
Payment Channels
get all available payment channels of stores
get
Transaction
Get Order Transaction List
get
Refund
Get All Refund Record List
get
Get Refund Order Count
get
Get Order's Refund Record
get
Create Order's Refund Record
post
Order FAQ
Product
List Products
get
Create Product
post
Count Products
get
Get Product
get
Delete Product
del
Update Product
put
Category
List Categories
get
Collect
Get Collect List
get
Create Collect
post
Get Collect Count
get
Get Collect Details
get
Delete Collect
del
Batch Create Collect
post
Collection
Get Collection List
get
Create Collection
post
Get Collection Count
get
Get Collection Details
get
Update Collection
put
Delete Collection
del
Comment
Create Comment
post
Batch Create Comment
post
Get Comment List
get
Product Image
Get Product Image List
get
Create Product Image
post
Get Product Image Details
get
Update Product Image
put
Delete Product Image
del
Get Product Image Count
get
Variant
List Variants
get
Create Variant
post
Get Variant
get
Update Variant
put
Delete Variant
del
Count Variants
get
Update Variant By SKU
put
List Variants By SKU
get
Product API FAQ
Script Tag
Get Script Tag List
get
Create Script Tag
post
Get Script Tag
get
Update Script Tag
put
Delete Script Tag
del
Get Script Tag Count
get
Shop
Get Shop Details
get
Update Shop Details
patch
Shoplazza Payments
Get Payment Order list
get
Get Payment Order Details
get
Get Dispute list
get
Get Dispute Details
get
Get Refund Order List
get
Get Refund Order Details
get
Get Settlement List
get
Get Reserved Fund details List
get
Get Payout Details List
get
Tracking
Get Carrier List
get
Detected Carrier By The Tracking Number
get
Shipping
Available Shipping Lines
post
BILLING API
One Time Application Charge
List One Time Application Charge
get
Create One Time Application Charge
post
Get One Time Application Charge Detail
get
List One Time Application Charge Transaction
get
Recurring Application Charge
List Recurring Application Charge
get
Create Recurring Application Charge
post
Get Recurring Application Charge Detail
get
Update Recurring Application Charge
put
Cancel Recurring Application
del
List Recurring Application Transaction
get
Usage Charge
Get Usage Charge List
get
Create Usage Charge
post
Get Usage Charge
get
App Charge Transaction
Get App Charge Transaction
get
webhook
Webhook Events
Webhook
Webhook Properties
List webhooks
get
Create a webhook
post
Get a webhook
get
Update a webhook
put
Delete a webhook
del
Count webhooks
get
QA
Where can I ask questions
How do I ask questions
Some common questions
Product API FAQ
Ask AI
