Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Product
  • Overview
  • Languages
  • Notify
  • Event
  • Storage
  • Configuration
  • Forms
  • Helpers
  • Auth
    • Login
    • Logout
    • Verify
    • Resend
    • Register
    • Refresh
  • Cart
    • Latest
    • Details
    • Quick Add
    • Add Item
    • Delete Item
    • Delete Image
    • Add Coupon
    • Remove Coupon
    • Get Upload Image
    • Get Quick Order Settings
    • Create Quick Order
    • Order Status
    • Get Current Cart Id
    • Price Quote
  • Wishlist
    • Add
    • Remove
    • Toggle
  • Loyalty
    • Get Program
    • Exchange
    • Reset
  • Comment
    • Add Comment
    • Fetch
    • Get Page Comments
    • Get Product Comments
  • Profile
    • Update profile
    • Update contact
  • Product
    • Get price
    • Product availability
    • Categories
    • Offer details
    • Search products
    • Get Gift Details
    • Add Gift To Cart
    • Upload Gift Image
    • Get Product Details
    • Fetch
    • Fetch Options
    • Size Guides
  • Order
    • Create cart from order
    • Cancel
    • Send invoice
    • Show order
  • Booking
    • Add
  • Rating
    • Order
    • Store
    • Products
    • Shipping
  • Currency
    • Change
    • List
  • Component
    • Reviews
    • Menus
  1. Product

Categories

This endpoint lists all of the products within a given category. Categories aid in the organisation of products so that visitors may quickly find what they're looking for in the store.

Payload#

CategoriesPayload
id
number 
required
The category's Id.

Response#

Success
Error
product.categories.success
success
boolean 
success
required
Response flag
status
status
required
Allowed values:
200201202
data
object 
Category | array[Category]
optional
id
string 
optional
Category Id.
name
string 
optional
Category Title.
url
string 
optional
Url link of the category.
sub_categories
array [object] 
optional
Array of the category's sub-categories.
image
string 
optional
URL or file path to the image representing the category.

Usage#

To perform the action of retriving the categories for a product, the developer may call the method categories() as follows.
More about adding Categories as a component in this clip.

Events#

This endpoint may trigger two events, the onCategoriesFetched and onCategoriesFailed events.

onCategoriesFetched#

This event is triggered when retriving the categories for a product is done without having any errors coming back from the backend.

onCategoriesFailed#

This event is triggered when retriving the categories for a product is not completed and an error has occurred.
Previous
Product availability
Next
Offer details