Jump to Content
Home
Home
Guides
API Reference
Changelog
Discussions
v2.36.0
v2.79.0
v2.80.0
v2.80.1
v2.80.2
v2.80.3
v2.81.0
v2.81.1
v2.81.2
v2.81.3
v2.82.0
v2.82.1
v2.82.2
v2.82.3
v2.82.4
v2.82.5
v2.82.6
v2.82.7
v2.82.8
v2.82.9
v2.82.10
v2.82.11
v2.82.12
v2.82.13
v2.82.14
v2.82.15
v2.82.16
v2.82.17
v2.82.18
v2.82.19
v2.82.20
v2.82.21
v2.82.22
v2.82.23
v2.143.0
v2.165.0
v2.166.0
v2.166.1
v2.167.0
v2.167.1
v2.168.0
v2.169.0
v2.170.0
v2.170.1
v2.175.1
v2.179.0
v2.186.0
v2.208.0
v2.209.1
v2.212.0
v2.215.0
v2.219.0
v2.222.0
v2.224.0
v2.227.0
v2.228.0
v2.229.0
v2.230.0
v2.231.0
v2.232.0
v2.233.0
v2.234.0
v2.235.1
v2.236.0
v2.237.0
v2.237.2
v2.238.0
v2.239.0
v2.240.0
v2.241.0
v2.242.0
v2.243.0
v2.243.1
v2.244.0
v2.245.0
v2.246.0
v2.247.0
v2.251.0
v2.252.0
v2.252.1
v2.253.0
v2.254.0
v2.255.0
v2.255.2
v2.256.0
v2.257.0
v2.259.0
v2.260.0
v2.261.0
v2.263.0
v2.264.0
v2.265.0
v2.266.0
v2.267.0
v2.268.0
v2.269.0
v2.270.0
v2.271.0
v2.272.0
v2.273.0
v2.274.0
v2.275.0
v2.276.0
v2.277.0
v2.278.0
v2.279.0
v2.280.0
v2.281.0
v2.282.0
v2.283.0
v2.284.0
v2.284.1
Home
Log In
API Reference
Log In
v2.284.1
API Reference
private
Search
JUMP TO
SHOPLINE Open API
Addon Products
Get Addon Products
get
Create Addon Product
post
Search Addon Products
get
Get Addon Product
get
Update Addon Product
put
Update Addon Product Quantity
put
Bulk Update Addon Product Quantity by SKU
put
Get Addon Product Stocks
get
Update Addon Product Stock
put
Affiliate Campaigns
Get Affiliate Campaigns
get
Create Affiliate Campaign
post
Get Affiliate Campaign
get
Update Affiliate Campaign
put
Delete Affiliate Campaign
delete
Get Affiliate Campaign Orders
get
Get Affiliate Campaign Summary
get
Get Products Sales Ranking of Campaign
get
Export Affiliate Campaign Report to Partner
post
Merchant App Metafields
Create specific app metafield
post
Get app metafields attached to current merchant
get
Get specific app metafield
get
Update specific app metafield
put
Delete specific app metafield
delete
Bulk create app metafield
post
bulk update app metafield
put
bulk delete app metafield
delete
Product App Metafields
Create specific metafield
post
Get app metafields attached to specific product
get
Get specific app metafield
get
Update specific app metafield
put
Delete specific app metafield
delete
Bulk create app metafield
post
bulk update app metafield
put
bulk delete app metafield
delete
Order App Metafields
Create specific app metafield
post
Get app metafields attached to specific order
get
Get specific app metafield
get
Update specific app metafield
put
Bulk create app metafield
post
bulk update app metafield
put
bulk delete app metafield
delete
Customer App Metafields
Create specific app metafield
post
Get app metafields attached to specific customer
get
Get specific app metafield
get
Update specific app metafield
put
Delete specific app metafield
delete
Bulk create app metafield
post
bulk update app metafield
put
bulk delete app metafield
delete
Order Item App Metafields
Get app metafields attached to order items of specific order
get
Bulk create app metafield
post
bulk update app metafield
put
bulk delete app metafield
delete
Cart Item App Metafields
Get app metafields attached to cart items of specific cart
get
Bulk create app metafield
post
bulk update app metafield
put
bulk delete app metafield
delete
Bulk Operations
Get Bulk Operations
get
Get a Bulk Operation
get
Categories
Get Categories
get
Create Category
post
Get Category
get
Update Category
put
Delete Category
delete
Bulk Assign
post
Bulk Update Category Product Sorting
put
Conversations
Get Conversations
get
Get Messages
get
Create Shop Message
post
Create Order Message
post
Customer Group Children
Get Children Group of the Customer Group
get
Get customer ids of the specific customer group.
get
Customer Groups
Get Customer Groups
get
Get Customer Group
get
Search Customer Groups
get
Get customer ids of the specific customer group.
get
Customers
Get Customers
get
Create Customer
post
Search Customers
get
Get Customers's Membership Info
get
Get Customer
get
Update Customer
put
Delete Customer
delete
Update Customer Store Credits
post
Get Customer Store Credit History
get
Update Customer Member Points
post
Get Customer member points History
get
Update customer tags
put
Add or remove customer tags
patch
Update customer subscriptions
put
Get Line Customer
get
Custom Fields
Get Custom Fields
get
Delivery Options
Get Delivery Options
get
Get Delivery Option
get
Update Delivery Option(Store Pickup)'s Store Information
put
Get Delivery Time Slots
get
Get Delivery Config
get
Flash Price Campaigns
Get Flash Price Campaigns
get
Create Flash Price Campaign
post
Get a Flash Price Campaign
get
Update Flash Price Campaign
put
Delete Flash Price Campaign
delete
Gifts
Get Gifts
get
Create Gift
post
Search Gifts
get
Update Gift
put
Update Gift Quantity
put
Bulk Update Quantity by SKU
put
Get Gift Stocks
get
Update Gift Stock
put
Medias
Create image
post
Membership Tiers
Get Customer Membership Tier History
get
Get Membership Tiers
get
Member Points
Bulk Update Member Points
post
Merchants
Get Merchants
get
Get Merchant
get
Generate Merchant's express cart link
post
Merchant Metafields
Create specific metafield
post
Get metafields attached to current merchant
get
Get specific metafield
get
Update specific metafield
put
Delete specific metafield
delete
Bulk create metafield
post
bulk update metafield
put
bulk delete metafield
delete
Product Metafields
Create specific metafield
post
Get metafields attached to specific product
get
Get specific metafield
get
Update specific metafield
put
Delete specific metafield
delete
Bulk create metafield
post
bulk update metafield
put
bulk delete metafield
delete
Order Metafields
Delete specific app metafield
delete
Create specific metafield
post
Get metafields attached to specific order
get
Get specific metafield
get
Update specific metafield
put
Delete specific metafield
delete
Bulk create metafield
post
bulk update metafield
put
bulk delete metafield
delete
Customer Metafields
Create specific metafield
post
Get metafields attached to specific customer
get
Get specific metafield
get
Update specific metafield
put
Delete specific metafield
delete
Bulk create metafield
post
bulk update metafield
put
bulk delete metafield
delete
Order Item Metafields
Get metafields attached to order items of specific order
get
Bulk create metafield
post
bulk update metafield
put
bulk delete metafield
delete
Orders
Get Orders
get
Create Order
post
Get Order
get
Update Order
patch
Search Orders
get
Split Order
post
Update Order Status
patch
Update Order Delivery Status
patch
Update Order Payment Status
patch
Get Order Labels of Delivery
get
Execute Shipment
patch
Bulk Execute Shipment
patch
Update order tags
put
Get order transaction by orderIds
get
Get order action logs
get
Get all orders tags
get
Cancel Order
patch
Create Archived Orders Report
post
Payments
Get Payments
get
Get Payment
get
Purchase Orders
Get purchase orders
get
Create purchase order
post
Get the specified purchase order
get
Update purchase order
put
Delete the specified purchase orders
put
Product Review Comments
Get Product Review Comments
get
Create Product Review Comments
post
Get Product Review Comment
get
Update Product Review Comment
put
Delete Product Review Comment
delete
Bulk Create Product Review Comments
post
Bulk Update Product Review Comments
put
Bulk Delete Product Review Comments
delete
Products
Get Products
get
Create Product
post
Search Products
get
Get Product
get
Update Product
put
Delete Product
delete
Update (replace) current product tags
put
Update (add/remove) current product tags
patch
Update Product Quantity
put
Update Product Variation Quantity
put
Update Product Price
put
Update Product Variation Price
put
Update Quantity by SKU
put
Add Product Images
post
Delete Product Images
delete
Create Product Variation
post
Update Product Variation
put
Delete Product Variation
delete
Get Locked Inventory Count
post
Bulk Delete Product
delete
Bulk Publish/Unpublish Product in Online Store
put
Bulk Publish/Unpublish Product in Retail Store
put
Bulk Update Stock
put
Batch Update (add/remove) current product labels
patch
ProductSubscriptions
Get a list of product subscriptions
get
Get Product Subscription
get
Promotions
Get Customer Promotions
get
Get Customer Coupon Promotions
get
Get Promotions
get
Create Promotion
post
Search Promotions
get
Get Promotion
get
Update Promotion
put
Delete Promotion
delete
Return Orders
Get return orders
get
Create return order
post
Get return order
get
Update return order
put
Sales
Create sale products
post
Update sale products
put
Get sale products
get
Delete sale products
post
Get sale comments
get
Get sale customers
get
Settings
Get Setting
get
Get Orders Setting
get
Get Checkout Setting
get
Get Users Setting
get
Get Tax Setting
get
Get Third Party Ads Setting
get
Get Layouts Setting
get
Get Layouts Draft Setting
get
Save Layouts Draft Setting
put
Get Theme Setting
get
Get Theme Draft Setting
get
Save Theme Setting
put
Get Products Setting
get
Get Payments Setting
get
Get Shop Setting
get
Get Product Review Setting
get
Get Promotions Setting
get
Get Pos Setting
get
Get domains Setting
get
Publish Layouts Setting
post
Publish Theme Setting
post
Taxes
Get Taxes
get
Tokens
Get Token Info
get
UserCoupons
Get User Coupons
get
Create User Coupon
post
Get User Coupons With Cursor
get
Redeem User Coupon
post
Claim User Coupon
post
Store Credits
Get Store Credits
get
Bulk Update Store Credits
post
Warehouses
Get Warehouses
get
Update Stock
put
Get Product Stocks
get
Webhooks
Get Webhooks
get
Create Webhook
post
Get Webhook
get
Update Webhook
put
Delete Webhook
delete
Wish List Items
Get wish list items
get
Create Wish List Item
post
Delete Wish List Item
delete
Channels
Get Channels
get
Get Channel
get
Get Product Channel Price
get
Create Product Channel Price
post
Update Product Channel Price
put
Member Point Rules
Get Member Point Rules
get
Cart Item Metafields
Get metafields attached to cart items of specific cart
get
Bulk create metafield
post
bulk update metafield
put
bulk delete metafield
delete
Multipass Linking
Update multipass linking for customer
post
Delete multipass linking for customer
delete
Get active multipass linkings
get
Multipass Secret
Create Multipass Secret
post
Get Multipass Secret
get
Staffs
Get staff permissions
get
Get all staff
get
Get staff
get
Powered by
private