Jump to Content
API Reference
v0.11
Log In
API Reference
Log In
v0.11
API Reference
Get Products
Search
JUMP TO
GetCandy
Root
Get root
get
Account
Reset password
post
Addresses
Create new address
post
Update existing address
put
/addresses/{addressId}
delete
Assets
Update Assets
put
Create Asset
post
Simple asset upload
post
Detach an asset from it's model
post
Associations
Paginated array of association groups
get
Attributes
Get Attributes
get
Create Attribute
post
Update request to reorder attributes
put
Get an attribute
get
Update an attribute
put
Delete an attribute
delete
Paginated list of Attribute Groups
get
Create an Attribute Group
post
Reorder attribute groups
put
Update an attribute group
put
Get a single attribute group
get
Delete an attribute group
delete
Baskets
Get baskets
get
Create Basket
post
Add meta information
post
Resolve a basket
post
Get the current basket for a user
get
Save a basket for a user
post
Allow a user to claim a basket
post
Delete a basket by ID
delete
Get basket
get
Update a basket by ID
put
Get a users saved baskets
get
Update a saved basket
put
Remove discount
delete
Create basket lines
post
Delete basket lines
delete
Update basket line
put
Update basket line quantity
put
Remove basket line quantity
put
Categories
Get Categories
get
Return a single category
get
Update a category
put
Update a category layout
post
Update a category's routes
post
Get categories by parent id
get
Reorder a category
post
Attach products
put
Attach channels to a category
post
Create or retrieve the current category draft
post
Attach customer groups to a category
post
Channels
Get all channels
get
Create a new channel
post
Get the channel resource
get
Update the channel resource
put
Delete the channel resource
delete
Collections
Update a collection's routes
post
Update a collection's products
post
Get Collections
get
Create Collection
post
Single Collection
get
Update Collection
put
Delete Collection
delete
Countries
Get all countries
get
Get the country resource
get
Update the country resource
put
Customer Groups
Get all customer groups
get
Create a new customer group
post
Get a single customer group
get
Update the customer group resource
put
Delete the customer group resource
delete
Customers
Get all customers
get
Create a new customer
post
Get custom customer fields
get
Attach a user to a customer record
post
Attach customer groups to a customer
put
Get the customer resource
get
Update the customer resource
put
Delete the customer resource
delete
Get custom user fields
get
Discounts
Get Discounts
get
Create Discount
post
Get a Discount
get
Update Discount
put
Delete Discount
delete
Languages
Get Languages
get
Create Language
post
Get Language
get
Update Language
put
Delete Language
delete
Layouts
Get Layouts
get
Orders
Get orders
get
Create Order
post
Get Order
get
Update Order
put
Get order types
get
Processes an order on the API
post
Get order status preview email
get
Bulk update orders
post
Get Order export
get
Expire an Order
post
Update shipping address
put
Get Order Shipping Methods
get
Add shipping cost
put
Add contact details
put
Update billing address
put
Add order line
put
Delete an order line
delete
Get order invoice
get
Payments
Refund a payment
post
Void a payment
post
Threed Secure Payment
post
Get Payment Provider
get
Payment types
get
Product Families
Get product families
get
Create product family
post
Get a product family
get
Update product family
put
Delete product family
delete
Products
Get Products
get
Create Product
post
Get recommended products
get
Get Product
get
Update Product
put
Delete Product
delete
Duplicate Product
post
Create Product route
post
Create Product redirect
post
Update Product attributes
post
Update Product collections
post
Update Product categories
post
Update Product channels
post
Detach category
delete
Detach collection
delete
Update product associations
post
/products/{productId}/associations
delete
Update customer groups
post
Detach customer groups
delete
Create Draft
post
Create draft
get
Publish Draft
post
Product Variants
Get Product Variants
get
Get Product Variant
get
Update ProductVariant Inventory
put
Recycle Bin
Get records
get
Get item
get
Delete item
delete
Reports
Get sales report
get
Get sales report
get
Get Customer Report
get
Get order averages
get
Get best selling products
get
Get metric data
get
Routes
Get Routes
get
Get Route
get
Update Route
put
Delete Route
delete
Search for Route
get
Search
Search GetCandy
get
Get saved searches
get
Get saved search
get
Delete saved search
delete
Settings
Get settings
get
Get setting
get
Shipping
Get shipping methods
get
Create shipping method
post
Get shipping methods
get
Update shipping method
put
Delete shipping method
delete
Get Shipping Zones
get
Create Shipping Zone
post
Get Shipping Zone
get
Add shipping price
post
Update shipping price
put
Update shipping method zones
put
Update shipping method users
put
Tags
Get all tags
get
/tags
post
Get a tag
get
Update a tag
put
Delete a tag
delete
Taxes
Get taxes
get
Create tax
post
Get tax record
get
Update tax record
put
Delete tax record
delete
Users
Get all users
get
Create a new user
post
Get user
get
/users/{userId}
put
/users/{userId}
delete
Get the current user
get
Versioning
Restore model
post
Powered by
Get Products
get
http://localhost:8000/api/v1/products
Gets a paginated list of products.
Language
Shell
Node
PHP
JavaScript
Python
RESPONSE
Click
Try It!
to start a request and see the response here!