List Product Categories

The unique ID assigned to each product category which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every product category. This ULID is automatically created by our system and is used to uniquely identify and track each product category in our database.

The attribute is like a title that succinctly captures the essence of what the category represents. For example, if you have a category for sports shoes, the name could be something straightforward like "Sports Shoes." This attribute is crucial because it's the first thing customers and staff see. It should be clear, concise, and reflective of the contents of the category. A well-chosen name helps users quickly understand what types of products they can expect to find under this category, enhancing their browsing and shopping experience. Please notice that duplicate values are not allowed.

This value indicates whether the product category is active or not. This flag can be used to control the product category's availability in runtime environments or listings without deleting or removing the product category from records. A true value means the product category is active and functioning, while a false value implies that the product category is deactivated or not in use.

It's a unique identifier assigned to each product category. It's primary role is to distinguish one product category from another, ensuring that each product category can be individually tracked and managed without any confusion. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id value is used to Identify Resource when you consume any product category endpoint with sending identify_by query parameter with value reference_id.

This attribute is a URL-friendly version of the category name. It's used in the web address to help users and search engines find the category page easily. For instance, if you have a category named "Sports Shoes" the slug might be "sports-shoes". It's a simplified version of the name and without spaces. Slugs are important for website navigation and SEO . A well-crafted slug makes it easier for customers to remember and type the URL, and it helps improve the category's visibility in search engine results. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. If the slug value is not provided, the Payiano system automatically generates one based on the provided name attribute. This auto-generation of the slug ensures consistency and convenience, eliminating the need for manual slug entry.

This attribute establishes a hierarchical relationship between categories. It's used to show that one category is a subcategory of another. For example, if you have a main category called "Footwear" and a subcategory called "Sports Shoes" the "Sports Shoes" category would have "Footwear" as its parent category. The parent_category_id attribute would be the unique identifier of the "Footwear" category. This attribute is crucial for organizing categories in a structured and logical manner. It helps users navigate through different levels of categories smoothly, making it easier to browse products and understand their classification.

This attribute provides more detailed information about the product category. It's like a brief paragraph that explains what the category is about and what it includes. This attribute is important because it gives context and depth to the category name, offering users a clearer understanding of what's included and potentially the types of customers the category is aimed at. A good description can also help in search optimization, making it easier for customers to find what they're looking for through search engines.

This value indicates whether the product category is deleted or not. This flag can be used to control the product category's availability in runtime without actual deleting or removing the product category from records. A true value means the product category is deleted, while a false value implies that the product category is not deleted and functioning.

This attribute represents the total number of products that directly fall under a specific product category. This is a numerical value that provides immediate insight into the size and scope of each category.

This attribute is a numerical value that represents the total number of direct child categories contained within a specific parent product category. Essentially, it acts as a counter for the subcategories under a given category.

The attribute is a reference to the category that a given category falls under in the hierarchy of product categorization. It's essentially a link to the 'parent' category of which the current category is a subcategory.

The product category metadata model details. Metadata serves as a tool for keeping extra, organized details about a resource. For example, you can use it to store a user's preferences like prefered color, notes or any other data that aids in personalizing services, improving customer relations, or optimizing internal workflows. This information isn't utilized by Payiano – meaning it's not involved in authorizing or declining transactions and remains invisible to your users. Its value is entirely private for your internal use, and we ensure it remains confidential, not shared with any external parties.

The created datetime of the product category. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

The updated datetime of the product category. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.