Product Category - Zid Docs

ProductCategory

integer

optional

Unique identifier for the category

Example:

875210

name

string

optional

Name of the category

Example:

Sport Shoes

slug

string

optional

URL-friendly version of the category name

Example:

sport-shoes

SEO_category_title

string

optional

SEO optimized title for the category

Example:

Sport Shoes - Run with Comfort

SEO_category_description

string

optional

SEO optimized description for the category

Example:

Our selection of sport shoes offers the best in comfort and performance for your athletic needs.

names

object

optional

Category names in different languages

string

optional

Example:

Sport Shoes

string

optional

Example:

أحذية رياضية

description

object

optional

Category descriptions in different languages

string

optional

Example:

Featuring a range of sport shoes for every sport from running to football.

string

optional

Example:

مجموعة متنوعة من الأحذية الرياضية لكل الرياضات من الجري إلى كرة القدم.

url

string

optional

URL of the category on the web store

Example:

https://example.zid.store/categories/875210/sport-shoes

image

string

optional

URL of the category's image (thumbnail size)

Example:

https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0-260x260.png

image_full_size

string

optional

URL of the category's image (full size)

Example:

https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0.png

img_alt_text

string

optional

Alternative text for the image for accessibility and SEO

Example:

Sport shoes collection

cover_image

string

optional

URL of the category's cover image

Example:

https://media.zid.store/example-store/94b62e84-4ee3-4bfb-9833-6de53e2b8e1a.png

image_full

string

optional

Full sized category image

Example:

https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0.png

products_count

integer

optional

Number of products under the category

Example:

120

sub_categories

array[object (ProductCategory) {18}]

optional

List of sub-categories under this category. Empty if no sub-categories exist.

integer

optional

Unique identifier for the category

Example:

875210

name

string

optional

Name of the category

Example:

Sport Shoes

slug

string

optional

URL-friendly version of the category name

Example:

sport-shoes

SEO_category_title

string

optional

SEO optimized title for the category

Example:

Sport Shoes - Run with Comfort

SEO_category_description

string

optional

SEO optimized description for the category

Example:

Our selection of sport shoes offers the best in comfort and performance for your athletic needs.

names

object

optional

Category names in different languages

description

object

optional

Category descriptions in different languages

url

string

optional

URL of the category on the web store

Example:

https://example.zid.store/categories/875210/sport-shoes

image

string

optional

URL of the category's image (thumbnail size)

Example:

https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0-260x260.png

image_full_size

string

optional

URL of the category's image (full size)

Example:

https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0.png

img_alt_text

string

optional

Alternative text for the image for accessibility and SEO

Example:

Sport shoes collection

cover_image

string

optional

URL of the category's cover image

Example:

https://media.zid.store/example-store/94b62e84-4ee3-4bfb-9833-6de53e2b8e1a.png

image_full

string

optional

Full sized category image

Example:

https://media.zid.store/example-store/75decdde-4e94-45fe-8eb1-1edf4ead3ff0.png

products_count

integer

optional

Number of products under the category

Example:

120

sub_categories

array[object (ProductCategory) {18}]

optional

List of sub-categories under this category. Empty if no sub-categories exist.

parent_id

integer | null

optional

ID of the parent category. Null if this is a top-level category.

Example:

null

flat_name

string

optional

Flat representation of the category name

Example:

Sport Shoes

is_published

boolean

optional

Flag indicating if the category is currently published and visible on the store

Example:

true

parent_id

integer | null

optional

ID of the parent category. Null if this is a top-level category.

Example:

null

flat_name

string

optional

Flat representation of the category name

Example:

Sport Shoes

is_published

boolean

optional

Flag indicating if the category is currently published and visible on the store

Example:

true