Zid Docs
Merchant APIs
Theme Docs
Zid Docs
  • Start Here 🚀
  • Overview to Zid Apps
  • Create your First App
  • Authorization
  • Responses
  • Embedded Apps
  • Webhooks
  • App Scripts
  • Rate Limiting
  • APIs
    • Orders
    • Products
      • Managing Products
      • Digital Vouchers
      • Product Categories
        • Get Single Category DetailsGET
        • Get all categoriesGET
        • Create Store CategoryPOST
        • Update a Store CategoryPOST
        • Add a product to a certain categoryPOST
        • Publish/Unpublish a CategoryPUT
        • Detach Category from All ProductsDELETE
        • Remove Category from ProductDELETE
      • Product Badge
      • Product Attributes
      • Product Attribute Presets
      • Product Customizations
      • Product Manual Sorting
      • Product Images
      • Product Notifications
      • Product Import
      • Product Stock (Multi-Inventory)
      • Product Questions & Answers
      • Product Reviews
      • Digital Products
    • Inventories
    • Shipping
    • Marketing
    • Customers
    • Store Settings
    • Countries and Cities
    • Webhooks
    • App Scripts
  • Webhook Events
logoPowered by Apidog
  1. APIs
  2. Products
  3. Product Categories

Get all categories

GETv1/managers/store/categories

Fetches all the available categories for a certain store, including details such as their names, status, SEO information, and the number of products they contain. It supports returning both detailed and minimal category information depending on the request parameters.

Request

Header Params
Authorization
string 
required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y
X-Manager-Token
string 
required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:
eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=
Accept-Language
enum<string> 
optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:
enar
Example:
en

Request samples

Responses

List of categories(200)
List of categories
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
message
object 
optional

Contains messages or feedback about the API request, such as errors or success details.

type
string 
optional

The type of message returned (e.g., success, error).

Example:
success
status
string 
optional

The status of the categories (e.g., active, inactive).

Example:
active
categories
array [object {10}] 
optional

An array of category objects, each containing details about individual categories.

id
integer 
optional

The unique identifier of the category.

Example:
101
name
string 
optional

The name of the category.

Example:
Electronics
names
object 
optional

Contains localized versions of the category name.

flat_name
string 
optional

A simplified version of the category name, typically without special characters.

Example:
electronics
is_published
boolean 
optional

Indicates whether the category is published and visible to users.

Default:
true
SEO_category_title
string 
optional

The SEO-friendly title for the category, used for improving search engine ranking.

Example:
Best Electronics - Shop Online
SEO_category_description
string 
optional

The SEO-friendly description of the category, optimized for search engines.

Example:
Find the best electronic gadgets and accessories.
url
string 
optional

The full URL of the category's page.

Example:
https://example.com/categories/electronics
products_count
integer 
optional

The total number of products listed under this category.

Example:
150
slug
string 
optional

A URL-friendly version of the category name, often used in routing.

Example:
electronics
minimal_categories
array [object {3}] 
optional

An array of minimal category objects with only basic information.

id
integer 
optional

The unique identifier of the category in the minimal category list.

Example:
102
name
string 
optional

The name of the category in the minimal category list.

Example:
Home Appliances
is_published
boolean 
optional

Indicates if the category in the minimal category list is published.

Default:
true
products_count
integer 
optional

The total number of products listed under this minimal category.

Example:
75
Example
Not configured
Last modified: 2 months ago