Jump to Content
Apps
Themes
APIs and references
Changelog
Support
FeedBack
Home
Themes
Apps
v2022.01
v2024.07
v2025.06
Apps
Themes
APIs and references
Changelog
Support
FeedBack
Log in
Sign up
Apps
Log in
Sign up
v2022.01
Home
Themes
Apps
Function APIs
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 Payments APP
Overview
Getting started
Payment Flow Overview
Sale: Jump to Third-Party Payment
Iframe: Pop-up Payment
Card: Credit Card Direct Payment
Processing a Refund
Payment Callbacks API
Complete Payment
post
Payment and Refund Notification
post
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
ADMIN API
Overview
Data Dictionary
Get Province List
get
Shoplazza Payments
List Payment Orders
get
Get Payment Order
get
List Disputes
get
Get Dispute
get
List Refunds
get
Get Refund
get
List Settlement Details
get
List Reserved fund Details
get
List Payout Details
get
Shop&Settings
Shop Info
Shop Properties
Shop Details
get
Update Shop
patch
Material File
File Properties
Create Upload File Task
post
Get Upload File Task
get
Get File List
get
Get File Details
get
Delete File
delete
Online Store
Theme
Theme Properties
Upload Theme
post
Get Theme
get
Get Theme List
get
Download Theme
get
Get Default Theme
get
Publish Theme
patch
Delete Theme
delete
Get Theme Doctree
get
Get Theme File
get
Create Theme File
post
Update Theme File
patch
Delete Theme File
delete
Upload Theme Static Assets
post
Custom Page
Custom Page Properties
Create Page
post
Get Page Details
get
Get Page List
get
Count Page
get
Update Page
put
Delete Page
delete
URL Redirects
URL Redirects Properties
Create Redirect
post
Redirect Detail
get
Redirect List
get
Search Redirect
post
Update Redirect
put
Delete Redirect
delete
Product
Product Properties
Create Product
post
Product List
get
Product Total Count
get
Product Details
get
Update Product
put
Delete Product
delete
Variant
Variant Properties
Create Variant
post
Variant List
get
Variant Total Count
get
Variant Details
get
Variant List By SKU
get
Update Variant
put
Update Variant By SKU
put
Delete Variant
delete
Image
Image Properties
Create Product Image
post
Product Image List
get
Product Image Count
get
Product Image Details
get
Update Product Image
put
Delete Product Image
delete
Collection
Collection Properties
Create Collection
post
Collection List
get
Collection Count
get
Collection Details
get
Update Collection
put
Delete Collection
delete
Create Collect
post
Collect List
get
Collect Count
get
Collect Details
get
Delete Collect
delete
Comment
Comment Properties
Create Comment
post
Batch Create Comment
post
Get Comment List
get
Inventory
Inventory Properties
Get Product Inventory Detail
get
Supplier
Supplier Properties
Create Supplier
post
List Suppliers
get
Get Supplier Detail
get
Update Supplier
put
Procurement
Procurement Properties
Create Procurement
post
List Procurements
get
Get Procurement Detail
get
Update Procurement
put
Cancel Procurement
patch
Receive Procurement
patch
List Procurement Items
get
Batch Create Procurement Items
post
Batch Update Procurement Items
put
Batch Delete Procuremnt Items
delete
Order
Order FAQ
Order Properties
Create Order
post
Order List
get
Order Count
get
Order Details
get
Get Order Details By Number
get
Update Order
put
Delete Order
delete
Cancel Order
post
Order Payment Success
post
After Sales List
get
Delete Post Sale Order
delete
Refund
Refund Properties
Refund List
get
Refund List By Order
get
Refund List Count
get
Full Order Refund
post
Partial Order Refund
post
Order Risk
Order Risk Properties
Create Order Risk
post
Order Risk Detail
get
Order Risk List
get
Order Risk
get
Update Order Risk
put
Delete Order Risk
delete
Fulfillment
Fulfillment Properties
List Tracking Codes
get
Create Fulfillment
post
Fulfillment List
get
Fulfillment Total Count
get
Fulfillment Details
get
Update Fulfillment
put
Complete Fulfillment
post
Cancel Fulfillment
post
CarrierService
CarrierService Properties
Create CarrierService
post
Update CarrierService
put
Get CarrierService Detail
get
Get CarrierService List
get
Delete CarrierService
delete
Transaction
Transaction Properties
Transaction List
get
Customer
Customer Properties
Create Customer
post
Customer List
get
Customer Count
get
Customer Details
get
Update Customer
put
Address
Address Properties
Create Address
post
Get Address List
get
Get Address Details
get
Update Address
put
Delete Address
delete
Set Default Address
put
Marketing
Discounts
Discount Properties
Create Price Rule
post
Price Rule List
get
Price Rule Count
get
Price Rule Detail
get
Update Price Rule
put
Delete Price Rule
delete
Create Discount Code
post
Get Discount Code Details
get
Get Discount Code List
get
Discount Code List
get
Search Discount Code
get
Update Discount Code
put
Delete Discount Code
delete
Popup List
get
Discount Rebate List
get
Discount Flashsale List
get
Get Salespop Datagraph
get
Get Salespop Config
get
Coupon
Coupon Properties
Coupon List
get
Receive Coupons
post
Gift Card
Gift Card Properties
Create Gift Card
post
Get Gift Card Details
get
Gift Card List
get
Update Gift Card
put
Disable Gift Card
post
Metafield
Metafield Properties
Create Metafield Definition
post
Metafield Definition Detail
get
Metafield Definition List
get
Metafield Definition Count
get
Metafield Definition By Group Count
get
Update Metafield Definition
put
Delete Metafield Definition
delete
Create Matefield
post
Get Metafield Details
get
Get Metafield List
get
Get Metafields Count
get
Update Matefield
patch
Delete Metafield
delete
App Proxy
APP Proxy Properties
APP Proxy FAQ
Get App Proxy List
get
Create App Proxy
post
App Proxy Count
get
Delete App Proxy
delete
App Proxy Details By ID
get
Data Query Task
Data Query Task Properties
Create Data Query Task
get
Data Query Task Details
get
Data Query Task Count
get
Data Query Tasks List
get
Script Tag
Script Tag Properties
Create Script Tag
post
Get Script Tag
get
Get Script Tag List
get
Get Script Tag Count
get
Update Script Tag
put
Delete Script Tag
delete
Data Analysis
Data Analysis Properties
Get Data Analysis
get
Data Analysis By SPU
post
Center API
Overview
POS
Overview
List Draw Count
get
Inventory
List Inventory Loss Quantity
get
List Inventory Cost Price
get
Stock Adjust
Stock Adjust Order Properties
Stock Adjust Order List
get
Stock Adjust Order Detail
get
Stock Adjust Order Products List
get
Transfer
Transfer Order Properties
Transfer Order List
get
Transfer Order Detail
get
Transfer Order Product List
get
Procurement
Procurement Order Properties
Procurement List
get
Procurement Order Detail
get
Procurement Order Product List
get
Billing API
Overview
Billing API FAQ
How to integrate with the Billing API
APIs' Properties and Flow
One Time Application Charge
Application Charge Properties
Create Application Charge
post
Get Application Charge Detail
get
Get Application Charge List
get
Recurring Application Charge
Recurring Application Charge Properties
Create Recurring Aplication Charge
post
Get Recurring Application Charge
get
Get Recurring Application Charge List
get
Update The Capped Amount Of Recurring Application Charge
put
Cancel Recurring Application Charge
delete
Usage Charge
Usage Charge Properties
Create Usage Charge
post
Get Usage Charge
get
Get Usage Charge List
get
Customer Privacy API
Consent Tracking
Webhook
Webhook Events
Products
Products create
Products update
Products delete
Collections
Collections create
Collections update
Collections delete
Cart
Cart create
Cart update
Orders
Orders create
Orders update
Orders paid
Orders partially_fulfilled
Orders fulfilled
Orders finished
Orders partially_refunded
Orders refunded
Orders cancelled
Orders delete
Fulfillments
Fulfillments create
Fulfillments update
Customers
Customers create
Customers update
App
App uninstalled
App expired
App purchases_one_time_update
App subscriptions_update
App subscriptions_approaching_capped_amount
Webhook APIs
Webhook Properties
Create Webhook
post
Webhook Count
get
Webhook List
get
Webhook Details
get
Update Webhook
put
Delete Webhook
delete
OpenAPI
After Sale
Discount Code
List Code Campaign
get
Update Code Campaign
put
Create Code Campaign
post
Delete Code Campaign
delete
Get Code Campaign Detail
get
Get Code Campaign Detail By Code
get
Cancel Code Campaign
patch
List Code
get
Add Code
post
Delete Code
delete
Fulfillment
Create Fulfillment
post
Get Fulfillment
get
Update Fulfillment
put
Cancel Fulfillment
post
Tracking
Get carrier list
get
Detected a carrier for the tracking number
get
Function API
Overview
Function Input and Output Protocol
Tutorial of Function and Function API
Function APIs
CART TRANSFORM API
Overview
QA
Where can I ask questions
How do I ask questions
Some common questions
Function APIs
📘
For Function APIs, Please view
2024.07 version.
