Jump to Content

Home Guides API Reference Changelog

v2.327.0

Guides

v2.327.0

Supplier

API instructions for use

How to get access_token
OpenAPI request example
[Notice] 即將發生的 API / Webhook 異動 (Breaking Changes)
Release Note

Token

Get Token Info

Orders

Get Orders
Get Order
Search Orders
Get Order Labels for Delivery
Update Order Status
Update Order Delivery Status
Update Order Payment Status
Update Order
Create Order
Execute Shipment
Bulk Execute Shipment
Update Order Tags
Get Order Tags
Get Action Logs
Get Order Transactions
Split Order
Cancel Order
Get Archived Orders
- Webhook Verification

Customer

Get Customers
Get Customer
Search Customers
Update Customer
Create Customer
Update Customer Store Credits
Update Customer Member Points
Get Customer Store Credit History
Delete Customer
Add or Remove Customer tags
Update Customer tags
Get Customer Member points History
Get Customer Promotions
Get Customer IDs of User Coupons

Customer Group

Get Customer Groups
Search Customer Groups
Get Customer IDs of Customer Group

Customers Store Credits

Get Customers Store Credits

CustomFields

Get Custom Fields

MembershipTiers

Get Membership Tiers
Get Customer Membership Tier History

Member Point Rules

Get Member Point Rules

Conversations

Get Conversations
Get Conversation Messages
Create Order Message
Create Shop Message

Category

Get Categories
Get Category
Create Category
Update Category
Delete Category

Products

Get Products
Get Product
Search Products
Update Product Quantity
Update Product Variation Quantity
Update Product Price
Update Product Variation Price
Update Product, Product Variation Quantity by SKU
Create Product
Update Product
Add Product Images
Delete Product Images
Add Product Variation
Update Product Variation
Delete Product
Delete Product Variation
Bulk Assign Product to Category
Add or Remove Product tag
Get Locked Inventory Count

Gifts

Get Gifts
Update Gift Quantity
Update Gifts Quantity by SKU
Search Gifts
Create Gifts
Update Gifts

Addon Products

Get AddonProducts
Update AddonProduct Quantity
Update AddonProduct Quantity by SKU
Search Addon Products
Create AddonProducts
Update AddonProducts

Promotions

Get Promotion
Get Promotions
Create Promotions
Update Promotion
Delete Promotion
Search Promotions
Send Coupon
Redeem Coupon
Claim Coupon

Settings

Get Apps Setting
Update App Settings
Get Order Setting
Get Users Setting
Get Checkout Setting
Get Tax Setting

Payment

Get Payment options
Get Payment option

Delivery Options

Get Delivery Options
Get Delivery Option
Update pickup store in delivery options
Get Delivery Time Slots

Specific Column Type

Merchant

Get Merchants
Get Merchant
Update Merchant

Staff

Get Staff Permission
Get Staff List
Get Staff

Tax

Get Taxes

Product Review Comments

Get Product Review Comments
Get Product Review Comment
Update Product Review Comment
Bulk Update Product Review Comments
Create Product Review Comment
Bulk Create Product Review Comments
Delete Product Review Comments
Bulk Delete Product Review Comments

Agents

Entity
Get Agents

Channel

Get Channels
Get Channel

Warehouse

Get Warehouse
Get Stock/Quantity for Warehouse (Product/Gift/Add-on)
Update Stock/Quantity for Warehouse (Product/Gift/Add-on Product)
Bulk Update Stock for Warehouse

Return Order

Create Return Order
Update Return Order
Get Return Orders
Get Return Order By id

Product Subscription

Get Product Subscriptions
Get Product Subscription

Media

Create Media

Webhooks

Webhook Topic and Payload Examples
Create Webhook
Get Webhooks
Get Webhook
Update Webhook
Delete Webhook
Webhook Implementation Best Practices

Order Delivery

Update order delivery
Get Order delivery

Flash Price Campaign

Get flash price campaign
Create flash price campaign
Get flash price campaign by id
Update Flash Price Campaign
Delete Flash Price Campaign

Affiliate Campaign

Get Affiliate Campaign
Get Affiliate Campaigns
Create Affiliate Campaign
Update Affiliate Campaign
Delete Affiliate Campaign
Get Affiliate Campaign Order Usage

Live Streaming

Add Live Products
Remove Livestream Product
Update Product and Variation Keywords
Get Livestream Products and Variations
Get Live Comments
Get Comment Customers

Metafields

Merchant App Metafields
Product App Metafields
Order App Metafields
Customer App Metafields
Order Item App Metafields
Metafield Definitions
Merchant Metafields
Product Metafields
Order Metafields
Customer Metafields
Order Item Metafields

Purchase Orders

Get Purchase Orders
Get Purchase Order
Create Purchase Order
Delete Purchase Orders

Powered by

Supplier

Data Structure of Supplier

Field	Column Type	Description	Example 1
id	`String`
name_translations	Translation
wapos_id	`String`

Updated 3 months ago

Product Variant Option